License Webservice

Get licenses

Get list of add-on licenses available in organization

post/api/license/getLicenses

Request

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

optionalDeviceTypeFilter'BLE_TRACKER' | 'CAMERA' | 'DOOR_SENSOR' | 'ENVIRONMENTAL_SENSOR' | 'OCCUPANCY_SENSOR' | 'AUDIO_GATEWAY' | 'EXECUTABLE' | 'BADGE_READER' | 'DOOR_CONTROLLER' | 'BLE_BUTTON' | 'IO_BOARD' | 'ENVIRONMENTAL_GATEWAY' | 'NVR' | 'ROBOT' | 'UNKNOWN'

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

{
  "licenses": [
    {
      "claimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "deviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerOrgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "priorClaimKeyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
    }
  ]
}

Changes

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