Section ID:
DOC-API-MODEL-schema-1kvbjenggb#overview
Location
End-user coordinates and associated location metadata.
Meaning and usage
Section ID: DOC-API-MODEL-schema-1kvbjenggb#meaning
See the definition above.
Usage profiles
Section ID: DOC-API-MODEL-schema-1kvbjenggb#fields
| Usage | Fields and validation |
|---|---|
| In responses | View fields |
In responses
Section ID: DOC-API-MODEL-schema-1kvbjenggb#response
API JSON uses JSON field names (camelCase).
| Field | Type | Presence | Meaning |
|---|---|---|---|
Section ID: DOC-API-MODEL-schema-1kvbjenggb#field-latitudeSection ID: DOC-API-MODEL-schema-1kvbjenggb#response-field-latitudelatitude | number (double) or string (NaN, Infinity, -Infinity) | Optional | Latitude of the location in decimal degrees. |
Section ID: DOC-API-MODEL-schema-1kvbjenggb#field-longitudeSection ID: DOC-API-MODEL-schema-1kvbjenggb#response-field-longitudelongitude | number (double) or string (NaN, Infinity, -Infinity) | Optional | Longitude of the location in decimal degrees. |
Section ID: DOC-API-MODEL-schema-1kvbjenggb#field-citySection ID: DOC-API-MODEL-schema-1kvbjenggb#response-field-citycity | string | Optional | City associated with the location; currently left empty because reverse geocoding is not implemented. |
Section ID: DOC-API-MODEL-schema-1kvbjenggb#field-timezoneSection ID: DOC-API-MODEL-schema-1kvbjenggb#response-field-timezonetimezone | string | Optional | IANA time zone associated with the location, derived from its coordinates server-side. |
Section ID: DOC-API-MODEL-schema-1kvbjenggb#field-updatedatSection ID: DOC-API-MODEL-schema-1kvbjenggb#response-field-updatedatupdatedAt | string (date-time) | Optional | Time this record was most recently updated. |
Where used
Section ID: DOC-API-MODEL-schema-1kvbjenggb#where-used
| Reference | Relationship |
|---|---|
| Get the caller's end-user profile | POST /api/v1/enduser/get |
| Update the caller's location | POST /api/v1/enduser/update-location |
Models containing this value
| Model | Relationship |
|---|---|
| EndUserState | Nested in model |
Download the public reference contract.
Document ID: DOC-API-MODEL-schema-1kvbjenggb