Name | Description | Type | Additional information |
---|---|---|---|
ID |
Gets or sets an optional ID that may be used by the server to help identify the address or location. |
integer |
None. |
Description |
A description of the location |
string |
None. |
Category |
A category that can be used to group the location |
string |
None. |
CategoryId |
A category that can be used to group the location |
string |
None. |
Name |
The name of the location |
string |
None. |
Latitude |
The latitude of the location |
decimal number |
None. |
Longitude |
the longitude of the location |
decimal number |
None. |
StreetNumber |
The street number for the location |
string |
None. |
OnStreet |
The name of the street that the location is on |
string |
None. |
AtStreet |
An intersecting street |
string |
None. |
City |
The city the location is in. |
string |
None. |
State |
State/Province |
string |
None. |
PostalCode |
postal/zip code |
string |
None. |
ItemType |
The type of location |
LocationItemType |
None. |
InternalType |
Gets or sets the internal location type, which is used to help distinguish recent locations that are based on predefined locations vs addresses. |
LocationItemType |
None. |
Unit |
Unit number (eg apartment number) |
string |
None. |
Comments |
Any comments/instructions associated with this location |
string |
None. |
IsGeocoded |
Whether the latitude and longitude are available for this location. This property was introduced during 1.8.0 and will default to "true" if not specified in order to maintain backwards compatibility. |
boolean |
None. |
Contact |
A contact associated with the location (may be null) |
Contact |
None. |
Country |
Gets or sets the location's country As of Oct 2019, this field isn't used when booking a trip, and is primarily used to capture more information from google addresses in order to display them properly. |
string |
None. |
StopCode |
The stop code of this location (if any) |
string |
None. |
ProcedureModifier | string |
None. |
|
TimeZoneId |
The time zone id of this location |
string |
None. |