Partner Webservice

Get client status map

Get a map of all client accounts to device and location info

post/api/partner/getClientStatusMap

Request

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

PartnerGetPartnerClientsStatusMapWSRequest required

Request object for getting partner clients status map.

Response

OK

clientDeviceStatusMapobject nullable

Map of client UUIDs to device type connection counts

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

Changes

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