Representation Formats

Owned by Former user (Deleted)
Last updated: Apr 25, 2014 by Rashmi Likhite
  • The API uses XML or JSON for requests as well as responses. This is governed by the parameter data-format that is to be passed in every request. All XML documents sent to and returned from the service should be XML 1.0, encoded as UTF-8. In case of JSON, all strings are encoded in UTF-8 format. For example refer here.
     
  • Date and time is represented as: YYYY-MM-DD hh:mm:ss e.g. 10 August 2011, 1:45 PM will be represented by 2011-08-10T13:45:00
     
  • Boolean values are to be represented as strings true and false. Booleans in database columns are stored as 't' for true and 'f' for false.

  • When the format is XML, property names and their values are returned as XML elements and its contents respectively. In case of JSON, they become the object property name and value respectively.

For PHP, refer the sample file in the zip file here.