Button Webservice

Get minimal button state list

Get basic state information for all button sensors

post/api/button/getMinimalButtonStateList

Request

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

ButtonGetMinimalButtonStatesWSRequest required

Request to get minimal state information for all button sensors.

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

{
  "states": [
    {
      "associatedCameras": [
        "AAAAAAAAAAAAAAAAAAAAAA.v0"
      ],
      "batteryPercent": 85,
      "closestBaseStation": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 1640995200000,
      "firmwareVersion": "2.1.0",
      "floorNumber": 1,
      "lastSeenSec": 1640995200,
      "latitude": 37.7749,
      "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "longitude": -122.4194,
      "name": "Main Entrance Button",
      "sensorUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "serialNumber": "SN123456789",
      "signalStrength": -45,
      "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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