GET /gateway/scanList

Issuing a GET against this resource triggers a BLE scan of nearby advertising ENGAGE devices. Every GET triggers a real time scan which utilizes Gateway BLE radio, so it takes a moment for scanning to complete. Issuing too many scans back to back is not recommended. A scan is required prior to posting to the edgeDevices resource as described in the Linking and Controlling Edge Devices Section.

In heavy 2.4GHz traffic environments and depending on the advertising rates of ENGAGE edge devices, some devices might not be returned in the scan list, so a second request might be needed. The response is the gatewayScanList JSON object defined in the ENGAGE - JSON Data Structures document. If the Gateway has the maximum number of devices linked, it will be unable to scan for new devices to link to, and an error will be returned.

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

• gatewayScanList = parent tag + children tags, definition in the ENGAGE - JSON Data Structures document, section titled “Gateway Scan List”

Error Response(s)

HTTP status code: 409

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

Type: application/json

• statusMessage = “Linked devices at maximum”

HTTP status code: 500

Response parameters: <missing or should this be 'None' or N/A?>

Type: application/json

• statusMessage = “Request timed out”

Example

{"gatewayScanList":[{"mainSn":"a100000000001234","deviceName":"Front Door","signalQuality":"Med","modelType":"nde"},
{"mainSn":"a100000000005678","deviceName":"Storage Closet","signalQuality":"Med","modelType":"nde"}]}

Last Modified: October 22, 2019