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.
|Used for retrieving a collection or a single resource|
e.g. Retrieve Concepts, Get Cohort details, etc.
|Used to create a new record.|
e.g. New Cohorts, New Concepts, etc.
|Used to update an existing record.|
e.g. Renaming a Concept, Renaming a Cohort, etc.
|Used to delete a specified record|
e.g. Delete a Cohort, Delete a Concept, etc.
Request successes are returned with HTTP status codes starting with 2xx. Below is a partial list of responses.
|Success||The request was successful.|
|Object Created||The request was successful and has led to the creation of an object.|
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.
|Bad Request||The request was invalid because the format was incorrect or the resource method was unsupported for that type.|
|Authorization Failed||The request was not processed because the authorization credentials were not valid or acceptable for this resource.|
|Typo Error||The resource you attempted to access was not found could be due to a Typo mistake.|
|Max Rate Limit||The request is authorized but you don't have permission to perform that request due to Max Rate Limit.|
|Internal Server Error||The server is failing to carry out the request due to a conflict or restriction.|