Sign in

v1

latestOpenAPI 3.0.02026-07-26550199.6 KB
case

Get a paged array of cases

Get a paged array of cases

get/cases

Query parameters

id_gtinteger nullable

The starting object id of the next page

Example:200
id_ltinteger nullable

The starting object id of the previous page

Example:100
string
OR
string
string
OR
string
include_archived'true' | 'false' nullable

Whether archived objects should be retrieved, default is false

patientIdnumber nullable

Patient id

Example:1
practitionerIdnumber nullable

Practitioner id

Example:1
contactIdnumber nullable

Contact id

Example:1
trackType'Appointments' | 'Hours' | 'Budget' nullable

Track type

Example:Budget
status'Open' | 'Closed' | 'Expired' nullable

Status

Example:Open

Response

A paged array of cases

Example response

{
  "data": [
    {
      "id": 1,
      "caseNumber": "0002",
      "budget": 200,
      "appointmentCount": 12,
      "contactId": 1,
      "providerNumber": "1512",
      "referralPeriod": "Standard",
      "notes": "Notes",
      "trackType": "Budget",
      "hours": 32,
      "includeDidNotArrive": true,
      "includeCancelled": true,
      "practitionerId": 1,
      "items": [
        {
          "typeId": 1,
          "type": "Appointment"
        }
      ],
      "organisationId": 1,
      "patientId": 2,
      "isOpen": true,
      "hasAlert": true,
      "remindTime": "Time",
      "utilisationAlert": 1,
      "isAlertUtilizationSent": true
    }
  ],
  "links": {
    "previousPage": "/v1/${object_type}?id_gt=200",
    "nextPage": "/v1/${object_type}?id_lt=100"
  }
}