Update Devices

PUT /engage/devices/{deviceReference}/site/{siteReference}

This API allows the authorized site account to update the FriendlyName for a device record.

Authentication

Basic Authentication, must be a partner managed account type.

URI Parameters

• DeviceReference = string (required)

  • Unique identifier for device

• siteReference = string (required)

  • Reference ID of the site

Body Parameters

Type: application/json

• FriendlyName = string (required)

  • The new FriendlyName desired by the user. The FriendlyName must be less than 32 ASCII characters

• Timestamp = string (required)

  • The most recent value on record. If the supplied value is out of date, the request will not be successful. The most recent value can be retrieved from the Site Device List resource.

Response

HTTP status code 200

• OK – FriendlyName successfully changed

HTTP status code 400

• Bad Request - Something went wrong

• “Attempted Update Failed Concurrency Check” – The Timestamp in the JSON body does not match the “Timestamp” from Site Device List resource.

Body

• Type: application/json

Response Parameters

• “DeviceReference” = string

  • Unique identifier for device

• “FriendlyName” = string

  • Name given to the device during commissioning

• “DeviceType” = string

  • ENGAGE enabled device type. Corresponds to the “mdl” tag.

• “SerialNumberShort” = string

  • 8 byte version of device serial number; hexadecimal format

• “SerialNumberLong” = string

  • 16 byte version of device serial number; hexadecimal format

• “Timestamp” = string

  • Timestamp value required if the user desires to change editable device parameters.

Example:

PUT /engage/devices/553af9eb-0633-4c61-bf2c-dd67bf9c01b5/site/2fca6a73-8766-4ff2-8ebf-aa5a1cd11fa2 HTTP/1.1

Host: partner.lockwebserv.com

Content-Type: application/json

Authorization: Basic Authorization: Basic c2l0ZUFkbWluQHNvZnR3YXJlLmNvbTpFTkdBR0UxMjM0NTY=

{"FriendlyName":"New Name","Timestamp":"635882358105748197"}