Field Squared API Services

<back to all web services

Geocode

Represents a DTO for a geocode request/response in a workspace. Usage is as follows
/Geocode?street=1514 Blake St&city=Denver&state=CO&zip=80209

The following routes are available for this service:
GET/{Workspace}/Geocode

export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class Address
{
    public Street: string;
    public Unit: string;
    public City: string;
    public State: string;
    public Zip: string;
    public ContactTitle: string;
    public ContactName: string;
    public ContactPhone: string;
    public ContactEmail: string;
    public Location: Location;
    public SiteName: string;
    public GeocodeFailed: boolean;
    public Country: string;

    public constructor(init?: Partial<Address>) { (Object as any).assign(this, init); }
}

/** @description Represents a DTO for a geocode request/response in a workspace.  Usage is as follows  /Geocode?street=1514 Blake St&city=Denver&state=CO&zip=80209 */
export class Geocode
{
    public Workspace: string;
    public Addresses: Address[];

    public constructor(init?: Partial<Geocode>) { (Object as any).assign(this, init); }
}

TypeScript Geocode DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/Geocode HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv