Introduction

The REST API allows programmatic access to Situate. To use the REST API, you will need an API key. Use of SSL is supported and strongly encouraged as communications into Situate can be configured to initiate outside corporate firewalls.

Response Codes

The following response codes apply to all requests. Check each request type in the list below for more response codes specific to that request.

Status Code	Meaning	Description
200	OK	The request was processed successfully
201	OK	Resource was created and processed successfully
204	OK	The request was processed successfully, but no data returned. E.g., deleting an object.
400	Bad Request	Your request contained invalid or missing data
401	Unauthorized	Authentication failed or the authenticated session was not provided
404	Not Found	The URI does not match any of the recognized resources, or, if you are asking for a specific resource with an ID, that resource does not exist
415	Unsupported Media Type	The Content-Type header is not supported by the REST API
422	Unprocessable Entity	The request is well-formed but the content is invalid
500	Internal Server Error	The server was unable to process request or downstream system failed

Request and Response Formats

You can specify the formats you want to use for request and response data.

Supported Request Formats

Use the Content-Type header to specify the format your data is in.

• JSON: application/json
• XML: application/xml

Supported Response Formats

Use the Accept header to specify the desired output format. Not all resources will support all formats. Please review specific resource for more information.

• JSON: application/json