Shepherd Veterinary Software Patient Weight Entry API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Patient Weight Entry API
  description: 'Production Base URL: https://open-api.shepherd.vet/pav2/


    Production App URL: https://app.shepherd.vet/


    Production Documentation URL: https://app.shepherd.vet/swagger/


    Sandbox Base URL: https://demo-open-api.shepherd.vet/pav2/


    Sandbox App URL: https://demo.shepherd.vet/


    Sandbox Documentation URL: https://demo.shepherd.vet/swagger


    Authorization: The integration is authorized by providing two headers in the API call


    X-Integration-Private-Key - this contains the private key from your credentials

    X-Integration-Public-Key - this contains the public key from your credentials


    Additionally, for all requests other than Clinic, the X-Clinic-Id header must be provided with the value of the clinic entity id for which you are running the API requests. You can get the entity id by calling the Clinic endpoint. If authorization fails, the request returns HTTP status 401 and the response body is one of the messages below. Missing X-Integration-Public-Key header - the public key header is absent from the request. Missing X-Integration-Private-Key header - the private key header is absent from the request. Missing X-Clinic-Id header - the clinic identifier header is absent, and the endpoint is clinic scoped. Incorrect API keys provided - both key headers were supplied, but the public key matches no integration, or the private key is not valid for that integration. Integration not enabled for the provided clinic - the key pair is valid, but the integration is not enabled and active for the clinic supplied in X-Clinic-Id. NEW: Each API call will count against your RPH and RPM limits. Once you exhaust those limits, requests will start returning HTTP status 429. The RPH is set to 12000 and RPM to 800 (subject to change). Where an endpoint supports searchQuery, a query longer than 500 characters may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_LONG, and a query with more than 10 words may return HTTP status 400 with ERROR_MESSAGES.SEARCH_PHRASE.TOO_MANY_PHRASES. NOTE: Since this API is WIP, we would be happy to hear any feedback and to implement additional filtering/sorting options etc. **Endpoints:

    All endpoints are POST requests that accept JSON bodies. The common request properties for all endpoints are:**


    rpp::int - The number of items to return per page. The max is 1000. Defaults to 10. page::int - The page number. Defaults to 1. sort::string - Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". All top-level properties should be sortable, only some nested-fields work and you should probably not use them until this API reaches production and we settle on which nested-field sortings we will support. Default depends on endpoint, usually "id|asc". embed::string - Comma-separated values for nested-fields you want to fetch (eg. "clientPhones,clientPhones.phoneType" on Client endpoint). If a specific embed is not requested, the response will contain either null or an empty array for that value. No default. dateCreatedFrom::date

    dateCreatedTo::date

    dateUpdatedFrom::date

    dateUpdatedTo::date

    - Date range filters for either the creation date or last update date. - You can pass in either one end or both of them. *


    * Only the date filters listed on an endpoint''s request model are supported; sending another one, or a ''From'' later than its ''To'', returns HTTP status 400. The request responses will come back as a JSON object. The common response properties for all endpoints are:


    embed::string - Lists the embed used in the request. This may sometimes be different from what you sent in, if in the future we add that some embeds get set automatically on certain endpoints

    links::object[] - Always empty, a leftover from the internal framework we use on our web API. Will be removed in the future if possible so do not rely on this

    page::int - Which page was fetched.'
