Syntegra API HTTP request support is limited to a subset of RFC 2616.

Here are the details of the HTTP Request Type and its usage within the Syntegra Data API.

HTTP RequestDescription
GETUsed for retrieving a collection or a single resource

e.g. Retrieve Concepts, Get Cohort details, etc.
POSTUsed to create a new record.

e.g. New Cohorts, New Concepts, etc.
PUTUsed to update an existing record.

e.g. Renaming a Concept, Renaming a Cohort, etc.
DELETEUsed to delete a specified record

e.g. Delete a Cohort, Delete a Concept, etc.

Success Responses

Request successes are returned with HTTP status codes starting with 2xx. Below is a partial list of responses.

HTTP ResultResultDescription
200SuccessThe request was successful.
201Object CreatedThe request was successful and has led to the creation of an object.

Failure Responses

Request errors are returned with HTTP status codes starting with 4xx and server errors are starting with 5xx codes. Below is a partial list of responses.

HTTP ResultResultDescription
400Bad RequestThe request was invalid because the format was incorrect or the resource method was unsupported for that type.
403Authorization FailedThe request was not processed because the authorization credentials were not valid or acceptable for this resource.
404Typo ErrorThe resource you attempted to access was not found could be due to a Typo mistake.
429Max Rate LimitThe request is authorized but you don't have permission to perform that request due to Max Rate Limit.
500Internal Server ErrorThe server is failing to carry out the request due to a conflict or restriction.