The following is an example of a Location called Campaign HQ.
{
"locationId": 272,
"name": "Campaign HQ",
"displayName": "Campaign HQ, 48 Grove St Somerville, MA 02144-2500",
"address": {
"addressLine1": "48 Grove St",
"addressLine2": null,
"addressLine3": null,
"city": "Somerville",
"stateOrProvince": "MA",
"zipOrPostalCode": "02144",
"geoLocation": {
"lon": -71.120121,
"lat": 42.396363
},
"countryCode": "US",
"preview": "48 Grove St \r\nSomerville, MA 02144-2500"
}
}
Property | Type | Description |
---|
locationId | int | Read-only; Unique identifier for a Location in this context |
name | string | A name for this Location, no longer than 50 characters |
displayName | string | Read-only; A display name for this Location that is the combination of the name and address.preview properties |
address | object | Optional; an Address object for this Location |
Property | Type | Description |
---|
addressLine1 | string | Optional; First line of a Street Address |
addressLine2 | string | Optional; Second line of a Street Address |
addressLine3 | string | Optional; Third line of a Street Address |
city | string | Optional; City or Town |
stateOrProvince | string | Optional; Two or three character State or Province code (e.g., MN, ON, NSW, etc.) |
zipOrPostalCode | string | Optional; ZIP, ZIP+4, Postal Code, Post code, etc. |
geoLocation | object | Optional and Read-only; a Geographic Coordinate object for this Address (VAN will attempt to populate this for you) |
countryCode | string | Optional; A two character ISO country code that is supported by your VAN context (e.g., US) |
preview | string | Read-only; A multiple line preview of this Address which may contain Windows line breaks (\r\n ) |
Property | Type | Description |
---|
lon | float | Required; the longitude of this Coordinate that is between -180 and 180 (inclusive) |
lat | float | Required; the latitude of this Coordinate that is between -90 and 90 (inclusive) |