Get locations by hierarchy key

Get nested locations by subLocationHierarchyKey

POST /api/location/getLocationsBySubLocationsHierarchyKey

Get locations by hierarchy key

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/location/getLocationsBySubLocationsHierarchyKey \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "location": {
    "address1": "<string>",
    "address2": "<string>",
    "countryCode": "<string>",
    "floorPlans": [
      {
        "eastEdge": 123,
        "floorLabel": "<string>",
        "floorNumber": 123,
        "imageUrl": "<string>",
        "mediaUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "northEdge": 123,
        "rotation": 123,
        "southEdge": 123,
        "westEdge": 123
      }
    ],
    "labels": [
      "<string>"
    ],
    "latitude": 123,
    "longitude": 123,
    "name": "<string>",
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "postalCode": "<string>",
    "subLocations": "<array>",
    "tz": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting nested locations by subLocationHierarchyKey.

subLocationsHierarchyKey · string<SubLocationsHierarchyKey> | null

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

Pattern: ^([A-Za-z0-9\-_]{22})([.][A-Za-z0-9\-_]{22})*$

Example:

"AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing nested locations by subLocationHierarchyKey.

error · boolean | null

errorMsg · string | null

location · object

Location information to update

Show child attributes

warningMsg · string | null