get Operatories
GET {{baseUrl}}/operatories?subdomain={{subdomain}}&location_id={{location_id}}&page=1&per_page=5&search_name=<string>&foreign_id=<string>&updated_since=<dateTime>&include[]=["appt_categories"]&include[]=["appt_categories"]
Get a list of operatories
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
subdomain | string | (Required) Used to scope the request to the specified institution | |
location_id | string | (Required) Used to scope the request to the specified institution | |
page | number | Page number. Starts with page 1 | |
per_page | number | Number of results to return per page. Defaults is 5 per page and Max 100 per page | |
search_name | string | Optional name search filter | |
foreign_id | string | Query by EMR Id | |
updated_since | string | Query operatories whose records have updated since the specified datetime in ISO8601 format. Must be a parseable Date, recommended formats are YYYY-MM-DD or YYYY-MM-DDThh:mm:ss+0000 | |
include[] | string | Resources to be included in the response | |
include[] | string | Resources to be included in the response |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"code":"\u003cboolean\u003e","description":"\u003cstring\u003e","error":["\u003cstring\u003e","\u003cstring\u003e"],"data":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","display_name":"\u003cstring\u003e","active":"\u003cboolean\u003e","appointment_types":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"}]},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","foreign_id":"\u003cstring\u003e","foreign_id_type":"\u003cstring\u003e","location_id":"\u003cinteger\u003e","last_sync_time":"\u003cstring\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","display_name":"\u003cstring\u003e","active":"\u003cboolean\u003e","appointment_types":[{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"},{"id":"\u003cinteger\u003e","name":"\u003cstring\u003e","parent_type":"\u003cstring\u003e","parent_id":"\u003cinteger\u003e","minutes":"\u003cinteger\u003e","bookable_online":"\u003cboolean\u003e"}]}],"count":"\u003cinteger\u003e"}