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. |