Get Devices

GET /engage/devices/site/{siteReference}

This API retrieves an ordered list (array) of all devices on a given site. Each list entry contains information about the given device.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

• siteReference = string (required)

  • Reference ID of the site

• page = integer (optional)

  • The specific page in the device collection. If not specified, value is assumed to be 1.

• items = integer (optional)

  • The number of device records to return per page. If not specified, value is assumed to be 10.

Example Request:

GET /engage/devices/site/2fca6a73-8766-4ff2-8ebf-aa5a1cd11fa2?page=1&items=3

Response

HTTP status code 200

• OK

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:

[{"DeviceReference":"773c5963-f600-4f4f-b53f-2296e96bf0ff","FriendlyName":"Gateway","DeviceType":"gwe",
"SerialNumberShort":"B100000000000212","SerialNumberLong":"0000000000000000B100000000000212","Timestamp":"635857249394447548"},
{"DeviceReference":"5583a2d9-9363-4c43-9fc8-275d48329b66","FriendlyName":"NDE","DeviceType":"nde",
"SerialNumberShort":"A100000000000928","SerialNumberLong":"0000000000000000A100000000000928","Timestamp":"635857250464507366"},
{"DeviceReference":"71e403e7-c3d7-481c-b3aa-802dd568f56d","FriendlyName":"Schlage Control","DeviceType":"be467",
"SerialNumberShort":"E100000000000972","SerialNumberLong":"0000000000000000E100000000000972","Timestamp":"635857250953413665"}]