Door Webservice

Update details for door sensor

Update details for door sensor. Note: uuid is a required field

post/api/door/updateDetails

Request

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

associatedCamerasstring[] nullable

List of associated camera device facet UUIDs

associatedCamerasUpdatedboolean nullable

Whether the associated cameras have been updated

deletedboolean nullable

Whether the door sensor is deleted

deletedUpdatedboolean nullable

Whether the deleted status has been updated

descriptionstring nullable

Description of the door sensor

descriptionUpdatedboolean nullable

Whether the description has been updated

floorNumberinteger nullable

Floor number where the door sensor is located

floorNumberUpdatedboolean nullable

Whether the floor number has been updated

latitudenumber double nullable

Latitude coordinate of the door sensor

latitudeUpdatedboolean nullable

Whether the latitude has been updated

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationUuidUpdatedboolean nullable

Whether the location UUID has been updated

longitudenumber double nullable

Longitude coordinate of the door sensor

longitudeUpdatedboolean nullable

Whether the longitude has been updated

namestring nullable

Name of the door sensor

nameUpdatedboolean nullable

Whether the name has been updated

policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyUuidUpdatedboolean nullable

Whether the policy UUID has been updated

subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

A sequence of one or more base 64 (url-safe) uuid substrings. These substrings are separated by dots (.).

subLocationsHierarchyKeyUpdatedboolean nullable

Whether the sub-locations hierarchy key has been updated

uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "associatedCamerasUpdated": true,
  "description": "Main entrance door sensor on the first floor",
  "floorNumber": 1,
  "floorNumberUpdated": true,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "locationUuidUpdated": true,
  "longitude": -122.4194,
  "name": "Main Entrance Door",
  "nameUpdated": true,
  "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "subLocationsHierarchyKey": "AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA.AAAAAAAAAAAAAAAAAAAAAA",
  "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

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

Changes

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