REST

REST is the simplest response format to use - it's a simple XML block.

To return the response in REST format, send a parameter "format" in the request with a value of "rest". When using the REST request method, the response defaults to REST.

A method call returns this:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
     [xml-payload-here]
</rsp>

If an error occurs, the following is returned:

<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="fail">
     <err code="[error-code]" msg="[error-message]" />
</rsp>

JSON

JSON, or JavaScript Object Notation, is a simple machine-readable data-interchange format, which makes constructing API applications in JavaScript easy (though it can be used from other languages too!).

To return an API response in JSON format, send a parameter "format" in the request with a value of "json".

A method call returns this:

{
     "stat":"ok",
     "payload":"here",
     "foo":"bar"
}

If an error occurs, the following is returned:

{
     "stat":"fail",
     "code":[error-code],
     "message":"[error-message]"
}

Response Formats

REST

JSON