GET_edgeDevices_lockStatus

GET /edgeDevices/lockStatus

This resource is used to retrieve current status of all edge devices. The body of the response is the JSON object lockStatus as defined in the ENGAGE - JSON Data Structures document.

Notes

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: <missing or is this 'None'?>

Type: application/json

edgeDevice = parent tag, array containing ordered list of status for each linkId. Each array entry scheme as follows:
- linkId = definition in the ENGAGE - JSON Data Structures document, section titled “Gateway Edge Device Link List”
- sensorStatus = parent tag + children; as defined in the ENGAGE - JSON Data Structures document, section titled “Lock Status” related to the Gateway structures
- lockStatus = parent tag + children; as defined in the ENGAGE - JSON Data Structures document, section titled “Lock Status” related to the Gateway structures

Example

{"edgeDevice":[{"linkId":"dev00001","sensorStatus":{"rexActive":"F","fdrActive":"F","tamperOpen":"T","magTamperDetected":"T",
"rtcBatteryStatus":"normal","locked":"T","primaryBatteryStatus":"normal","doorOpen":"F"},"lockStatus":{"currentLockState":"sec"}},
{"linkId":"dev00003","sensorStatus":{"rexActive":"F","fdrActive":"F","tamperOpen":"F","magTamperDetected":"F","rtcBatteryStatus":
"normal","locked":"T","primaryBatteryStatus":"normal","doorOpen":"T"},"lockStatus":{"currentLockState":"frznSec"}}]}