Get Site Reference

GET /engage/devices/{hexSerialNumber}/SiteReference

This API allows the authorized site account to retrieve the corresponding ENGAGE siteReference identifier given the short or long serial number of a given device that has been commissioned.

It fails if the device has not been commissioned or the user making the request does not have authorized access to the corresponding ENGAGE site.

Authentication

Basic Authentication, must be a partner managed account type

URI Parameters

• hexSerialNumber = string (required)
  • The short or long values of the device serial number, corresponding to Partner API URI parameters SerialNumberShort or SerialNumberLong

Example Request:

GET /engage/devices/B100000000001234/siteReference

Response

HTTP status code 200

• OK – Device found and site reference is included

Body

• Type: application/json

Parameters

• “SiteReference = string (required)
  • The reference ID of site the device has been commissioned to

Example:

{"SiteReference": "2fca6a73-8766-4ff2-8ebf-aa5a1cd11fa2"}