NexHealth's API HTTP request support is a subset of RFC 2616.
|HTTP Request Type||Description|
|Used for retrieving a collection or single resource|
e.g. Retrieve patient information, Get appointment details, etc.
|Used to create a new record.|
e.g. New patient, New appointment, etc.
|Used to update an existing record.|
e.g. Updating patient details, Updating appointment, etc.
|Used to delete a specified record|
e.g. Delete an appointment category, delete a subscription, etc.
Request successes are returned with HTTP status codes starting with
2xx. Below is a partial list of responses.
|Success||The request was successful.|
|Created||The request was successful and has led to the creation of a resource.|
|No Content||The delete request succeeded and you should not expect a response body.|
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.|
|Unauthorized||The request was not processed because the authorization credentials were not valid or acceptable for this resource.|
|Forbidden||The request is authorized but you don't have permission to perform that request.|
|Not Found||The resource you attempted to access was not found.|