Response codes

HTTP requests

The Synchronizer API supports a subset of the HTTP methods in RFC 9110.

HTTP request type	Description
`GET`	Gets a collection or a single resource. Example: get patient information or appointment details.
`POST`	Creates a new record. Example: a new patient or a new appointment.
`PATCH`	Updates an existing record. Example: update patient details or an appointment.
`DELETE`	Deletes a record. Example: delete an appointment type or a webhook subscription.

A successful request returns an HTTP status code that starts with 2. This is a partial list.

HTTP result	Result	Description
`200`	Success	The request succeeded.
`201`	Created	The request succeeded and created a resource.
`204`	No content	The delete request succeeded. There is no response body.

A request error returns a status code that starts with 4. A server error returns one that starts with 5. This is a partial list.

HTTP result	Result	Description
`400`	Bad request	The request is not valid. The format is wrong, or the resource does not support the method.
`401`	Unauthorized	NexHealth did not process the request. The credentials are not valid for this resource.
`403`	Forbidden	The request is authorized, but you do not have permission for it.
`404`	Not found	The resource does not exist.

For what causes each error and how to fix it, see Errors.