Skip to main content
POST
/
api
/
location
/
getLocation
Get location
curl --request POST \
  --url https://api2.rhombussystems.com/api/location/getLocation \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsRequired": false
}
'
{
  "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>",
    "qualifiedAddress": {
      "addressLine2": "<string>",
      "addressline1": "<string>",
      "administrativeArea": "<string>",
      "locality": "<string>",
      "postalCode": "<string>",
      "regionCode": "<string>"
    },
    "subLocations": "<array>",
    "tz": "<string>",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request object for getting location by ID.

locationUuid
string<RUUID> | null
required

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

subLocationsRequired
boolean | null

Whether sub-locations are required in the response

Example:

false

Response

200 - application/json

OK

Response object containing location information.

error
boolean | null
errorMsg
string | null
location
object

Location information to update

warningMsg
string | null