Response Format

Commonalities for every response.

With every response, there is metadata involved that helps the client determine who it is dealing with and information to determine whether it needs to resync. This information is shown with every response with the exception of ones where only response code is needed to determine the completion of a request.

JSON

{
   "responseTypes":[
      "settings"
   ],
   "globalSessionSequence":121,
   "timestamp":"2018-03-15T15:46:51",
   "deviceName":"T7470",
   "firmwareVersion":"8.4.100.43",
   "settings":{
      ...
   }
}

responseTypes

The responseTypes is an array of responses to be returned. In the example above, only "settings" is returned, but more than one can be returned (e.g. "statistics" and "sessions" goes hand in hand). Note the matching property which allows for quick referencing in application code.

globalSessionSequence

This provides the number of changes that occurred for various sessions. When notifying, this provides a count to check whether any notifications are missed and requires resyncing.

timestamp

Timestamp is an ISO8601 string that tells the current date and time of the transmitter. This is useful for checking if the date and time of transmitter need to be updated.

deviceName

A constant string that describes the type of transmitter. Currently, it will always be T7470.

firmwareVersion

A string that describes the firmware version. Useful if filtering for a feature that may not exist in one version.