REST API Non-PNP devices Routes End Lookup
April 13, 2023 at 2:39 AMEnd Lookup
Role
This command terminates the device discovery task started by the Begin Lookup route.
Prototype
URL : /lookup/end
Method : POST
URL Params : None
Request data :
Field name | Type | Status | Description |
---|---|---|---|
Channel |
string | mandatory | Communication channel: serial , ble or network |
Example
{
"Channel": "network"
}
Success Response
Code : 200 OK
Content : an array of FOUND_DEVICE objects.
Content example
[
{
"DeviceId": "4rIUNPyNqg9ltFALpWUKQ1",
"IsNew": true,
"Bound": false,
"Channel": "network",
"PhysAddress": "74905007901",
"Dhcp": true,
"IpAddress": "192.168.16.225",
"IpMask": "255.255.255.0",
"IpGateway": "192.168.16.20",
"TcpServerPort": 3999
},
{
"DeviceId": "hwCYi73s0N5sSDxrW1XfA9",
"IsNew": true,
"Bound": true,
"Name": "SpringCard SpringPark",
"SerialNumber": "74905007902",
"Channel": "network",
"PhysAddress": "74905007902",
"Profile": "mqqt",
"Mode": "smartreader",
"FriendlyMode": "RDR (MQTT)",
"Location": "MBA's Office",
"Dhcp": false,
"IpAddress": "192.168.16.47",
"IpMask": "255.255.255.0",
"IpGateway": "192.168.16.20"
}
]
Error Response
See Error Responses.
Specific error messages are:
-
NotActive
: no discovery task has run recently. -
WrongChannel
: a discovery task has run recently, but on another channel.