API Reference

Sections

Theme switcher

Device

Device

autoOperatorobject

Information about device autoOperator settings.

Show child attributes

claimedAtstring

The UTC date/time when device was claimed into the parent site.

connectivityobject

Information related to a device's bluetooth and/or wifi connectivity.

Show child attributes

dtmiModelobject

Information on the device's current model and its supported capabilities.

Show child attributes

firmwareobject

Information related to a device's firmware.

Show child attributes

idid

The ID of the device to query.

informationobject

Information related to a device's identity, type, and manufactured dates.

Show child attributes

lockobject

Information related to a device's locking and unlocking capabilities and behaviors.

Show child attributes

parentSiteobject

The ID of the site to which the device has been claimed.

Show child attributes

serialNumberstring

The serial number of the device.

timeobject

Information related to device time settings.

Show child attributes

userInterfaceSettingsobject

Information related to device user interface settings.

Show child attributes

Was this section helpful?

What made this section unhelpful for you?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 { "autoOperator": { "activeErrors": [ { "message": null, "priority": null } ], "actuatorAlternateAction": { "isEnabled": false, "timeoutInMinutes": null }, "actuatorTwo": { "isEnabled": false }, "autoReverse": { "isEnabled": false }, "calibrationResults": { "doorOneDetected": false, "doorTwoDetected": false }, "closingSwing": { "latchAngleInDegrees": null, "speed": { "doorOne": null, "doorTwo": null } }, "holdOpen": { "delayInSeconds": null }, "lockRelay": { "lockDelay": { "durationInSeconds": null, "isEnabled": false }, "preloadRelease": { "isEnabled": false } }, "openingSwing": { "backcheckAngleInDegrees": null, "backcheckSpeed": { "isHigh": false, "isLow": false }, "force": null, "speed": null }, "powerAssist": { "force": null, "isEnabled": false }, "powerBoost": { "angleInDegrees": null, "force": null, "isEnabled": false, "mode": { "isContinuous": false, "isNormal": false } }, "pushAndGo": { "isEnabled": false, "mode": { "isFootTraffic": false, "isNormal": false } }, "safetySensor": { "actionOnObstruction": { "willClose": false, "willPause": false, "willSlow": false }, "ignoreAngle": { "angleInDegrees": null, "isEnabled": false } } }, "claimedAt": null, "connectivity": { "ble": { "appVersion": null, "bootloaderVersion": null, "isEnabled": false, "secureElementVersion": null }, "wifi": { "activeNetwork": { "encryptionAlgorithm": { "isWPA2": false, "isWPA3": false }, "enterpriseUsername": null, "isEnterpriseAccessPoint": false, "signalStrength": null, "ssid": null }, "appVersion": null, "bootloaderVersion": null, "isEnabled": false, "localIpAddress": null, "macAddress": null, "receiveConnectionEvents": false } }, "dtmiModel": { "id": null, "supportedCapabilities": { "jsonDownloadUrl": null } }, "firmware": { "current": { "installedAt": null, "version": null }, "scheduledUpdate": { "downloadAt": null, "installAt": null } }, "id": null, "information": { "assemblyDate": { "finalProduct": null, "insideTrim": null, "outsideTrim": null }, "commissionDate": null, "daysInUse": null, "deviceType": { "isAutomaticOperator": false, "isManualDeadboltLock": false, "isManualInterconnectLock": false, "isMortiseLock": false, "isTubularLock": false, "isWideExitTrimLock": false }, "displayName": null, "model": null, "revision": null, "serialNumber": null }, "lock": { "autoRelockDelayInSeconds": { "extendedUnlock": null, "standardUnlock": null }, "behaviorOnPowerFailure": { "willLock": false, "willRemainAsIs": false, "willUnlock": false }, "deadbolt": { "position": { "isExtended": false, "isJammed": false, "isRetracted": false } }, "eventPreferences": { "publishKeyOverrideEvents": false, "publishUnauthorizedUserEvents": false }, "function": { "isApartment": false, "isOffice": false, "isPrivacy": false, "isStoreroom": false }, "indicatorBlinksWhenLocked": { "blinkSpeed": { "isNormal": false, "isRapid": false }, "isEnabled": false }, "interiorPushButton": { "isActivated": false }, "isLocked": false, "mode": { "isFrozen": false, "isHolidayRestricted": false, "isPrivacySecured": false, "isStandard": false } }, "parentSite": { "createdAt": null, "id": null, "lastUpdatedAt": null, "marketType": "AIRPORT_TRANSPORTATION", "name": null, "orgId": null, "users": { "edges": [ { "cursor": null, "node": { "email": null, "firstName": null, "id": null, "lastName": null, "roles": { "__typename": "" } } } ], "pageInfo": { "endCursor": null, "hasNextPage": false, "hasPreviousPage": false, "startCursor": null } } }, "serialNumber": null, "time": { "localSettings": { "daylightSavings": { "dstOffsetInSeconds": null, "endRule": { "hour": null, "month": "APRIL", "weekOrdinal": null, "weekday": "FR" }, "isObserved": false, "startRule": { "hour": null, "month": "APRIL", "weekOrdinal": null, "weekday": "FR" } }, "utcOffsetInSeconds": null } }, "userInterfaceSettings": { "beeper": { "isEnabled": false } } }
Was this section helpful?

What made this section unhelpful for you?