Location Info

Supported App Types: On-Prem and Cloud.

Description: Get location information by passing the location ID.

Path: /api/partners/v1/locations/:locationId

Method: GET

Query Params: partnerTenantId=<PARTNER_TENANT_ID>

Headers: X-API-KEY=<X-API-KEY>

Response Codes

404 – When location is not found.
403 – When the supplied partnerTenantId is not authorized to access the location.
200 – Success

Response Headers

CONTENT_TYPE: application/json

Sample JSON:

{
“location”: {
“locationId”: “location-d827508f”,
“name”: “Location Level 3”,
“inferredLocationTypes”: [
“FLOOR”
],
“parent”: {
“locationId”: “location-3e306fd1”,
“name”: “Location Level 2”,
“inferredLocationTypes”: [
“NETWORK”
],
“parent”: {
“locationId”: “location-d4a2b651”,
“name”: “Location Level 2”,
“inferredLocationTypes”: [
“CAMPUS”
],
“parent”: {
“locationId”: “location-da34853c”,
“name”: “Location Level 1”,
“inferredLocationTypes”: [
“MSE”
],
“parent”: {
“locationId”: “location-91cdc6dc”,
“name”: “Location Level Root”,
“inferredLocationTypes”: [
“ROOT”
]
}
}
}
}
},
“locationDetails”: {
“timeZone”: “Europe/London”,
“city”: “”,
“state”: “”,
“country”: “”,
“category”: “”,
“metadata”: [

],
“latitude”: 0.0,
“longitude”: 0.0
}
}