servers:
- url: https://open-api.shepherd.vet
tags:
- name: PatientWeightEntry
paths:
  /pav2/open-api-patient-weight-entries:
    post:
      tags:
      - PatientWeightEntry
      summary: Retrieves {OpenApiPatientWeightEntryController.PatientWeightEntry} resources…
      description: 'Example Request

        {

        "embed": "weightUnit",

        "weightUnitIds": "91f26a83-13c4-4cb1-8f41-fb9cdb122a87"

        }


        Example Response

        {

        "embed": "weightUnit",

        "item": [

        {

        "createdByUserId": "4bc82e41-7f09-462d-95b0-1e0f18be9a12",

        "date": "2025-06-30T08:04:33Z",

        "note": "Initial recorded weight",

        "patientId": "af0d87b2-4983-4e9f-8d1e-cc10a121c7ee",

        "weight": 4700,

        "weightUnit": {

        "abrv": "g",

        "description": "Grams (g)",

        "name": "Gram",

        "dateCreated": "2025-04-02T13:14:13.180775Z",

        "dateUpdated": "2025-04-02T13:14:13.180775Z",

        "id": "91f26a83-13c4-4cb1-8f41-fb9cdb122a87"

        },

        "weightUnitId": "91f26a83-13c4-4cb1-8f41-fb9cdb122a87",

        "dateCreated": "2025-06-30T08:36:46.35339Z",

        "dateUpdated": "2025-06-30T08:36:46.35339Z",

        "id": "bb72a31d-f94c-41f6-b1e6-8e1c2d2f9df4"

        }

        ],

        "links": [],

        "page": 1,

        "recordsPerPage": 10,

        "searchQuery": null,

        "sort": null,

        "totalRecords": 1

        }'
      operationId: OpenApiPatientWeightEntryGet
      parameters:
      - name: x-integration-public-key
        in: header
        description: Your public API key
        required: true
        schema:
          type: string
      - name: x-integration-private-key
        in: header
        description: Your private API key
        required: true
        schema:
          type: string
      - name: x-clinic-id
        in: header
        description: The clinic uuid identifier
        required: true
        schema:
          type: string
      responses:
        '200':
          description: A paged collection of patient weight entries matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
        '401':
          description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
        '429':
          description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
        '400':
          description: "A date filter range is reversed. The response body is one of:\n             \"DateCreated filter 'From' can't be later than 'To'.\" - dateCreatedFrom is after dateCreatedTo.\n             \"DateUpdated filter 'From' can't be later than 'To'.\" - dateUpdatedFrom is after dateUpdatedTo.\n             Error object with message \"The request is invalid.\" - dateFrom is after dateTo."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryFilterModel'
        description: The model.
        required: true
  /pav2/open-api-patient-weight-entries/write:
    post:
      tags:
      - PatientWeightEntry
      summary: Inserts a new {OpenApiPatientWeightEntryController.PatientWeightEntryWriteModel}
      description: 'Example Request

        {

        "date": "2025-06-30T10:13:15.000Z",

        "note": "Second weight in ",

        "patientId": "c2d5ef45-7a23-4f6c-a02a-527e9f7715ab",

        "weight": 8,

        "weightUnitId": "5e7b7d6c-f9a0-404d-8de1-2334e5038c43"

        }


        Example Response

        {

        "createdByUserId": "e63c3e8f-6455-4ff9-9f87-27e3a97dc087",

        "date": "2025-06-30T10:13:15Z",

        "note": "Second weight in ",

        "patientId": "c2d5ef45-7a23-4f6c-a02a-527e9f7715ab",

        "weight": 8,

        "weightUnit": null,

        "weightUnitId": "5e7b7d6c-f9a0-404d-8de1-2334e5038c43",

        "dateCreated": "0001-01-01T00:00:00",

        "dateUpdated": "0001-01-01T00:00:00",

        "id": "f419dfc4-5d11-4f83-9399-3e6e172b4321"

        }'
      operationId: OpenApiCreatePatientWeightEntry
      parameters:
      - name: x-integration-public-key
        in: header
        description: Your public API key
        required: true
        schema:
          type: string
      - name: x-integration-private-key
        in: header
        description: Your private API key
        required: true
        schema:
          type: string
      - name: x-clinic-id
        in: header
        description: The clinic uuid identifier
        required: true
        schema:
          type: string
      responses:
        '201':
          description: The created patient weight entry.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry'
        '401':
          description: 'Authorization failed. One of: Missing X-Integration-Public-Key header, Missing X-Integration-Private-Key header, Missing X-Clinic-Id header, Incorrect API keys provided, or Integration not enabled for the provided clinic.'
        '429':
          description: Request rate limit exceeded. Please wait before making further requests. Returned once the integration passes its configured hourly or per-minute request allowance.
        '400':
          description: "A validation rule failed. The response body is one of:\n             An empty body - the request body is missing.\n             \"The request is invalid.\" with modelState - patientId, weight or weightUnitId is missing. modelState names the offending field.\n             \"Weight field cannot have this value.\" - weight is zero or negative, rounds to 0 lbs or 0 kg at three decimal places, or weightUnitId is all zeros.\n             \"PatientId is required and cannot be empty.\" - patientId is the empty GUID.\n             \"The provided PatientId does not belong to the clinic.\" - patientId does not exist, is deleted, or is outside the caller's clinic."
        '409':
          description: '"PATIENT.EDIT.WARNING_MERGE_PATIENT" - the patient was merged into another patient or deleted while the request was being processed.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryWriteModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryWriteModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntryWriteModel'
        description: Weight entry write model
        required: true
