RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient

VeterinarySoftwareCloudPractice Management

Properties

Name Type Description
embed string
item array
page integer
recordsPerPage integer
searchQuery string
sort string
totalRecords integer
View JSON Schema on GitHub

JSON Schema

shepherd-vet-restcollection-model-base-open-api-client-patient-controller-client-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-client-patient-controller-client-patient-schema.json",
  "title": "RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/shepherd-vet-clientpatient-api-openapi.yml#/components/schemas/RESTCollectionModelBase_OpenApiClientPatientController.ClientPatient",
  "type": "object",
  "properties": {
    "embed": {
      "type": "string"
    },
    "item": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/OpenApiClientPatientController.ClientPatient"
      }
    },
    "page": {
      "format": "int32",
      "type": "integer"
    },
    "recordsPerPage": {
      "format": "int32",
      "type": "integer"
    },
    "searchQuery": {
      "type": "string"
    },
    "sort": {
      "type": "string"
    },
    "totalRecords": {
      "format": "int32",
      "type": "integer"
    }
  },
  "$defs": {
    "OpenApiClientPatientController.Client": {
      "description": "Client REST model.",
      "type": "object",
      "properties": {
        "additionalText": {
          "description": "Free-text field of additional info for the client.",
          "type": "string"
        },
        "alerts": {
          "description": "Important info for the client, e.g. \"Difficult to work with\"",
          "type": "string"
        },
        "clientStatusId": {
          "description": "Unique identifier of the related ClientStatus entity, e.g \"Active\" or \"Inactive\"",
          "type": "string"
        },
        "dateDeleted": {
          "format": "date-time",
          "description": "Date when Client was deleted.",
          "type": "string"
        },
        "deleted": {
          "description": "Value indicating whether this client is deleted.",
          "type": "boolean"
        },
        "email": {
          "description": "The client's email.",
          "type": "string"
        },
        "emailNotification": {
          "description": "Flag indicating whether the client accepts Email notifications.",
          "type": "boolean"
        },
        "firstName": {
          "description": "The client's first name.",
          "type": "string"
        },
        "homeClinicId": {
          "description": "Unique identifier of the related Client's Home Clinic entity.",
          "type": "string"
        },
        "identifier": {
          "description": "The client's short unique identifier inside the clinic. Clients from different clinics can have the same value.",
          "type": "string"
        },
        "isSubscribedToNotifications": {
          "description": "Flag indicating whether the client is subscribed to notifications. If false, no email or SMS\nnotifications should be sent to the client.",
          "type": "boolean"
        },
        "isTaxExempt": {
          "description": "Flag indicating whether the client is exempt from taxes.",
          "type": "boolean"
        },
        "lastName": {
          "description": "The client's last name.",
          "type": "string"
        },
        "legacyId": {
          "description": "The client's legacy identifier from a previous PIMS.",
          "type": "string"
        },
        "smsNotification": {
          "description": "Flag indicating whether the client accepts SMS notifications.",
          "type": "boolean"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiClientPatientController.ClientPatient": {
      "description": "ClientPatient REST model.",
      "type": "object",
      "properties": {
        "client": {
          "$ref": "#/$defs/OpenApiClientPatientController.Client",
          "description": "Object representing related Client entity."
        },
        "clientId": {
          "format": "uuid",
          "description": "Unique identifier of the related Client entity.",
          "type": "string"
        },
        "patient": {
          "$ref": "#/$defs/OpenApiClientPatientController.Patient",
          "description": "Object representing related Patient entity."
        },
        "patientId": {
          "format": "uuid",
          "description": "Unique identifier of the related Patient entity.",
          "type": "string"
        },
        "dateCreated": {
          "format": "date-time",
          "type": "string"
        },
        "dateUpdated": {
          "format": "date-time",
          "type": "string"
        },
        "id": {
          "type": "string"
        }
      }
    },
    "OpenApiClientPatientController.Patient": {
      "description": "Patient REST model.",
      "type": "object",
      "properties": {
        "additionalText": {
          "description": "Free-text field of additional info for 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"
        },
        "clients": {
          "description": "Patient's owner(s).",
          "type": "array",
          "items": {
            "$ref": "#/$defs/OpenApiClientPatientController.Client"
          }
        },
        "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": "Identifier.",
          "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": "Free-text note describing the patient's CPR (Cardiopulmonary Resuscitation) status.",
          "type": "string"
        },
        "patientCprstatusId": {
          "description": "Identifier representing the patient's CPR status.",
          "type": "string"
        },
        "rabiesTag": {
          "description": "Rabies tag number assigned to the patient.",
          "type": "string"
        },
        "sexId": {
          "description": "Identifier representing the patient's sex.",
          "type": "string"
        },
        "statusId": {
          "description": "Identifier representing the patient's current status.",
          "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.
All 92 tools →

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-client-patient-controller-client-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.