GET /edgeDevices/{linkId}/audits

This resource is used to retrieve all the audits received by the linked edge device. Audit structure is defined in the ENGAGE - JSON Data Structures document and the meaning of audits are defined in the ENGAGE - Audits document.

Gateway 

The audits are pushed in real-time from the edge device to the Gateway. Once transferred to the edge device it is expected that the audits are removed from the edge device and reside only inside the Gateway memory. It is possible however that an audit may be reported to the Gateway twice if the edge device was disconnected from the Gateway before the communication of audits was completed. Alliance partners may wish to filter these duplicate messages if the display of duplicate audits is undesirable.

NOTE: It is important to note that the Gateway does not validate information sent through it, intending to operate as a store and forward bridge as much as possible, and thus the audits generated in response to operations by the edge device itself should be consulted to validate proper processing occurred.

In addition, it is recommended that our Alliance Partners store at least the last 30 days of all generated audits from ENGAGE devices in order to provide verification of events.

Reader-Controller

The reader-controller posts audits to the host, when connected, in real-time. This resource can be used to retrieve audits that were not sent when the device was disconnected from the host.

Authentication

Basic – unique credentials defined and accepted during setup.

Request

URI parameters:

Type: path parameter

• linkId = linked edge device identifier, as defined in the 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, object containing ordered list of audits as follows:

  • linkId = definition in the ENGAGE - JSON Data Structures document, section titled “Gateway Edge Device Link List”

  • audits = parent tag array, as defined in the ENGAGE - JSON Data Structures document

  • overwriteIndex = zero based index for the location of the “oldest” audit. This tag only appears after the Gateway has received more than 2000 audits from the edge device without the audits being requested from the IP Host. Not applicable to reader-controllers.

Example:

{"edgeDevice":{"linkId":"dev00001","audits":[{"event":"05020000","time":"20150814163754"},{"event":"000045c0","time":
"20150814163754"},{"event":"0f060000","time":"20150814163800"}]}}