Shepherd Veterinary Software · Schema
RESTCollectionModelBase_OpenApiAppointmentPatientController.AppointmentPatient
VeterinarySoftwareCloudPractice Management
Properties
| Name | Type | Description |
|---|---|---|
| embed | string | |
| item | array | |
| page | integer | |
| recordsPerPage | integer | |
| searchQuery | string | |
| sort | string | |
| totalRecords | integer |
JSON Schema
shepherd-vet-restcollection-model-base-open-api-appointment-patient-controller-appointment-patient-schema.json
Raw ↑
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/shepherd-vet/json-schema/shepherd-vet-restcollection-model-base-open-api-appointment-patient-controller-appointment-patient-schema.json",
"title": "RESTCollectionModelBase_OpenApiAppointmentPatientController.AppointmentPatient",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/shepherd-vet-appointmentpatient-api-openapi.yml#/components/schemas/RESTCollectionModelBase_OpenApiAppointmentPatientController.AppointmentPatient",
"type": "object",
"properties": {
"embed": {
"type": "string"
},
"item": {
"type": "array",
"items": {
"$ref": "#/$defs/OpenApiAppointmentPatientController.AppointmentPatient"
}
},
"page": {
"format": "int32",
"type": "integer"
},
"recordsPerPage": {
"format": "int32",
"type": "integer"
},
"searchQuery": {
"type": "string"
},
"sort": {
"type": "string"
},
"totalRecords": {
"format": "int32",
"type": "integer"
}
},
"$defs": {
"OpenApiAppointmentPatientController.Appointment": {
"description": "Appointment REST model.",
"type": "object",
"properties": {
"appointmentStatusId": {
"description": "Unique identifier representing the related AppointmentStatus entity.",
"type": "string"
},
"appointmentTypeId": {
"description": "Unique identifier representing the related AppointmentStatus entity, if the appointment type identifier is null then the appointment is a\nblock off appointment for the provider.",
"type": "string"
},
"clientId": {
"description": "Unique identifier representing the related Client entity",
"type": "string"
},
"clinicId": {
"description": "Unique identifier representing the related Clinic entity.",
"type": "string"
},
"createdByUserId": {
"description": "Unique identifier representing the user who created the appointment.",
"type": "string"
},
"endDate": {
"format": "date-time",
"description": "Appointments end date and time.",
"type": "string"
},
"isDeleted": {
"description": "Value indicating whether this appointment is deleted.",
"type": "boolean"
},
"providerId": {
"description": "Unique identifier representing the related Provider entity.",
"type": "string"
},
"recurringConfigurationId": {
"description": "Recurring configuration identifier, only exists for recurring appointments.",
"type": "string"
},
"sendEmailNotification": {
"description": "Value indicating whether this appointment sends email notifications.",
"type": "boolean"
},
"sendSmsNotification": {
"description": "Value indicating whether this appointment sends SMS notifications.",
"type": "boolean"
},
"startDate": {
"format": "date-time",
"description": "Appointment's start date and time.",
"type": "string"
},
"visitReason": {
"description": "Optional free-text field indicating visit reason for appointment.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiAppointmentPatientController.AppointmentPatient": {
"description": "Appointment Patient REST model",
"type": "object",
"properties": {
"appointment": {
"$ref": "#/$defs/OpenApiAppointmentPatientController.Appointment",
"description": "Object representing the related Appointemnt entity."
},
"appointmentId": {
"format": "uuid",
"description": "Unique identifier representing the related Appointment entity.",
"type": "string"
},
"ignorePatient": {
"description": "A value indicating whether a client and/or a patient is inactive and therefore should be ignored.",
"type": "boolean"
},
"patient": {
"$ref": "#/$defs/OpenApiAppointmentPatientController.Patient",
"description": "Object representing the related Patient entity."
},
"patientId": {
"format": "uuid",
"description": "Unique identifier representing the related Patient entity.",
"type": "string"
},
"soap": {
"$ref": "#/$defs/OpenApiAppointmentPatientController.Soap",
"description": "Object representing the related Soap entity."
},
"soapId": {
"format": "uuid",
"description": "Unique identifier representing the Soap entity.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiAppointmentPatientController.Patient": {
"description": "Patient REST model.",
"type": "object",
"properties": {
"additionalText": {
"description": "Optional free-text field for internal notes or additional information about the patient.",
"type": "string"
},
"alerts": {
"description": "Important info for the patient, e.g. \"Difficult to work with\"",
"type": "string"
},
"breedId": {
"description": "Identifier representing the patient's breed.",
"type": "string"
},
"color": {
"description": "Field representing patient color or marking (e.g., \"Brown\")",
"type": "string"
},
"dateDeceased": {
"format": "date-time",
"description": "Date when the patient was marked as deceased.",
"type": "string"
},
"dateOfBirth": {
"format": "date-time",
"description": "Birth date of the patient.",
"type": "string"
},
"deleted": {
"description": "Value indicating whether patient is deleted.",
"type": "boolean"
},
"homeClinicId": {
"description": "Identifier of the home clinic associated with the patient.",
"type": "string"
},
"identifier": {
"description": "Clinic-specific short identifier used to reference the patient.",
"type": "string"
},
"legacyId": {
"description": "Legacy identifier for the patient, used if patient was migrated from an other system.",
"type": "string"
},
"microchipNumber": {
"description": "Microchip number assigned to the patient.",
"type": "string"
},
"name": {
"description": "Patient's name.",
"type": "string"
},
"patientCPRStatusNote": {
"description": "Notes or additional instructions related to the patients CPR status.",
"type": "string"
},
"patientCprstatusId": {
"description": "Unique identifier representing the patient's CPR status.",
"type": "string"
},
"rabiesTag": {
"description": "Rabies tag number assigned to the patient.",
"type": "string"
},
"sexId": {
"description": "Unique identifier representing the patient's sex..",
"type": "string"
},
"statusId": {
"description": "Unique identifier representing the patient's current status.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
}
}
},
"OpenApiAppointmentPatientController.Soap": {
"description": "Soap REST model.",
"type": "object",
"properties": {
"clinicId": {
"description": "Unique identifier representing the related Clinic entity.",
"type": "string"
},
"createdByUserId": {
"description": "Unique identifier representing the user who created this SOAP entry",
"type": "string"
},
"dateCheckedIn": {
"format": "date-time",
"description": "Date and time when the patient was checked in.",
"type": "string"
},
"dateDeleted": {
"format": "date-time",
"description": "Date and time when the SOAP was deleted.",
"type": "string"
},
"deleted": {
"description": "Value indicating whether this soap is deleted.",
"type": "boolean"
},
"invoiceId": {
"description": "Unique identifier representing the invoice associated with this SOAP.",
"type": "string"
},
"locationId": {
"description": "Unique identifier representing the Soap location.",
"type": "string"
},
"patientId": {
"description": "Unique identifier representing the patient to whom this SOAP belongs.",
"type": "string"
},
"soapStatusId": {
"description": "Unique identifier representing the related SoapStatus entity.",
"type": "string"
},
"supervisingDoctorId": {
"description": "Unique identifier representing the related SupervisingDoctor entity.",
"type": "string"
},
"title": {
"description": "Soap title.",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateUpdated": {
"format": "date-time",
"type": "string"
},
"id": {
"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-restcollection-model-base-open-api-appointment-patient-controller-appointment-patient"
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.