Shepherd Veterinary Software · Schema
OpenApiAppointmentController.AppointmentUpdateModel
Appointment update REST model.
VeterinarySoftwareCloudPractice Management
Properties
| Name | Type | Description |
|---|---|---|
| appointmentCancellationReasonId | string | The appointment cancellation reason identifier. |
| appointmentStatusId | string | The appointment status identifier. If left null it will be set to a default value which is Upcoming. |
| appointmentTypeId | string | The appointment type identifier. If left null it will block off time for provider. If BlockOff time for provider is to be created then PatientIds and ClientId should be null. |
| cancellationNote | string | The cancellation note. |
| clientId | string | The client identifier. It can be set only when AppointmentTypeId has value. |
| endDate | string | ISO string representing the appointment end date in UTC. Must be greater than StartDate, in 5-minute increments, and no more than 24 hours after StartDate. |
| patientIds | array | The patient ids. Requires clientId. It can be set only when AppointmentTypeId has value. |
| providerId | string | The provider identifier. |
| sendEmailNotification | boolean | A value indicating whether to send email notification. The default value is false. |
| sendSmsNotification | boolean | A value indicating whether to send SMS notification. The default value is false. |
| startDate | string | The ISO string representing appointment start date. Start date is in UTC time zone. Must be in increments of 5 minutes. |
| visitReason | string | The reason for a visit. This will be the initial complaint in the SOAP. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-open-api-appointment-controller-appointment-update-model-schema.json",
"title": "OpenApiAppointmentController.AppointmentUpdateModel",
"description": "Appointment update REST model.",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/shepherd-vet-appointment-api-openapi.yml#/components/schemas/OpenApiAppointmentController.AppointmentUpdateModel",
"required": [
"endDate",
"providerId",
"startDate"
],
"type": "object",
"properties": {
"appointmentCancellationReasonId": {
"description": "The appointment cancellation reason identifier.",
"type": "string"
},
"appointmentStatusId": {
"description": "The appointment status identifier. If left null it will be set to a default value which is Upcoming.",
"type": "string"
},
"appointmentTypeId": {
"description": "The appointment type identifier. If left null it will block off time for provider. If BlockOff time for\nprovider is to be created then PatientIds and ClientId should be null.",
"type": "string"
},
"cancellationNote": {
"description": "The cancellation note.",
"type": "string"
},
"clientId": {
"description": "The client identifier. It can be set only when AppointmentTypeId has value.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "ISO string representing the appointment end date in UTC. Must be greater than StartDate, in 5-minute increments, and no more than 24 hours after StartDate.",
"type": "string"
},
"patientIds": {
"description": "The patient ids. Requires clientId. It can be set only when AppointmentTypeId has value.",
"type": "array",
"items": {
"format": "uuid",
"type": "string"
}
},
"providerId": {
"description": "The provider identifier.",
"type": "string"
},
"sendEmailNotification": {
"description": "A value indicating whether to send email notification. The default value is false.",
"type": "boolean"
},
"sendSmsNotification": {
"description": "A value indicating whether to send SMS notification. The default value is false.",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "The ISO string representing appointment start date. Start date is in UTC time zone. Must be\nin increments of 5 minutes.",
"type": "string"
},
"visitReason": {
"description": "The reason for a visit. This will be the initial complaint in the SOAP.",
"type": "string"
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/shepherd-vet-open-api-appointment-controller-appointment-update-model"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.