v1

latestOpenAPI 3.0.0NexHealth License 1.02026-07-2688180386.6 KB

Working Hours

View working hour

This endpoint returns a single working hour.

get/working_hours/{id}

Path parameters

idinteger required

Id of the working hour

Query parameters

subdomainstring required

Used to scope the request to the specified institution

include[]string[]

Resources to be included in the response

Headers

Nex-Api-Versionstring required

The NexHealth API version

Response

Successful

codeboolean

Indicates the success or failure of the request

descriptionstring

Additional context on the request to help with debugging.

errorstring[]

Any errors that occur during the execution of the request.

countinteger

Number of total objects, in case of collection.

Example response

{
  "description": "Description",
  "error": [
    "Error message"
  ],
  "data": {
    "id": 12,
    "provider_id": 7,
    "location_id": 3,
    "operatory_id": 149,
    "begin_time": "10:30",
    "end_time": "17:00",
    "days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "specific_date": "2022-11-03",
    "custom_recurrence": {
      "num": 3,
      "unit": "day",
      "ref": "2022-11-03"
    },
    "tz_offset": "-0700",
    "active": true,
    "source": "synced",
    "label": {
      "id": 113,
      "location_id": 115,
      "name": "New patient appointments"
    },
    "appointment_types": [
      {
        "id": 1,
        "name": "Medical",
        "parent_type": "Institution",
        "parent_id": 1,
        "minutes": 15
      }
    ]
  },
  "count": 2
}