The web service API returns responses in JSON format. This format can be changed on a per-call basis. To accomplish this we would need to implement the code to support the desired format like this code which implements the JSON format, add the new format to the array of supported formats and then indicate the format using the special reserved parameter format in the GET/POST call.

The current set of supported formats are:

  • JSON: the default response format
  • stream and streamraw: read about them here
  • user: return response based on user preferences settings
Note that this implies that NO web service end point may use a parameter named **format** as this parameter is used for this sole purpose.

Next| Chapter 19: Frequently Asked Questions.