GET /edgeDevices/{linkId}/params

This resource is used to selectively request all of the parameters from a single edge device. The response is defined by the JSON object edgeDevice in the ENGAGE - JSON Data Structures document.

Gateway

The returned result is a cached version from when the last time the edge device parameters were retrieved by the Gateway. Any change in configuration results in this information being refreshed. Returned results are defined by the edge device and are unique to the model of edge device.

Reader-Controller

The results returned by the reader-controller are the current state of each of the parameters.

Authentication

Basic – unique credentials defined and accepted during setup.

Request

URI parameters:

Type: path parameter

• linkId = linked edge device identifier, as defined in ENGAGE - JSON Data Structures document, section titled Gateway Edge Device Link List. For reader-controllers this is a constant dev00000.

Success Response

HTTP status code 200

Response parameters:

Type: application/json

• edgeDevice = parent tag and children, as defined in the ENGAGE - JSON Data Structures document, subsection titled Linked Edge Device Data.

Example:

{"edgeDevice":{"linkId":"dev00001","config":{"battV":{"main":"5.23","li":"0"},"fwVer":{"lock":"02.04.17","main":"02.04.17",
"mainBl":"01.04.00","credRdr":"02.00.29","credRdrBl":"01.02.09","ble":"01.03.108","wifi":"4.62.r1606","macAdr":
"00:01:02:03:04:05"},"lockPrmtrs":{"name":"Front Door","mdl":"unknown","type":"strm","lckMode":"410ip","lckSn":
"a000000000000123","mainSn":"a000000000000123","hwVer":"00","daysInUse":242,"mfgDt":"ffffffff","relock":7,"doorProp":20,
"ada":30,"firstManIn":0,"dstEnable":255,"dstStart":"ffff","dstEnd":"ffff","battFail":"sec","rtcTime":"20150814162605",
"dbDwnldTm":"200000000000","fwUrl":"","fwDwnLdTm":"200000000000","fwImpTm":"200000000000"},"rdrPrmtrs":{"bprEn":"T","sn":
"1112131415161718","hwVer":"00","mfgDt":"191a1b1c","configCrdPrsntd":"F","proxConfHID":"T","proxConfGECASI":"T","proxConfGE4001":
"T","proxConfGE4002":"F","proxConfAWID":"T","iClsUID40b":"T","uid14443":"F","mi14443":"T","noc14443":"T","uid15693":"T",
"iCls15693":"F","iClsFrmt":"disbld","pivCnfg":"75bPIV"}}}}