Proximity Webservice

Get minimal proximity state list

Get basic state information about all proximity tags in organization

post/api/proximity/getMinimalProximityStateList

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/proximity/getMinimalProximityStateList
  • 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

ProximityGetMinimalProximityStatesWSRequest required

Request object for getting basic state information about all proximity tags in the organization.

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

{
  "proximityStates": [
    {
      "batteryPercent": 75,
      "createdAtMillis": 1640995200000,
      "firmwareVersion": "1.2.3",
      "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"
    }
  ]
}

Changes

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