Supported formats

Our Web API is a defined set of HTTP request messages accompanied by a definition of the structure of response messages, expressed in multiple formats which can be used in combination with multiple services into new applications or mashups.

We currently support the following formats:

  • JSON
  • HTML
  • JSONdatatable
  • CSV
  • PNG

To implement the data generated with an api call, you can use many programming techniques; HTML, PHP, Javascript, JSP, .NET, etc.

Some basic examples are found below.

Overview of formats

JSON

JSON (an acronym for JavaScript Object Notation) is a lightweight text-based open standard designed for human-readable data interchange. It is derived from the JavaScript programming language for representing simple data structures and associative arrays, called objects (the "O" in "JSON"). Despite its relationship to JavaScript, it is language-independent, with parsers available for virtually every programming language. (source: wikipedia)

{ "resultsList": [{
"heading_name":"data",
"heading_name":"data"}
] }

 

HTML

Using the HTML format parameter in an API call, the data will be formatted according to the official HTML standard

<table id="one">
  <thead>
    <tr>
      <th>heading_name</th>
    </tr>
  </thead>
  <tbody>
   <tr>
     <td sort="sort_data_id">data</td>
   </tr>
  </tbody>
 </table>

 

JSONdatatable

a JSONdatatable is a custom made virtual table in JSON arrays that first describes the table, and also includes the actual data. Description data arrays can contain: number of rows, column labels, column fields, etc. The actual data is a JSON array named resultsList.

({"rows": 2, "field": ["field1", "field2", ... ], "label": ["label1", "label2", ...], "className": ["name1", "name2", ..], "caption": "No caption", "pager": "apager", "rowsPerPageOptions": [ 20,40 ], "resultsList": [[ data ]] })

We would love to hear your feedback. Please use the facebook comment box below