Skip to content


The parameters, headers and Response Body objects that are used by all the resources are described here.

Output Data Types

The Response Body can be returned as plain text, JSON, XML, HTML, CLOD or YAML by using the "output" parameter with each of the resources.

HTTP Headers

These HTTP Headers are sent or returned to provide some metadata.

Error Object

Should one of the resources be used incorrectly or if the resource didn't return any data, an HTTP Status = '400 Bad Request' will be returned along with an "error" object in the Response Body.

All of the Resources will return a "links" object in the Response Body if the "output" parameter is not set to "text".

Back to top