Get Envoy locations

Get list of Envoy locations

POST /api/report/getEnvoyLocations

Get Envoy locations

cURL

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

200

{
  "authError": true,
  "error": true,
  "errorMsg": "<string>",
  "locationList": [
    {
      "id": 123,
      "name": "<string>"
    }
  ],
  "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

The body is of type object.

Response

200 - application/json

OK

authError · boolean | null

error · boolean | null

errorMsg · string | null

locationList · object[] | null

Show child attributes

warningMsg · string | null