API endpoints require a valid Compass session.

How to programmatically create a Compass session:

• WIP

API endpoints which return large amounts of data are paginated

WIP

All responses (successful or unsuccessful) are formatted as JSON. Data is returned in the property “d”, which is not necessarily an object.

Success

Status: 200 OK { "d": {} }

Error

Error responses return only error code 500, which is returned for any error, including:

• Authentication errors (you don’t have permission)
• Incorrect parameters
• Internal errors

Error responses include the property “h”, which is the ID of the error in the server logs.

Status: 500 Internal Server Error { "h": '5GDE38C91B5D3D5D345U9JDD9D42286618BISA97' }