Raw schema
{
"type": "object",
"properties": {
"date_from": {
"description": "Appointments on or after this date, YYYY-MM-DD.",
"type": "string"
},
"date_to": {
"description": "Appointments on or before this date, YYYY-MM-DD.",
"type": "string"
},
"location_ids": {
"description": "Only these locations (numeric Nookal ids, up to 100).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"client_ids": {
"description": "Only these clients (patients) (numeric Nookal ids, up to 100).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"provider_ids": {
"description": "Only these practitioners (staff ids) (numeric Nookal ids, up to 100).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"appointment_ids": {
"description": "Only these appointments (numeric Nookal ids, up to 100).",
"minItems": 1,
"maxItems": 100,
"type": "array",
"items": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
}
},
"appt_types": {
"description": "Appointment kinds, e.g. [\"Consultation\"] or [\"Class\"].",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
}
},
"appt_statuses": {
"description": "Statuses as Nookal names them, e.g. [\"Completed\"], [\"Cancelled\"], [\"DNA\"] (did not arrive), [\"Pending\"].",
"minItems": 1,
"maxItems": 10,
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 40
}
},
"modified_from": {
"description": "Only appointments created/updated after this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).",
"type": "string"
},
"modified_to": {
"description": "Only appointments created/updated before this (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).",
"type": "string"
},
"page": {
"description": "Page number (default 1).",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"page_length": {
"description": "Items per page, 1-100 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 100
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}