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 Request | Description |
|---|---|
GET | Used for retrieving a collection or a single resource e.g. Retrieve Concepts, Get Cohort details, etc. |
POST | Used to create a new record. e.g. New Cohorts, New Concepts, etc. |
PUT | Used to update an existing record. e.g. Renaming a Concept, Renaming a Cohort, etc. |
DELETE | Used 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 Result | Result | Description |
|---|---|---|
200 | Success | The request was successful. |
201 | Object Created | The 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 Result | Result | Description |
|---|---|---|
400 | Bad Request | The request was invalid because the format was incorrect or the resource method was unsupported for that type. |
403 | Authorization Failed | The request was not processed because the authorization credentials were not valid or acceptable for this resource. |
404 | Typo Error | The resource you attempted to access was not found could be due to a Typo mistake. |
429 | Max Rate Limit | The request is authorized but you don't have permission to perform that request due to Max Rate Limit. |
500 | Internal Server Error | The server is failing to carry out the request due to a conflict or restriction. |