Response codes

HTTP requests

The NexHealth Synchronizer API's HTTP request support is a subset of RFC 2616.

HTTP Request Type	Description
`GET`	Used for retrieving a collection or single resource e.g.* Retrieve patient information, get appointment details, etc.
`POST`	Used to create a new record. e.g. *New patient, new appointment, etc.
`PATCH`	Used to update an existing record. e.g.* Updating patient details, updating appointment, etc.
`DELETE`	Used to delete a specified record e.g.* Delete an appointment category, delete a subscription, 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`	Created	The request was successful and has led to the creation of a resource.
`204`	No content	The delete request succeeded and you should not expect a response body.

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.
`401`	Unauthorized	The request was not processed because the authorization credentials were not valid or acceptable for this resource.
`403`	Forbidden	The request is authorized but you don't have permission to perform that request.
`404`	Not found	The resource you attempted to access was not found.