Access Control Components

Retrieve all component shadows for the components belonging to the specified component composites

Retrieve all component shadows for the components belonging to the specified component composites (doors, elevators, elevator landings). Each composite is expanded to its component references and the resulting set of component shadows is returned.

POST/api/component/findComponentShadowsByComponentComposites

Authorizations

x-auth-apikeystringheaderrequired

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Authorizationstringheader

Instead of an API key, an OAuth access token: Bearer <token>, with the read scope.

OAuth explains tokens and scopes.

Headers

x-auth-schemeenum<string>headerdefault: api-token

Authentication scheme identifier. Use api-token or partner-api-token with the x-auth-apikey header, api or partner-api with x-auth-apikey plus a client certificate, api-oauth-token or partner-api-oauth-token with x-auth-access-token, and federated-token with x-auth-ft. A request with Authorization: Bearer <token> and no x-auth-scheme is treated as OAuth, and federated-token may also be sent as the x-auth-scheme and x-auth-ft query parameters.

Available options: api-token, api, api-oauth-token, federated-token, partner-api-token, partner-api, partner-api-oauth-token

x-auth-orgstring<RUUID>header

Client organization UUID (22-character RUUID), for partner credentials only. With it the call runs in that client organization with the partner support authority's role. Without it a partner credential runs as the partner organization, which outside the partner endpoints is deprecated (responses carry Deprecation and Sunset: Tue, 05 Jan 2027 00:00:00 GMT). A malformed value returns 400 INVALID_AUTH_ORG; a client organization the partner cannot access returns 403 PARTNER_CLIENT_ACCESS_DENIED.

Length: 22 to 22

Body

application/json · object

componentCompositeUuidsstring<RUUID>[] | nullbody

bash

curl --request POST \
  --url 'https://api2.rhombussystems.com/api/component/findComponentShadowsByComponentComposites' \
  --header 'x-auth-scheme: api-token' \
  --header 'x-auth-apikey: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "componentCompositeUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }'

import requests

url = "https://api2.rhombussystems.com/api/component/findComponentShadowsByComponentComposites"
headers = {
    "x-auth-scheme": "api-token",
    "x-auth-apikey": "YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "componentCompositeUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
    ]
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
print(response.json())

