Table of Contents

HTTP Interface

At some stage the HTTP interface will probably be converted to something like REST, for now its a bunch of URI's used which return certain data.

JSON Encapsulation

All JSON responses are encapsulated within a status structure.

Success:

{
  status: 'success',
  data: $data
}

Errors:

{
  status: 'error',
  message: 'error string'
}

URI's and Commands

To access the JSON variant of various data one can use the below URI's…

/statistics/jsondata

The jsondata URI will provide a JSON formatted list of statistics for the request made.

Data Format: The $tag value will be used when returning the statistics. See OTSJsonStats.

URI format:

/statistics/jsondata?$type=$tag:$item

Possible values for type: