Door Controller Webservice

Update details for door controller

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

post/api/doorcontroller/updateDetails

Request

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

descriptionstring nullable

Description of the door controller

directionRadiansnumber float nullable

Direction in radians for the door controller

floorNumberinteger nullable

Floor number where the door controller is located

latitudenumber double nullable

Latitude coordinate of the door controller

locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

longitudenumber double nullable

Longitude coordinate of the door controller

namestring nullable

Name of the door controller

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 required

base 64 (url-safe) uuid string

Example request

{
  "description": "Controls access to the main entrance",
  "directionRadians": 1.5708,
  "floorNumber": 1,
  "latitude": 34.0522,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -118.2437,
  "name": "Main Entrance Controller",
  "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.