Location
The Location resource encompasses the geographical details of an address associated with a contact. It includes information such as formatted address, country, state, city, town, postal code, latitude, and longitude. Additionally, the what3words resource, nested within Location, provides geocoding information using What3words, where What3words is enabled.
The location object
Attributes
- objectstring
Type of the location, always "Location".
- idstring
Unique identifier for the location.
- location_typeLocationType (string enum)
The type of location.
Show child attributes
- addressstring
Standard address location. Applies to Contact resources.
- collisionstring
Location of a collision. Applies to Incident resources.
- recovery_pickupstring
Location for recovery pickup. Applies to Vehicle resources when the vehicle is being recovered.
- recovery_dropoffstring
Location for recovery dropoff. Applies to Vehicle resources when the vehicle is being recovered.
- registered_addressstring
Registered address of a vehicle. Applies to Vehicle resources.
- subjectobject
The subject of the location, which can be a contact, incident or vehicle.
Show child attributes
- subject.typestring
Type of the subject, which can be
Contact,Incident, orVehicle. - subject.idstring
Unique identifier for the subject.
- formatted_addressstring or null
Formatted address.
- address_linestring or null
First line of the address.
- address_line2string or null
Second line of the address.
- countrystring or null
Country of the location.
- statestring or null
State of the location.
- citystring or null
City of the location.
- townstring or null
Town of the location.
- postal_codestring or null
Postal code of the location.
- latitudenumber or null
Latitude of the location.
- longitudenumber or null
Longitude of the location.
- what3wordsobject or null
What3Words information for the location.
Show child attributes
- what3words.countrystring or null
Country for What3Words.
- what3words.squareobject or null
Square information for What3Words.
Show child attributes
Southwest coordinates in the square.
Show child attributes
Longitude coordinate.
Latitude coordinate.
Northeast coordinates in the square.
Show child attributes
Longitude coordinate.
Latitude coordinate.
- what3words.nearestPlacestring or null
Nearest place for What3Words.
- what3words.coordinatesobject or null
Coordinates information for What3Words.
Show child attributes
Longitude coordinate.
Latitude coordinate.
- wordsstring or null
Words information for What3Words.
- mapstring or null
Map information for What3Words.
interface Location {
object: "Location";
id: string;
location_type: LocationType;
subject: LocationSubject;
formatted_address: string | null;
address_line: string | null;
address_line2: string | null;
country: string | null;
state: string | null;
city: string | null;
town: string | null;
postal_code: string | null;
latitude: number | null;
longitude: number | null;
what3words: W3w | null;
}