Shepherd Veterinary Software Provider Schedule Template API

openapi: 3.2.0
info:
  version: v1
  title: Shepherd Open API (v2.248.0.39) Provider Schedule Template…
  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: ProviderScheduleTemplate
paths:
  /pav2/open-api-provider-schedule-templates:
    post:
      tags:
      - ProviderScheduleTemplate
      summary: Asynchronously retrieves {OpenApiProviderScheduleTemplateController.ProviderSche…
      operationId: ProviderScheduleTemplateGet
      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 provider schedule templates matching the supplied filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate'
            text/json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate'
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RESTCollectionModelBase_OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate'
        '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: "The request was rejected. One of:\n            Start and end date cannot be empty if IncludeRecurringTemplates = true. - includeRecurringTemplates was set without supplying both startDate and endDate.\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."
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.ProviderScheduleTemplateFilterModel'
          text/json:
            schema:
              $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.ProviderScheduleTemplateFilterModel'
          application/hal+json:
            schema:
              $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.ProviderScheduleTemplateFilterModel'
        description: The filter model.
        required: true
components:
  schemas:
    OpenApiProviderScheduleTemplateController.RepeatingPeriod:
      description: Repeating period lookup returned when embedding "recurringConfiguration.repeatingPeriod". Describes the recurrence cadence (e.g. weekly, monthly).
      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
    OpenApiProviderScheduleTemplateController.ProviderScheduleTemplateFilterModel:
      description: Query parameters for searching provider schedule templates.
      type: object
      properties:
        appointmentTypeIds:
          description: Comma-separated list of AppointmentType identifiers. Defaults to null.
          type: string
        clinicIds:
          description: Comma-separated list of Clinic identifiers. Defaults to null.
          type: string
        endDate:
          format: date-time
          description: The end of the date range filter. Defaults to null.
          type: string
        includeRecurringTemplates:
          description: Filters by flag indicating whether recurring templates should be included. Defaults to false. Start and end date are required if includeRecurringTemplates = true.
          type: boolean
        isDeleted:
          description: 'Filters results by the deleted status flag.

            If null, both deleted and non-deleted entities are returned.'
          type: boolean
        isExcludeDate:
          description: 'Filters results by the exclude-date flag.

            If null, entities are returned regardless of date.'
          type: boolean
        providerIds:
          description: Comma-separated list of provider identifiers to include.
          type: string
        recurringConfigurationIds:
          description: Comma-separated list of recurring configuration identifiers to include.
          type: string
        repeatingPeriodIds:
          description: Comma-separated list of repeating period identifiers to include
          type: string
        startDate:
          format: date-time
          description: Start date of the date range filter.
          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
    OpenApiProviderScheduleTemplateController.RecurringConfiguration:
      description: Defines how a schedule repeats over time (cadence, limits, and optional monthly rules), it describes the recurrence pattern for provider schedule templates
      type: object
      properties:
        customRepeatingInterval:
          format: int32
          description: Custom step size for the recurrence when using a custom period (e.g., every 3 days).
          type: integer
        customRepeatingIntervalUnitId:
          format: uuid
          description: Unique identifier representing the custom repeating interval unit.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        endDate:
          format: date-time
          description: The last calendar date an occurrence may happen.
          type: string
        endsAfter:
          format: int32
          description: Ends the recurrence after the specified number of occurrences.
          type: integer
        monthlyAdditionalOption:
          description: Flag indicating whether a monthly-additional option is enabled.
          type: boolean
        repeatingDaysCode:
          format: int32
          description: Encoded representation of days on which recurrence takes place.
          type: integer
        repeatingPeriod:
          $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.RepeatingPeriod'
          description: Represents the frequency or period of repetition for a recurring schedule (e.g., daily, weekly, monthly, yearly).
        repeatingPeriodId:
          format: uuid
          description: Unique identifier for the repeating period entity.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        startDate:
          format: date-time
          description: First date when the recurrence starts.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    RESTCollectionModelBase_OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate:
      type: object
      properties:
        embed:
          type: string
        item:
          type: array
          items:
            $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate'
        page:
          format: int32
          type: integer
        recordsPerPage:
          format: int32
          type: integer
        searchQuery:
          type: string
        sort:
          type: string
        totalRecords:
          format: int32
          type: integer
    OpenApiProviderScheduleTemplateController.ProviderScheduleTemplate:
      description: ProviderScheduleTemplate REST api model.
      type: object
      properties:
        appointmentType:
          $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.AppointmentType'
          description: Detailed information about the appointment type.
        appointmentTypeId:
          format: uuid
          description: Unique identifier of the appointment type associated with this schedule template.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        color:
          description: 'Display color for the schedule template in hex value format (e.g #9E9E9E).'
          type: string
        endDate:
          format: date-time
          description: The calendar date when the schedule template expires or is no longer valid.
          type: string
        endTime:
          description: The time of day (in HH:mm:ss format) when this schedule template ends. Must be later than StartTime within the same day.
          type: string
        providerId:
          format: uuid
          description: Unique identifier of the provider to whom this schedule template belongs.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        recurringConfiguration:
          $ref: '#/components/schemas/OpenApiProviderScheduleTemplateController.RecurringConfiguration'
          description: Represents the recurrence rules that define how this schedule template repeats over time (e.g. daily, weekly, monthly).
        recurringConfigurationId:
          format: uuid
          description: Unique identifier of the recurrence configuration for this schedule.
          type: string
          example: 00000000-0000-0000-0000-000000000000
        startDate:
          format: date-time
          description: The calendar date when the schedule template becomes active.
          type: string
        startTime:
          description: The time of day (in HH:mm:ss format) when this schedule template begins.
          type: string
        visitReason:
          description: A short description of the purpose of this schedule template (e.g. “New patient consultation,” “Follow-up visit,” “Annual physical exam.”).
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string
    OpenApiProviderScheduleTemplateController.AppointmentType:
      description: Appointment type reference returned when embedding "appointmentType" on a provider schedule template.
      type: object
      properties:
        color:
          description: Hexadecimal string representing the color associated with the appointment type (e.g. "#1976d2").
          type: string
        duration:
          format: int32
          description: The default duration (in minutes) of the appointment type.
          type: integer
        isDeleted:
          description: Flag indicating if the appointment type is deleted.
          type: boolean
        name:
          description: The appointment type name.
          type: string
        dateCreated:
          format: date-time
          type: string
        dateUpdated:
          format: date-time
          type: string
        id:
          type: string