const response = await fetch('https://api2.rhombussystems.com/api/component/findComponentShadowsByComponentComposites', {
  method: 'POST',
  headers: {
    'x-auth-scheme': 'api-token',
    'x-auth-apikey': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "componentCompositeUuids": [
      "AAAAAAAAAAAAAAAAAAAAAA"
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);

console.log(await response.json());

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Example {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "componentCompositeUuids": [
                "AAAAAAAAAAAAAAAAAAAAAA"
              ]
            }
            """;
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api2.rhombussystems.com/api/component/findComponentShadowsByComponentComposites"))
            .header("x-auth-scheme", "api-token")
            .header("x-auth-apikey", "YOUR_API_KEY")
            .header("Content-Type", "application/json")
            .method("POST", HttpRequest.BodyPublishers.ofString(body))
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.statusCode() + " " + response.body());
    }
}

json

{
  "componentShadowMap": {
    "<key>": {
      "componentUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "createdAtMillis": 0,
      "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "ownerDeviceUuid": "AAAAAAAAAAAAAAAAAAAAAA",
      "type": "DoorReaderShadow",
      "updatedAtMillis": 0,
      "state": "CONNECTED",
      "stateUpdateEventTimestampMs": 0
    }
  }
}

Response

200 OK

application/json · object

componentShadowMapobject | null

Show child attributes

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

Available options: DoorReaderShadow, DoorRelayShadow, DoorPositionIndicatorShadow, RequestToExitShadow, GenericRelayShadow, GenericInputShadow, GenericButtonShadow, AperioGatewayShadow, AperioDoorExtensionShadow, SchlageGatewayShadow, SchlageDoorExtensionShadow

updatedAtMillisinteger<int64> | null

One of:

Show Door Reader Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: CONNECTED, DISCONNECTED, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

Show Door Relay Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: UNLOCKED, LOCKED, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

Show Door Position Indicator Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: OPEN, CLOSED, AJAR, FORCED_OPEN, ERROR, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

supervisionStateenum<string>

Available options: CUT_DETECTED, SHORT_DETECTED, NORMAL, INVALID, UNKNOWN

Show Request To Exit Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

supervisionStateenum<string>

Available options: CUT_DETECTED, SHORT_DETECTED, NORMAL, INVALID, UNKNOWN

Show Generic Input Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

supervisionStateenum<string>

Available options: CUT_DETECTED, SHORT_DETECTED, NORMAL, INVALID, UNKNOWN

Show Integrated Door Relay Type variant

baseTypeenum<string>

Available options: reader, dpi, relay, rex, aux, aperio, schlage, button

createdAtMillisinteger<int64> | null

namestring | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerHardwareTypeenum<string>

Available options: RASPBERRY_PI_3, CAMERA_R1, CAMERA_R2, CAMERA_R2_LONG_RANGE, CAMERA_R2_180, CAMERA_R3, CAMERA_R4, CAMERA_R100, CAMERA_R120, CAMERA_R170, CAMERA_R200, CAMERA_R500, CAMERA_R510, CAMERA_R520, CAMERA_R600, SENSOR_ASSET_TAG_T1, SENSOR_DOOR_D1, SENSOR_DOOR_D20, SENSOR_ENVIRONMENTAL_E1, SENSOR_ENVIRONMENTAL_E15, SENSOR_ENVIRONMENTAL_E2, SENSOR_MOTION_M1, SENSOR_MOTION_M15, GATEWAY_A1, GATEWAY_A100, GATEWAY_ENVIRONMENTAL_E50, CAMERA_R220, CAMERA_R230, CAMERA_R36S, CAMERA_R410, CAMERA_R540, CAMERA_R545, BADGE_READER_DR1, BADGE_READER_DR40, BADGE_READER_DR20, DOOR_CONTROLLER_DC1, DOOR_CONTROLLER_DC20, DOOR_CONTROLLER_DC10, ETHERNET_TESTER_ET1, IO_BOARD_TB1, BLE_BUTTON_B10, BLE_BUTTON_B15, CAMERA_THIRD_PARTY_RELAY, CAMERA_THIRD_PARTY_NVR, CAMERA_THIRD_PARTY_NVR_MULTISENSOR, NVR_N100, CAMERA_R130, NVR_N500, CAMERA_R150, ROBOT_RC1, CAMERA_R210, CAMERA_R650, NVR_N550, NVR_N551, ROBOT_RC2, UNSPECIFIED

portobject

Show child attributes

boardNuminteger<int32> | null

portNuminteger<int32> | null

portTypeenum<string>

Available options: GPIO_OUTPUT

portImmutableboolean | null

rateLimitingEnabledboolean | null

relayTypeenum<string>

Available options: integrated, remote

typeenum<string>

Available options: RhombusOsdpDoorReader, OsdpDoorReader, WiegandDoorReader, IntegratedDoorPositionIndicator, IntegratedRequestToExit, IntegratedDoorRelay, IntegratedGenericRelay, IntegratedGenericInput, IntegratedGenericButton, SchlageInputButton, AperioActivatorButton, AperioGateway, AperioRs485Gateway, AperioDoorExtension, AperioDoorRelay, AperioDoorPositionIndicator, AperioDoorReader, AperioRs485DoorReader, AperioRs485DoorRelay, AperioRs485DoorPositionIndicator, AperioRs485DoorRequestToExit, AperioRs485DoorExtension, AperioDoorRequestToExit, SchlageRs485Gateway, SchlageRs485DoorExtension, SchlageRs485DoorRelay, SchlageRs485DoorPositionIndicator, SchlageRs485DoorReader, SchlageRs485DoorRequestToExit

updatedAtMillisinteger<int64> | null

uuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Generic Relay Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

originatorobject

Show child attributes

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

One of:

Show Support Authority variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

grantedToInternalEntityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

grantedToNamestring | null

supportAuthorityUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

supportUserEmailstring | null

supportUsernamestring | null

Show Api Token variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

tokenNamestring | null

tokenUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show User variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

userEmailstring | null

userUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

usernamestring | null

Show Rule variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

ruleNamestring | null

ruleUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Component Composite variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

componentCompositeNamestring | null

componentCompositeUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

correlationIdstring | null

eventUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

originatorobject

Show Guest Pass variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

guestPassNamestring | null

guestPassUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

Show Device Service variant

auditPrincipalstring | null

typeenum<string>

Available options: USER, SUPPORT_AUTHORITY, API_TOKEN, RULE, COMPONENT_COMPOSITE_EVENT, GUEST_PASS, DEVICE_SERVICE, UNKNOWN

deviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

serviceNamestring | null

stateenum<string>

Available options: ACTIVE, INACTIVE, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

Show Generic Button Shadow Type variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

stateenum<string>

Available options: BUTTON_DOWN, BUTTON_UP, UNKNOWN

stateUpdateEventTimestampMsinteger<int64> | null

supervisionStateenum<string>

Available options: CUT_DETECTED, SHORT_DETECTED, NORMAL, INVALID, UNKNOWN

Show Aperio Gateway Shadow variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

aperioIdstring<byte>[] | null

connectedboolean | null

connectionStateUpdatedAtMsinteger<int64> | null

deviceClockSecinteger<int64> | null

deviceTimezoneinteger<int32> | null

dtcsobject[] | null

Show child attributes

codestring<byte>[] | null

failingboolean | null

hasFailedboolean | null

testCompletedboolean | null

timeinteger<int64> | null

firmwareVersionstring | null

hwVersionstring<byte>[] | null

ipAddressstring | null

lastSeenMsinteger<int64> | null

oemCodestring | null

oemCodeFetchedAtMsinteger<int64> | null

protocolVersionMajorinteger<int32> | null

protocolVersionMinorinteger<int32> | null

protocolVersionPatchinteger<int32> | null

rawTamperStateinteger<int32> | null

stateUpdatedAtMsinteger<int64> | null

transportenum<string>

Available options: IP, RS485

Show Aperio Door Extension Shadow variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

activatorStateinteger<int32> | null

activatorStateUpdatedAtMsinteger<int64> | null

aperioDoorDeviceIdstring<byte>[] | null

aperioGatewayIdstring<byte>[] | null

aperioIdstring | null

batteryStateenum<string>

Available options: UNKNOWN, FLAT, LOW, OK

clockRetrievedAtMsinteger<int64> | null

connectedboolean | null

connectionStateUpdatedAtMsinteger<int64> | null

deviceClockSecinteger<int64> | null

deviceTimezoneinteger<int32> | null

doorModeinteger<int32> | null

doorModeUpdatedAtMsinteger<int64> | null

dtcsobject[] | null

Show child attributes

codestring<byte>[] | null

failingboolean | null

hasFailedboolean | null

testCompletedboolean | null

timeinteger<int64> | null

dtcsUpdatedAtMsinteger<int64> | null

gatewayComponentIdstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

handleStateinteger<int32> | null

handleStateUpdatedAtMsinteger<int64> | null

keyCylinderStateinteger<int32> | null

keyCylinderStateUpdatedAtMsinteger<int64> | null

lastSeenMsinteger<int64> | null

namestring | null

removedboolean | null

stateUpdatedAtMsinteger<int64> | null

tamperStateinteger<int32> | null

tamperStateUpdatedAtMsinteger<int64> | null

Show Schlage Gateway Shadow variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

appConnectedboolean | null

appConnectedUpdatedAtMsinteger<int64> | null

connectedboolean | null

connectionStateUpdatedAtMsinteger<int64> | null

firmwareVersionstring | null

hwVersionstring | null

lastSeenMsinteger<int64> | null

modelstring | null

rawTamperStateinteger<int32> | null

serialstring | null

stateUpdatedAtMsinteger<int64> | null

tamperboolean | null

tamperUpdatedAtMsinteger<int64> | null

transportenum<string>

Available options: IP, RS485

Show Schlage Door Extension Shadow variant

componentUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

createdAtMillisinteger<int64> | null

orgUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

ownerDeviceUuidstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

typeenum<string>

updatedAtMillisinteger<int64> | null

apmConfigstring<byte>[] | null

apmConfigUpdatedAtMsinteger<int64> | null

batteryMillivoltsinteger<int32> | null

batteryStateenum<string>

Available options: UNKNOWN, OK, LOW, CRITICAL

batteryStateUpdatedAtMsinteger<int64> | null

connectedboolean | null

connectionStateUpdatedAtMsinteger<int64> | null

doorModeinteger<int32> | null

doorModeUpdatedAtMsinteger<int64> | null

firmwareVersionstring | null

gatewayComponentIdstring<RUUID> | null

base 64 (url-safe) uuid string

Example: "AAAAAAAAAAAAAAAAAAAAAA"

interpretedDoorModeenum<string>

Available options: UNKNOWN, ACCESS_CONTROLLED, UNLOCKED_HELD, SECURED, PRIVACY

keyOverrideStateinteger<int32> | null

keyOverrideStateUpdatedAtMsinteger<int64> | null

lastSeenMsinteger<int64> | null

lithiumMillivoltsinteger<int32> | null

namestring | null

productTypeinteger<int32> | null

serialstring | null

stateUpdatedAtMsinteger<int64> | null

tamperStateenum<string>

Available options: UNKNOWN, NONE, READER, APM, GATEWAY, MAGNETIC

tamperStateUpdatedAtMsinteger<int64> | null

Errors

Like every operation, this one can also answer with the standard error body (errorCode, errorMsg). Errors explains each status and how to retry.

400 Bad Request. errorCode is one of: BAD_REQUEST, VALIDATION_FAILED, MISSING_REQUIRED_FIELD, INVALID_JSON, INVALID_REQUEST_BODY, FEATURE_NOT_ENABLED, INVALID_AUTH_ORG, LOCATION_NOT_FOUND.
401 Unauthorized. errorCode is one of: UNAUTHENTICATED, INVALID_CREDENTIAL, CREDENTIAL_EXPIRED, CREDENTIAL_REVOKED, CERTIFICATE_MISMATCH.
403 Forbidden. errorCode is one of: FORBIDDEN, DOMAIN_NOT_ALLOWED, DEVICE_SCOPE_MISMATCH, ROLE_NOT_PERMITTED, FUNCTIONALITY_REQUIRED, PARTNER_FUNCTIONALITY_REQUIRED, PERMISSION_REQUIRED, PARTNER_CLIENT_ACCESS_DENIED, HARDWARE_NOT_AVAILABLE, HARDWARE_ALREADY_REGISTERED, PARTNER_PORTAL_NOT_ENABLED, MANAGED_BY_MSP, SUPER_ADMIN_RESTRICTED_BY_MSP, MSP_DESIGNATION_INVALID, NOT_MANAGED_CLIENT.
429 Too Many Requests. errorCode is one of: RATE_LIMITED.
500 Internal Server Error. errorCode is one of: INTERNAL_ERROR.
503 Service Unavailable. errorCode is one of: SERVICE_UNAVAILABLE.