Get locations by geo

Get list of locations given latitude and longitude

POST /api/location/getLocationsByGeo

Get locations by geo

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/location/getLocationsByGeo \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "latitude": 37.7749,
  "longitude": -122.4194
}
'

200

{
  "locations": [
    {
      "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"
    }
  ]
}

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 list of locations given latitude and longitude.

latitude · number<double> | null

Latitude coordinate

Example:

37.7749

longitude · number<double> | null

Longitude coordinate

Example:

-122.4194

Response

200 - application/json

OK

Response object containing list of locations given latitude and longitude.

locations · object[] | null

Collection of locations found at the specified coordinates

Show child attributes