NEnexhealth
Schedule Templates

View schedule template (beta)

🚧 Beta

Send Nex-Api-Version: v3.1.0 to use this endpoint. It is still changing, and access is limited to approved partner institutions. Contact NexHealth before you build on it.

This endpoint returns a single EHR schedule template by its NexHealth ID, as long as it is available to the given location.

get/schedule_templates/{id}

Request

  • Base URL
    https://nexhealth.info
  • URL
    https://nexhealth.info/schedule_templates/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

The NexHealth ID of the schedule template

Query parameters

subdomainstring required

Used to scope the request to the specified institution

location_idinteger required

The NexHealth ID of the location

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": 7,
    "name": "Hygiene week",
    "color_hex": "#4caf50",
    "active": true,
    "location_id": 115,
    "foreign_id": "42"
  },
  "count": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.