Climate Webservice

Update climate sensor details

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

post/api/climate/updateDetails

Request

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

Whether the environmental sensor is deleted

deletedUpdatedboolean nullable
descriptionstring nullable

Description of the environmental sensor

descriptionUpdatedboolean nullable
floorNumberinteger nullable

Floor number where the environmental sensor is located

floorNumberUpdatedboolean nullable
latitudenumber double nullable

Latitude coordinate of the environmental sensor

latitudeUpdatedboolean nullable
locationUuidstring RUUID nullable

base 64 (url-safe) uuid string

locationUuidUpdatedboolean nullable
longitudenumber double nullable

Longitude coordinate of the environmental sensor

longitudeUpdatedboolean nullable
namestring nullable

Name of the environmental sensor

nameUpdatedboolean nullable
policyUuidstring RUUID nullable

base 64 (url-safe) uuid string

policyUuidUpdatedboolean nullable
subLocationsHierarchyKeystring SubLocationsHierarchyKey nullable

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

subLocationsHierarchyKeyUpdatedboolean nullable
uuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "associatedCameras": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ],
  "description": "Temperature and humidity sensor in main office",
  "floorNumber": 1,
  "latitude": 37.7749,
  "locationUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "longitude": -122.4194,
  "name": "Main Office Sensor",
  "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.