GET /gateway/deviceInfo

This resource is used to retrieve Gateway configurations and read-only parameters. The JSON object gatewayDeviceInfo is returned, as defined in the ENGAGE - JSON Data Structures document.

Authentication

Basic: Unique credentials defined and accepted during setup.

Request

URI Parameters:  <missing or should this be 'None'?>

• None

Success Response(s)

HTTP status code: 200

Response Parameters: <missing or should this be 'None'?>

Type: application/json

• gatewayDeviceInfo = parent tag + children tags, definition in the the ENGAGE - JSON Data Structures document, section titled “Device Information Records (Gateway)”

Example

{"gatewayDeviceInfo":{"fwVer":{"main":"1.49.10","ble2":"0.0.7","mainBl":"2014.10.0.2","macAdr":"00409D63028E",
"ethernetMacAdr":"00409D63028D"},"wifiStngs":{"wifiEnable":"","ssid":"","psswd":"","usrNm":"","wifiSec":"","kyIndx":""},
"gatewayParameters":{"hostProtocol":"ipEngage","deviceName":"Gateway IP Mode","mdl":"GWE","mainSn":"a0b1000000000206",
"mfgDt":"20150515","hwVer":"01","daysInUse":"00031","gwUpTime":"017","rtcTime":"20170109134639","sshEnable":"false",
"dstEnable":"true","dstStart":"3022","dstEnd":"B012","fwurl":"","fwDwnldTm":"","fwImplTm":""},"ipv4Interfaces":
{"ethernetProperties":{"assignedIpAddr":"10.44.95.46","defGatewayIpAddr":"10.44.92.1","netmask":"255.255.252.0"},
"wifiClientProperties":{"assignedIpAddr":"","defGatewayIpAddr":"","netmask":""}},"gatewayRsiModeConfig":
{"rsdAddress":"","lowDoor":"","highDoor":""},"gatewayIpModeConfig":{"discoveryMethod":"dhcp","fixedIpAddr":"",
"defGatewayIpAddr":"","netmask":"","ipDnsAddr":"","altDnsAddr":"","ipServerURL":"","caServerURL":"","wsKeepAlive":"0"},
"gatewayFeatureList":["rsiMode","ipServerMode","ipClientMode","lockFwUpgrade"],"edgeDeviceFwUrls":
[{"fwurl":"","mdl":"nde","fwDwnldTm":"","fwImplTm":"","fwVer":"","status":{"fwDwnld":"","fwUpdate":""},"extendedStatus":
[{"linkId":"dev00000","deviceId":"a100000000002479","deviceName":"testNDE","mdl":"nde","fwVer":"02.08.12","fwUpdateStatus":"",
"fwUpdateStartTm":"","fwTransferCmpltPercentage":0,"fwUpdateCmpltTm":"","fwUpdateCancelTm":"","retries":0}]}]}}

Error Response(s)

N/A

Last Modified: October 22, 2019