Get minimal proximity state list

Get basic state information about all proximity tags in organization

POST /api/proximity/getMinimalProximityStateList

Get minimal proximity state list

cURL

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

200

{
  "error": true,
  "errorMsg": "<string>",
  "proximityStates": [
    {
      "batteryPercent": 75,
      "createdAtMillis": 1640995200000,
      "firmwareVersion": "1.2.3",
      "gpsLocation": {
        "error": {
          "majorAxis": 123,
          "minorAxis": 123,
          "rotation": 123
        },
        "floor": 123,
        "lat": 123,
        "lon": 123
      },
      "imageUrl": "https://example.com/badge-image.jpg",
      "lastSeenSec": 1640995200,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "name": "Employee Badge 001",
      "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "serialNumber": "PROX-001-ABC123",
      "signalStrength": 85,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
      "tagUuid": "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 basic state information about all proximity tags in the organization.

Response

200 - application/json

OK

Response object containing basic state information about all proximity tags in the organization.

error · boolean | null

errorMsg · string | null

proximityStates · object[] | null

List of minimal proximity state information for all tags in the organization

Show child attributes

warningMsg · string | null