GET_edgeDevices_linkList

API Command Template - delete all blue text when you are finished editing 

API Command Name <This is 'Heading 1' - e.g., GET /edgeDevices/linkList>

Enter content here. <This is a 'Paragraph' - e.g., 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 <This is 'Heading 3'>

  1. Enter note 1 here. <This is a 'Numbered List' - e.g., This resource is not applicable to the reader-controller.>
  2. Enter note 2 here.
  3. Delete or add numbered rows as needed.
  4. If there are no Notes for this command, DO NOT delete the NOTES section. Simply enter 'N/A' in the number 1 position.

Authentication <This is 'Heading 3'>

Basic: <Enter content here e.g., Unique credentials defined and accepted during setup.>

Request <This is 'Heading 3'>

URI Parameters: <Enter parameters here or if there are none, enter 'None'.>

Type: <Enter type here or if there is not one, enter 'None'.>

Success Response <This is 'Heading 3'>

HTTP status code: 200 <Enter the status code and Link to the apprropriate code reference page: http:status.es/###.>

Response parameters: <Enter parameters here or if there are none, enter 'None'.>

Type: <Enter type here or if there is not one, enter 'None' - e.g., application/json>

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

Example below <This is a 'Paragraph' in Bold>

{"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"}}]}

 

Last Modified: October 14, 2019 <This is a 'Paragraph' in Italics - enter the date as shown to reflect when edits/update were made to this webpage.>