GET_edgeDevices_linkList

ahg_Test_Page_GET /edgeDevices/linkList

 

PDF test

This resource retrieves the list of currently linked edge devices. The response contains the JSON object linkList as defined in the ENGAGE - JSON Data Structures document.

NOTES:

  1. The tag “linkCommStatus” should be used to determine if the edge device is currently connected to the Gateway.
  2. This resource is not applicable to the reader-controller.

Authentication

Basic – unique credentials defined and accepted during setup.

Request

URI Parameters

  • None

Success Response

HTTP status code 200

Response parameters:

Type: application/json

  • linkList = parent tag, as defined in the ENGAGE - JSON Data Structures document, section titled “Gateway Edge Device Link List”

Example:

{"linkList":[{"linkId":"dev00001","linkCommStatus":"Connected","deviceName":"Front Door","modelType":"nde",
"deviceId":"a000000000000123","macAddr":"00:01:02:03:04:05","macType":"public","battV":{"main":"5.23","li":"0"}}]}