components:
  schemas:
    OpenApiPatientWeightEntryController.WeightUnit:
      description: WeightUnit RESTModel
      type: object
      properties:
        abrv:
          description: Short unique identifier for the lookup.
          type: string
        description:
          description: The description of the lookup entry.
          type: string
        name:
          description: The name of the lookup entry.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiPatientWeightEntryController.PatientWeightEntry:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiPatientWeightEntryController.PatientWeightEntry'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiPatientWeightEntryController.PatientWeightEntry:
      description: PatientWeightEntry REST model
      type: object
      properties:
        createdByUserId:
          format: uuid
          description: Unique identifier of the clinic user that recorded weight entry value.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        date:
          format: date-time
          description: Date of the weight entry, in UTC format.
          type: string
        note:
          description: Free-text note associated with the weight entry.
          type: string
        patientId:
          format: uuid
          description: Unique identifier representing the related Patient entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        weight:
          format: double
          description: Patient's weight, represented in the unit specified by weightUnitId.
          type: number
        weightUnit:
          $ref: '#/components/schemas/OpenApiPatientWeightEntryController.WeightUnit'
          description: Object representing the related Unit of weight measurement entity.
        weightUnitId:
          format: uuid
          description: Unique identifier of the related WeightUnit entity; defines the unit for the weight (e.g., kg).
          type: string
          example: 00000000-0000-0000-0000-000000000000
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiPatientWeightEntryController.PatientWeightEntryWriteModel:
      description: PatientWeightEntryInsert REST model
      required:
      - patientId
      - weight
      - weightUnitId
      type: object
      properties:
        date:
          format: date-time
          description: Date of the weight entry, in UTC format.
          type: string
        note:
          description: Free-text note associated with the weight entry.
          type: string
        patientId:
          format: uuid
          description: Unique identifier representing the related Patient entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        weight:
          format: double
          description: Patient's weight, represented in the unit specified by weightUnitId.
          type: number
        weightUnitId:
          format: uuid
          description: Unique identifier of the related WeightUnit entity; defines the unit for the weight (e.g., kg).
          type: string
          example: 00000000-0000-0000-0000-000000000000
    OpenApiPatientWeightEntryController.PatientWeightEntryFilterModel:
      description: PatientWeightEntry Filter REST model
      type: object
      properties:
        clinicIds:
          description: 'Comma-separated list of clinic identifiers. Defaults to null.

            This filter applies only if the group to which the clinic belongs shares clients and patients.

            If provided, only PatientWeightEntry data from the specified clinics will be returned, but only if the clinic is the patient''s home clinic (regardless of the x-clinic-id in the header).

            If null, data from all clinics in the group will be returned.'
          type: string
        dateFrom:
          format: date-time
          description: Sets the start of the date range filter on the weighing date. Defaults to null.
          type: string
        dateTo:
          format: date-time
          description: The end of the date range filter on the weighing date. Defaults to null.
          type: string
        includePatientHomeClinic:
          description: "Used to support multi-site practices that share patients and clients.\nDetermines whether to include Patient weights from a patient's home clinic\nwhen filtering by clinic.\n            \nBehavior:\n- If true:\n  - Includes Patient weights from the specified clinic (default)\n  - Also includes weights from other clinics where the patient's home clinic\n    matches the specified clinic\n- If false (default):\n  - Only includes Patient weights directly from the specified clinic\n            \nNote: The patient's home clinic is only considered if ClinicIds are provided\nin the filter; otherwise, all data from the group is returned."
          type: boolean
        patientIds:
          description: Comma-separated list of unique patient identifiers to include in the search. Defaults to null.
          type: string
        weightUnitIds:
          description: Comma-separated list of weight unit identifiers to include in the search. Defaults to null.
          type: string
        dateCreatedFrom:
          format: date-time
          description: 'Sets the start of the date range filter on the entity creation date. Must not be later than DateCreatedTo, or

            the request returns 400. Defaults to null.'
          type: string
        dateCreatedTo:
          format: date-time
          description: The end of the date range filter on the entity creation date. Defaults to null.
          type: string
        dateUpdatedFrom:
          format: date-time
          description: 'The start of the date range filter on the entity last update date. Must not be later than DateUpdatedTo, or the

            request returns 400. Defaults to null.'
          type: string
        dateUpdatedTo:
          format: date-time
          description: The end of the date range filter on the entity last update date. Defaults to null.
          type: string
        embed:
          description: Comma-separated list of embedded properties to fetch. Nested fetches can be specified using dot notation (e.g., "client.clientPhones"). Defaults to null.
          type: string
        excludeIds:
          description: Comma-separated list of IDs representing entities that you wish to exclude from your search. Defaults to null.
          type: string
        ids:
          description: Comma-separated list of IDs representing entities that you wish to include in your search. Defaults to null.
          type: string
        page:
          format: int32
          description: The page number. Defaults to 1.
          type: integer
        rpp:
          format: int32
          description: The number of items to return per page. The max is 1000. Defaults to 10.
          type: integer
        sort:
          description: Which field to sort by. Needs to be in "field|order" format, where order is either "asc" or "desc". The default sort field depends on the endpoint, typically "id|asc"
          type: string