Partner Webservice

Get client summary info

Get information about a client

post/api/partner/getClientSummaryInfo

Request

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

clientOrgUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "clientOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

clientDeviceStatusMapobject nullable

Map of device types to their connection status 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
licenseV2Enabledboolean nullable

Whether license V2 is enabled for the client

locationCountinteger nullable

Number of locations for the client

manuallySendLicenseExpirationEmailEnabledboolean nullable

Whether manual license expiration email sending is enabled

recentPolicyAlertCountinteger nullable

Number of recent policy alerts

warningMsgstring nullable

Example response

{
  "accountOwner": {
    "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "rhombusUserUuid": "AAAAAAAAAAAAAAAAAAAAAA",
    "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
  },
  "licenseV2Enabled": true,
  "locationCount": 3,
  "recentPolicyAlertCount": 5
}

Changes

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