Location Webservice

Get locations by hierarchy key

Get nested locations by subLocationHierarchyKey

post/api/location/getLocationsBySubLocationsHierarchyKey

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/location/getLocationsBySubLocationsHierarchyKey
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' 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.

Request body

subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

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

Example request

{
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Example response

{
  "location": {
    "floorPlans": [
      {
        "mediaUuid": "AAAAAAAAAAAAAAAAAAAAAA"
      }
    ],
    "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.