---
swagger: '2.0'
info:
  description: GlobalApi is a 3rd party integration hub developed for Vetspace Ltd.
  version: 2.0.0
  title: Vetspace Global Api
  termsOfService: http://vetspace.com/terms.html
  contact:
    name: Vetspace Support
    url: http://support.vetspace.com
    email: support@vetspace.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0
basePath: "/"
tags:
- name: "/v2/global"
  description: global service for global client registrations and proxy lookups
- name: "/v2/clientlink"
  description: clientlink service for access to remote PMS data
- name: "/v2/registrations"
  description: registrations service for client registrations
- name: "/v2/mobile"
  description: mobile service for global client registrations and proxy lookups
- name: "/v2/auth"
  description: authentication service
- name: "/v2/clinical-portal"
  description: clinical portal service
- name: "/v2/managed-bookings"
  description: managed bookings service
- name: smartflow
- name: homedelivery
produces:
- application/json
paths:
  "/v2/global/listCities":
    get:
      tags:
      - "/v2/global"
      summary: Get cities
      description: returns the list of cities example call -/v2/global/listCities/
      operationId: getListCities_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCityTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/captureUserInfo/{groupId}/{uId}":
    post:
      tags:
      - "/v2/global"
      summary: Capture user info
      description: create a user account example call -/v2/global/captureUserInfo/{groupId}/{uId}/
      operationId: postCapture_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseApiContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listRegionsByCountry/{countryId}":
    get:
      tags:
      - "/v2/global"
      summary: Get regions
      description: returns the list of regions by country example call -/v2/global/listRegionsByCountry/1
      operationId: getListRegionsByCountry_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: countryId
        in: path
        description: parameter COUNTRYID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListRegionTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/findSiteByCountry/{countryId}/{data1}":
    get:
      tags:
      - "/v2/global"
      summary: Find site by country
      description: Find a site example call - /v2/global/findSiteByCountry/0/dou/
      operationId: getFindSiteByCountry_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: countryId
        in: path
        description: parameter COUNTRYID
        required: true
        type: integer
        format: int32
      - name: data1
        in: path
        description: parameter DATA1
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListViewFindAsite"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listPMSGroupsByCountry/{countryId}":
    get:
      tags:
      - "/v2/global"
      summary: List groups by country
      description: Find PMS Group example call - /v2/global/listPMSGroupsByCountry/1/
      operationId: getListPMSGroupByCountry_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: countryId
        in: path
        description: parameter COUNTRYID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListVetGroupTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listCounties/{regionId}":
    get:
      tags:
      - "/v2/global"
      summary: Get counties
      description: returns the list of counties example call -/v2/global/listCounties/1
      operationId: getListCountiesByRegion_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: regionId
        in: path
        description: parameter REGIONID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCountyTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listCountries":
    get:
      tags:
      - "/v2/global"
      summary: Get countries
      description: returns the list of countries example call -/v2/global/listCountries/
      operationId: getListCountries_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCountryTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/updatePMSPassword/{groupId}/{uId}/{pass}":
    get:
      tags:
      - "/v2/global"
      summary: Update PMS password
      description: Update PMS Password example call - /v2/global/updatePMSPassword/5/10034/password/
      operationId: getUpdatePmsPassword_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: pass
        in: path
        description: parameter PASS
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseContactVetUserTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/connectNewUserToGroup/{groupId}/{uId}":
    get:
      tags:
      - "/v2/global"
      summary: Connect new user to group
      description: Connect New User To Group example call - /v2/global/connectNewUserToGroup/5/25/
      operationId: getConnectNewUserToGroup_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseApiContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/groupCustomisations/{groupId}":
    get:
      tags:
      - "/v2/global"
      summary: Get group customisations
      description: Group Customisations example call - /v2/global/groupCustomisations/1/
      operationId: getGroupCustomisations_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListViewGroupCustomisations"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/createUserAccountWithDetails":
    post:
      tags:
      - "/v2/global"
      summary: Create user account
      description: create a user account example call -/v2/global/createUserAccount/new@user.com
      operationId: postCreateUserAccountWithDetails_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: uName
        in: formData
        description: parameter UNAME
        required: true
        type: string
      - name: firstName
        in: formData
        description: parameter firstName
        required: true
        type: string
      - name: middleName
        in: formData
        description: Parameter middleName
        required: true
        type: string
      - name: surname
        in: formData
        description: Parameter surname
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/createUserAccount":
    post:
      tags:
      - "/v2/global"
      summary: Create user account
      description: create a user account example call -/v2/global/createUserAccount/new@user.com
      operationId: postCreateUserAccount_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: uName
        in: formData
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/changePassword":
    post:
      tags:
      - "/v2/global"
      summary: Change password
      description: "Change Global Password example call - /v2/global/changePassword/abc@1234.com/password/data1/
        \ \nPasswords must be at least 7 characters and contain characters from three
        of the following four categories:  \nEnglish uppercase characters (A through
        Z)  \nEnglish lowercase characters (a through z)  \nBase 10 digits (0 through
        9)  \nNon-alphabetic characters (for example, !, $, #, %)"
      operationId: getChangePassword_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: uName
        in: formData
        description: parameter UNAME
        required: true
        type: string
      - name: pass
        in: formData
        description: parameter PASS
        required: true
        type: string
      - name: data1
        in: formData
        description: parameter DATA1
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listAllActiveGroups":
    get:
      tags:
      - "/v2/global"
      summary: Get active groups
      description: List all of the active vet groups in global example call - /v2/global/listAllActiveGroups/
      operationId: getListAllActiveGroups_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListVetGroupTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/connectUserToPmsGroup/{groupId}/{uId}":
    get:
      tags:
      - "/v2/global"
      summary: Connect user to group
      description: Connect new User To PMS Group example call - /v2/global/connectUserToPmsGroup/5/10034/
      operationId: getConnectUserToPmsGroup_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseApiContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/listSitesByGroup/{groupId}":
    get:
      tags:
      - "/v2/global"
      summary: Get sites
      description: List Sites By Group example call - /v2/global/listSitesByGroup/1/
      operationId: getListSitesByGroup_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListViewSiteByGroup"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/global/vetUserSites/{uName}":
    get:
      tags:
      - "/v2/global"
      summary: Get user sites
      description: Vet User Sites example call - /v2/global/vetUserSites/{uName}/user@domain.co.uk/
      operationId: getVetUserSitesByUsername_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: uName
        in: path
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListApiSiteTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveAppointmentReasons/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: get appointment reasons
      description: get appointment reasons
      operationId: retrieveAppointmentReasons
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentReason"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/getAvailableAppointments/{groupId}/{siteId}/{periodId}/{practitionerId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get available appointments
      description: Get available appointments for a given period at a particular site.
      operationId: getAvailableAppointmentsmobile
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: periodId
        in: path
        description: periodId
        required: true
        type: integer
        format: int32
      - name: practitionerId
        in: path
        description: practitionerId
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentSlot"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveSites/{groupId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get sites
      description: 'get sites - '
      operationId: getSites
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSiteMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveFullList/{groupId}/{time}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get full list
      description: 'get full list - '
      operationId: getFullList
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: time
        in: path
        description: Parameter time
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListDaylistMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/cancelAppointment/{groupId}/{apptId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Cancel an appointment
      description: 'Cancel Appointment call - '
      operationId: cancelAppointmentMobile
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: apptId
        in: path
        description: parameter APPTID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveDiaries/{groupId}/{siteId}/{periodId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get diaries
      description: 'get diaries - '
      operationId: getDiaries
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: periodId
        in: path
        description: parameter PERIODID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentSlot"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveBarCodes/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get barcodes
      description: Bar codes retrieval - /retrieveBarCodes/{groupId}/{siteId}/
      operationId: barCodes
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListBarcodeMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrievePatients/{groupId}":
    post:
      tags:
      - "/v2/mobile"
      summary: Get patients
      description: 'search clients - '
      operationId: getPatients
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListPatientIds"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPatientMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveClients/{groupId}":
    post:
      tags:
      - "/v2/mobile"
      summary: Get clients
      description: 'Get clients - '
      operationId: retrieveClientsMobile
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListClientIds"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListClientMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/clientSearch/{groupId}/{searchTerm}":
    get:
      tags:
      - "/v2/mobile"
      summary: Client search
      description: 'search clients - '
      operationId: clientSearch
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: searchTerm
        in: path
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListClientMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveDefaultNotes/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get default notes
      description: 'get full list since last update - '
      operationId: getDefaultNotes
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListDefaultNoteMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrievePaymentMethods/{groupId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get payment methods
      description: 'search clients - '
      operationId: getPaymentMethods
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPaymentMethodMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/vetUserSites/{uName}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get user sites
      description: 'get sites for user - '
      operationId: vetUserSitesMobile
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: uName
        in: path
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/listAllSitesForGroup/{groupId}":
    get:
      tags:
      - "/v2/mobile"
      summary: List all sites for group
      description: 'get sites for group - '
      operationId: listAllSitesForGroup
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrievePatientReminders/{groupId}/{siteId}":
    post:
      tags:
      - "/v2/mobile"
      summary: "/retrievePatientReminders/{groupId}/{siteId}"
      description: Retrieve patient reminders for a patientId
      operationId: retrievePatientReminders
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListPatientIds"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPatientReminderSetMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveTreatmentCodes/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get treatment codes
      description: 'get treat codes - '
      operationId: getTreatCodes
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseTreatmentCodesInformationMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveTreatmentHistories/{groupId}/{date}":
    post:
      tags:
      - "/v2/mobile"
      summary: Get treatment histories
      description: 'get treat codes - '
      operationId: getTreatHistories
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: date
        in: path
        description: parameter DATE
        required: true
        type: string
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ClientIdMapHolder"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveTreatmentCodeTypes/{groupId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get treatment code types
      description: 'get treat code types - '
      operationId: getTreatCodeTypes
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListTreatCodeTypeMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/uploadTreatmentItems/{groupId}/{siteId}":
    post:
      tags:
      - "/v2/mobile"
      summary: Upload treatment items
      description: 'upload treatment items - '
      operationId: uploadTreatmentItems
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListTreatmentItemMO"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/listAllActiveGroups":
    get:
      tags:
      - "/v2/mobile"
      summary: List all active groups
      description: 'get active groups - '
      operationId: listAllActiveGroups
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/uploadPaymentItems/{groupId}/{siteId}":
    post:
      tags:
      - "/v2/mobile"
      summary: Upload payment items
      description: 'upload payment items - '
      operationId: uploadPaymentItems
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListPaymentItemsMO"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveSurgeons/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get surgeons
      description: 'get surgeons - '
      operationId: getSurgeons
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSurgeonMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveStockLevels/{groupId}/{siteId}/{stockCentreId}/{codeTypeId}":
    get:
      tags:
      - "/v2/mobile"
      summary: "/retrieveStockLevels/{groupId}/{siteId}/{stockCentreId}/{codeTypeId}"
      description: Retrieve a list of stock centres for a stock centreid
      operationId: retrieveStockLevels
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: stockCentreId
        in: path
        description: Parameter stock centre id
        required: true
        type: integer
        format: int32
      - name: codeTypeId
        in: path
        description: The Parameter codeTypeId
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListStockLevelsMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveTreatmentGroups/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get treatment groups
      description: 'get treat groups - '
      operationId: getTreatGroups
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListTreatGroupMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/petWeights/{groupId}/{uId}/{aniId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get pet weights
      description: Pet Weights example call - /petWeights/{groupId}/{uId}/{aniId}/
      operationId: getPetWeights
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/connectUserToPmsGroup/{groupId}/{userId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Connect user to group
      description: 'Connect user to PMS group - '
      operationId: connectUserToPmsGroup
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: userId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveComposites/{groupId}/{stockCentreId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get composites
      description: 'Get list of composite treatments - '
      operationId: getComposites
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: stockCentreId
        in: path
        description: Parameter stockCentreId
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCompositeMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/uploadAppointmentItems/{groupId}/{siteId}":
    post:
      tags:
      - "/v2/mobile"
      summary: Upload appointment items
      description: 'upload appt - '
      operationId: uploadAppointmentItems
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ListAppointment"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAppointmentReport"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveTaxes/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get taxes
      description: 'get taxes - '
      operationId: getTaxes
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListTaxMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/updateAppointmentStatus/{groupId}/{apptId}/{statusId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Start appointment
      description: 'start appt - '
      operationId: startAppointment
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: apptId
        in: path
        description: parameter APPTID
        required: true
        type: integer
        format: int32
      - name: statusId
        in: path
        description: The parameter statusId
        required: true
        type: string
        enum:
        - NOT_STARTED
        - CURRENT
        - STARTED
        - INVOICE_LATER
        - INVOICED
        - PAID
        - CANCELLED
        - SAVED_FOR_LATER
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAppointmentStatusMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/retrieveStockCentres/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/mobile"
      summary: Get stock centres
      description: 'get stock centres - '
      operationId: getStockCentres
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListStockCentreMO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/mobile/uploadDocument/{groupId}/{siteId}/{apptId}/{clientId}/{patientId}/{practitionerId}":
    post:
      tags:
      - "/v2/mobile"
      summary: uploads a video or image
      description: ''
      operationId: uploadTheDocument_1
      consumes:
      - multipart/form-data
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: apptId
        in: path
        description: parameter APPTID
        required: true
        type: integer
        format: int32
      - name: clientId
        in: path
        description: Id of the client
        required: true
        type: integer
        format: int32
      - name: patientId
        in: path
        description: Id of the patient
        required: true
        type: integer
        format: int32
      - name: practitionerId
        in: path
        description: Id of the practitioner
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: file
        in: formData
        description: file
        required: true
        type: file
      responses:
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/auth/login":
    post:
      tags:
      - "/v2/auth"
      summary: Login to service
      description: Verify API credentials and get an API access token
      operationId: login_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAccessToken"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/auth/forgotPassword/{uName}":
    get:
      tags:
      - "/v2/auth"
      summary: forgotPassword
      description: Forgotten Password example call - /v2/auth/forgotPassworduser@domain.co.uk/
      operationId: getForgotPassword_1
      parameters:
      - name: uName
        in: path
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseContactTO"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/auth/verifyUser":
    post:
      tags:
      - "/v2/auth"
      summary: Verify user credentials
      description: Verify user credentials and get a user access token
      operationId: verifyUser_1
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: uName
        in: formData
        description: parameter UNAME
        required: true
        type: string
      - name: pass
        in: formData
        description: parameter PASS
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseUserVerified"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/auth/changePassword":
    post:
      tags:
      - "/v2/auth"
      summary: Change password
      description: 'Change password call - '
      operationId: changePassword
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: uName
        in: formData
        description: parameter UNAME
        required: true
        type: string
      - name: password
        in: formData
        description: parameter PASS
        required: true
        type: string
      - name: data1
        in: formData
        description: parameter DATA1
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/categoriesByGroupId/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get categories
      description: 'Patient categorys for remote db by group example call - '
      operationId: categoriesByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCategoryPatientCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/userBalanceByGlobalId/{groupId}/{uId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get user balance
      description: 'User balance by GLOBAL id for group example call - '
      operationId: userBalanceByGlobalId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseBalanceCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/surgeonAvailForGroup/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get surgeon availabililty
      description: 'Surgeon availability for group example call - '
      operationId: surgeonAvailForGroup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSurgeonCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/avgWaitForSite/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get average wait for site
      description: 'Average wait for site for group example call - '
      operationId: avgWaitForSite
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/surgeonAvailForSite/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get surgeon availability for site
      description: 'Surgeon availability for site by group example call - '
      operationId: surgeonAvailForSite
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/pmsSitesByGroupId/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get sites
      description: PMS sites by group id - these are sites in the remote database
        example call - /clientlink/pmsSitesByGroupId/4/
      operationId: pmsSitesByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSiteCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/pmsSiteDetailsByGroupId/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get site details
      description: PMS site details by group id for local site id - from remote db
        example call - /clientlink/pmsSiteDetailsByGroupId/4/1101/
      operationId: pmsSiteDetailsByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSiteDetailsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/petReminders/{groupId}/{aniId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get pet reminders
      description: Pet Reminders example call - /clientlink/petReminders/4/35//265402/
      operationId: petReminders
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPetRemindersCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/userDetailsByGlobalId/{groupId}/{uId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get user details
      description: 'User details by GLOBAL id  for group example call - '
      operationId: userDetailsByGlobalId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseCustomerCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/avgWaitForAllSites/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get average wait for all sites
      description: 'Average wait for all sites for group example call - '
      operationId: avgWaitForAllSites
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/coloursByGroupIdAndBreedId/{groupId}/{breedId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get colours by breed
      description: colours by group for local breed id example call - /clientlink/coloursByGroupIdAndBreedId/4/35/
      operationId: coloursByGroupIdAndBreedId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: breedId
        in: path
        description: parameter BREEDID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListColourByBreedCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/userDetailsByGlobalName/{groupId}/{uName}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get user details
      description: User details by GLOBAL name for group. An example call is as follows
        - /v2/global/clientlink/userDetailsByGlobalName/4/vetspaceclient@gmail.com/
      operationId: userDetailsByGlobalName
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uName
        in: path
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseCustomerCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/bookedApptsClientLink/{groupId}/{uId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get booked appointments for user
      description: Booked appointments for Global user id for group example call -
        /v2/global/clientlink/bookedApptsForGlobalUserId/4/35/
      operationId: bookedApptsClientLink
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/bookApptForGlobalId/{groupId}/{uId}/{siteId}/{aniId}/{surgeonId}/{reasonId}/{startDt}/{endDt}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get booked appointments for user
      description: Book appointment for Global id for group by Local SiteID example
        call - /clientlink/bookApptForGlobalId/1/3/1101/11122333/123456789/11/2014-02-21-13-00-00/2014-02-21-13-10-00/
      operationId: bookedAppointmentsForGlobalId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: surgeonId
        in: path
        description: parameter SURGEONID
        required: true
        type: string
      - name: reasonId
        in: path
        description: parameter REASONID
        required: true
        type: string
      - name: startDt
        in: path
        description: parameter STARTDT
        required: true
        type: string
      - name: endDt
        in: path
        description: parameter ENDDT
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/genderBySpeciesId/{groupId}/{speciesId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get genders
      description: Genders by group for local species id example call - /clientlink/gendersByGroupId/4/1/
      operationId: gendersByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: speciesId
        in: path
        description: parameter SPECIESID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListGenderBySpeciesCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/petMedications/{groupId}/{uId}/{aniId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get pet medications
      description: Pet Medications example call - /clientlink/petMedications/4/35/265402/
      operationId: petMedications
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPetMedicationsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/vetUserSites/{groupId}/{uName}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get user sites
      description: 'User sites for username - '
      operationId: vetUserSites
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uName
        in: path
        description: parameter UNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSiteCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/availOnlineBookingSlotsForGroupWithoutUser/{groupId}/{siteId}/{periodId}/{surgeonId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get available booking slots
      description: 'The object is to show the user availability before we ask them
        to login or register. '
      operationId: availOnlineBookingSlotsForGroupWithoutUser
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: periodId
        in: path
        description: parameter PERIODID
        required: true
        type: string
      - name: surgeonId
        in: path
        description: parameter SURGEONID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  ? "/v2/clientlink/addNewPetForGroupWithLocalValues/{groupId}/{uId}/{pcatId}/{speciesId}/{breedId}/{colourId}/{genderId}/{data1}/{startDt}"
  : get:
      tags:
      - "/v2/clientlink"
      summary: Add new pet
      description: Add new pet for group with local values, passed GLOBAL user id
        example call - /clientlink/addNewPetForGroupWithLocalValues/4/35/1/35/1/1/1/test/2014-02-21-13-00-00/
      operationId: addNewPetForGroupWithLocalValues
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: pcatId
        in: path
        description: parameter PCATID
        required: true
        type: string
      - name: speciesId
        in: path
        description: parameter SPECIESID
        required: true
        type: string
      - name: breedId
        in: path
        description: parameter BREEDID
        required: true
        type: string
      - name: colourId
        in: path
        description: parameter COLOURID
        required: true
        type: string
      - name: genderId
        in: path
        description: parameter GENDERID
        required: true
        type: string
      - name: data1
        in: path
        description: parameter DATA1
        required: true
        type: string
      - name: startDt
        in: path
        description: parameter STARTDT
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/sitesWithOnlineAvailForGroup/{groupId}/{periodId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get sites with availability
      description: Sites with online availability for group by period example call
        - /clientlink/sitesWithOnlineAvailForGroup/4/1/
      operationId: sitesWithOnlineAvailForGroup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: periodId
        in: path
        description: parameter PERIODID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSiteCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/speciesByGroupIdAndCategoryId/{groupId}/{pcatId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get species by category
      description: Species for remote db by group and local pcategoryid example call
        - /clientlink/speciesByGroupIdAndCategoryId/4/1/
      operationId: speciesByGroupIdAndCategoryId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: pcatId
        in: path
        description: parameter PCATID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListBreedsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/titlesByGroupId/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get titles
      description: Titles in remote db by group id example call - /clientlink/titlesByGroupId/4/
      operationId: titlesByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListTitlesCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/townsByGroupId/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get towns
      description: Towns in remote db by groupId example call - /clientlink/townsByGroupId/4/
      operationId: townsByGroupId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/petsListByGlobalId/{groupId}/{uId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get pet list
      description: 'Pets list by GLOBAL Id for group example call - '
      operationId: petsListByGlobalId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPetsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/postcodeLookup/{groupId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Postcode lookup
      description: Post code lookup example call - /clientlink/postcodeLookup/4/IM11AP/28/
      operationId: postcodeLookup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: postCode
        in: header
        description: parameter POSTCODE
        required: true
        type: string
      - name: numName
        in: header
        description: parameter NUMNAME
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAddressListCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/petDetailsByGlobalId/{groupId}/{uId}/{aniId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get pet details
      description: Pet Details by Global UserId for group by LOCAL ani Id example
        call - /clientlink/petDetailsByGlobalId/4/35/265402/
      operationId: petDetailsByGlobalId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponsePetsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/petWeights/{groupId}/{aniId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get pet weights
      description: Pet Weights example call - /clientlink/petWeights/4/35/265402/
      operationId: petWeights
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: aniId
        in: path
        description: parameter ANIID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListWeightsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/cancelBookingForLocalBookingId/{groupId}/{apptId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Cancel appointment
      description: Cancel booking for local booking id by Group example call - /clientlink/cancelBookingForLocalBookingId/4/11111/
      operationId: cancelBookingForLocalBookingId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: apptId
        in: path
        description: parameter APPTID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/surgeonsWithOnlineAvailForGroup/{groupId}/{siteId}/{periodId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get surgeons with availability
      description: Surgeons with online availability for group by local site id and
        period example call - /clientlink/surgeonsWithOnlineAvailForGroup/4/1101/1/
      operationId: surgeonsWithOnlineAvailForGroup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: periodId
        in: path
        description: parameter PERIODID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/availOnlineBookingSlotsForGroup/{groupId}/{uId}/{siteId}/{periodId}/{surgeonId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get available booking slots
      description: Online available appointment slots for Group by local site id,
        period and local surgon id passing global client id example call - /clientlink/availOnlineBookingSlotsForGroup/4/35/1101/1/0/
      operationId: availOnlineBookingSlotsForGroup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: uId
        in: path
        description: parameter UID
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: periodId
        in: path
        description: parameter PERIODID
        required: true
        type: string
      - name: surgeonId
        in: path
        description: parameter SURGEONID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiUserToken
        in: header
        description: ApiUserToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseList"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/onlineBookingReasonsForGroup/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get online booking reasons
      description: 'Online booking reasons for local siteid by group example call
        - '
      operationId: onlineBookingReasonsForGroup
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentDetailsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clientlink/breedsByGroupIdAndSpeciesId/{groupId}/{speciesId}":
    get:
      tags:
      - "/v2/clientlink"
      summary: Get breeds by species
      description: breeds by group for local species id example call - /clientlink/breedsByGroupIdAndSpeciesId/4/1/
      operationId: breedsByGroupIdAndSpeciesId
      parameters:
      - name: ApiAccount
        in: header
        description: Parameter Account
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: speciesId
        in: path
        description: parameter SPECIESID
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListBreedsCL"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getAppointments/{groupId}/{siteId}/{startTime}/{endTime}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get appointments in date range
      description: Get appointments in date range
      operationId: cp_getAppointments
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: startTime
        in: path
        description: Start time of range
        required: true
        type: string
        format: date-time
      - name: endTime
        in: path
        description: End time of range
        required: true
        type: string
        format: date-time
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointment"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getSites/{groupId}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get the list of sites
      description: Get the list of sites
      operationId: cp_getSites
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSite"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getPatient/{groupId}/{patientId}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get patient by id
      description: Get patient by id
      operationId: getPatient_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: patientId
        in: path
        description: Id of the patient
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponsePatient"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getReminders/{groupId}/{siteId}/{startTime}/{endTime}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get reminders in date range
      description: Get reminders in date range
      operationId: getReminders_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: startTime
        in: path
        description: Start time of range
        required: true
        type: string
        format: date-time
      - name: endTime
        in: path
        description: End time of range
        required: true
        type: string
        format: date-time
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListReminder"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getClient/{groupId}/{clientId}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get client by id
      description: Get client by id
      operationId: getClient_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: clientId
        in: path
        description: Id of the client
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseClient"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/createClinicalNote/{groupId}":
    post:
      tags:
      - "/v2/clinical-portal"
      summary: Create a clinical note
      description: Create a clinical note
      operationId: createClinicalNote_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/ClinicalNoteParameters"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponse"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/clinical-portal/getPatientReminders/{groupId}/{patientId}":
    get:
      tags:
      - "/v2/clinical-portal"
      summary: Get reminders for patient
      description: Get reminders for patient
      operationId: getPatientReminders_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: patientId
        in: path
        description: Id of the patient
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListReminder"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getAppointmentReasons/{groupId}/{siteId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Get appointment reasons
      description: Get a list of appointment reasons for a given site
      operationId: getAppointmentReasons_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentReason"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getAppointments/{groupId}/{clientId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Get appointments for client
      description: Get a list of appointments for a given client
      operationId: getAppointments_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: clientId
        in: path
        description: Id of the client
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointment"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/cancelAppointment/{groupId}/{appointmentId}":
    post:
      tags:
      - "/v2/managed-bookings"
      summary: Cancel an appointment
      description: Cancel an appointment
      operationId: cancelAppointment_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: appointmentId
        in: path
        description: Id of the appointment
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAppointment"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/bookAppointment/{groupId}":
    post:
      tags:
      - "/v2/managed-bookings"
      summary: Book an appointment
      description: Book an appointment
      operationId: bookAppointment_1
      consumes:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - in: body
        name: body
        description: Appointment details
        required: true
        schema:
          "$ref": "#/definitions/AppointmentParameters"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAppointment"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/updateAppointment/{groupId}/{appointmentId}":
    post:
      tags:
      - "/v2/managed-bookings"
      summary: Update and appointment
      description: Update an appointment
      operationId: updateAppointment_1
      consumes:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: appointmentId
        in: path
        description: Id of the appointment
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        description: Appointment details
        required: true
        schema:
          "$ref": "#/definitions/AppointmentParameters"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseAppointment"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getAvailableAppointments/{groupId}/{siteId}/{periodId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Get available appointment slots
      description: Get available appointments for a given period at a particular site
      operationId: getAvailableAppointments_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: Id of the site
        required: true
        type: integer
        format: int32
      - name: periodId
        in: path
        description: periodId
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListAppointmentSlot"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getPets/{groupId}/{clientId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Get pets for client
      description: Get a list of pets for a given client
      operationId: getPets_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: clientId
        in: path
        description: Id of the client
        required: true
        type: integer
        format: int32
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListPet"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getClients/{groupId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Search clients
      description: Get a filtered list of clients
      operationId: getClients_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      - name: surname
        in: query
        description: Surname to search for
        required: false
        type: string
      - name: firstName
        in: query
        description: First name to search for
        required: false
        type: string
      - name: petName
        in: query
        description: Pet name to search for
        required: false
        type: string
      - name: addressNameNumber
        in: query
        description: Address name or number to search for
        required: false
        type: string
      - name: addressLine1
        in: query
        description: First line of the address to search for
        required: false
        type: string
      - name: city
        in: query
        description: City to search for
        required: false
        type: string
      - name: postalCode
        in: query
        description: Postal code to search for
        required: false
        type: string
      - name: phoneNumber
        in: query
        description: Phone number to search for
        required: false
        type: string
      - name: emailAddress
        in: query
        description: Email address to search for
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListClient"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/managed-bookings/getSites/{groupId}":
    get:
      tags:
      - "/v2/managed-bookings"
      summary: Get sites
      description: Get a list of sites
      operationId: getSites_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSite"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/registrations/pmsSitesByGroup/{groupId}":
    get:
      tags:
      - "/v2/registrations"
      summary: Get list of sites
      description: 'returns the list of sites for group: example call -/v2/registrations/pmsSitesByGroup/{groupId}/'
      operationId: getPmsSitesByGroupIdRegistrations_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListSite"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/registrations/titlesByGroup/{groupId}":
    get:
      tags:
      - "/v2/registrations"
      summary: Get list of titles
      description: 'returns the list of titles: example call -/v2/registrations/titlesByGroup/{groupId}/'
      operationId: getTitlesByGroupIdRegistrations_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListTitle"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/registrations/isClientRegistered/{groupId}":
    get:
      tags:
      - "/v2/registrations"
      summary: Check if client is registered
      description: Checks if a client is already registered
      operationId: isClientRegistered_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: emailAddress
        in: query
        description: Email address to search for
        required: true
        type: string
      - name: phoneNumber
        in: query
        description: Phone number to search for
        required: true
        type: string
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseBoolean"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/registrations/postCapture/{groupId}/{siteId}":
    post:
      tags:
      - "/v2/registrations"
      summary: Register client
      description: create a user account example call -/v2/registrations/postCapture/{groupId}/{siteId}/
      operationId: postCaptureRegistrations_1
      consumes:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: siteId
        in: path
        description: parameter SITEID
        required: true
        type: integer
        format: int32
      - in: body
        name: body
        required: false
        schema:
          "$ref": "#/definitions/RegistrationsUserDetails"
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseClient"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
  "/v2/registrations/listCities/{groupId}":
    get:
      tags:
      - "/v2/registrations"
      summary: Get list of cities
      description: returns the list of cities example call -/v2/registrations/listCities/{groupId}//
      operationId: getListCitiesRegistrations_1
      parameters:
      - name: groupId
        in: path
        description: parameter GROUP
        required: true
        type: integer
        format: int64
      - name: ApiToken
        in: header
        description: ApiToken
        required: true
        type: string
      - name: ApiAccount
        in: header
        description: Consumer Account guid as supplied
        required: true
        type: string
      - name: ApiKey
        in: header
        description: Consumer Key guid as supplied
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            "$ref": "#/definitions/ApiResponseListCity"
        '400':
          description: The Request failed
          schema:
            "$ref": "#/definitions/ApiFailure"
        '401':
          description: Authentication required
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '403':
          description: No Permission To Access Resource
          schema:
            "$ref": "#/definitions/ApiAccessError"
        '500':
          description: Application Error - invalid call
          schema:
            "$ref": "#/definitions/ApiError"
definitions:
  ApiResponseGroup:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/VetGroupTO"
  VetGroupTO:
    type: object
    required:
    - countryId
    - description
    - name
    properties:
      countryId:
        type: integer
        format: int32
        minimum: 1
      description:
        type: string
      disabled:
        type: boolean
        readOnly: true
      groupId:
        type: integer
        format: int64
        readOnly: true
      name:
        type: string
  ApiFailure:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiError, ApiFailure
          or ApiAccessError
      code:
        type: integer
        format: int32
        description: The error code as recieved by the API
      message:
        type: string
        description: The error message as received by the API
      fields:
        type: string
  ApiAccessError:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiError, ApiFailure
          or ApiAccessError
      code:
        type: integer
        format: int32
        description: The error code as recieved by the API
      message:
        type: string
        description: The error message as received by the API
      fields:
        type: string
  ApiError:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiError, ApiFailure
          or ApiAccessError
      code:
        type: integer
        format: int32
        description: The error code as received by the API
      message:
        type: string
        description: The message as received by the API
      rawResponse:
        type: string
        description: The raw response as received by the API
      fields:
        type: string
  ApiConsumers:
    type: object
    properties:
      accountGuid:
        type: string
      consumerId:
        type: integer
        format: int32
      description:
        type: string
      createdDate:
        type: string
        format: date-time
      modifiedDate:
        type: string
        format: date-time
      bdisabled:
        type: boolean
      bexternal:
        type: boolean
  ApiResponseListConsumer:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ApiConsumers"
  ApiResponseListUploadedMobileDocuments:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/UploadedMobileDocuments"
  UploadedMobileDocuments:
    type: object
    properties:
      id:
        type: integer
        format: int64
      groupId:
        type: integer
        format: int32
      siteId:
        type: integer
        format: int32
      appointmentId:
        type: integer
        format: int32
      clientId:
        type: integer
        format: int32
      patientId:
        type: integer
        format: int32
      surgeonId:
        type: integer
        format: int32
      documentLocation:
        type: string
      processed:
        type: integer
        format: int32
      addedTime:
        type: integer
        format: int32
      processedTime:
        type: integer
        format: int32
  ApiResponseConsumer:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/ApiConsumers"
  NewConsumerAccount:
    type: object
    required:
    - description
    properties:
      description:
        type: string
  ApiResponse:
    type: object
  ApiResponseListCityTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/CityTO"
  CityTO:
    type: object
    properties:
      cityId:
        type: integer
        format: int32
      description:
        type: string
      name:
        type: string
  ApiContactTO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      title:
        type: string
      surname:
        type: string
      firstName:
        type: string
      middlename:
        type: string
      numberName:
        type: string
      address1:
        type: string
      address2:
        type: string
      city:
        type: string
      county:
        type: string
      postCode:
        type: string
      country:
        type: string
      homePhone:
        type: string
      mobilePhone:
        type: string
  ApiResponseApiContactTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/ApiContactTO"
  ApiResponseListRegionTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/RegionTO"
  RegionTO:
    type: object
    properties:
      countryId:
        type: integer
        format: int32
      description:
        type: string
      name:
        type: string
      regionId:
        type: integer
        format: int32
  ApiResponseListViewFindAsite:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ViewFindAsite"
  ViewFindAsite:
    type: object
    properties:
      id:
        type: integer
        format: int32
      groupId:
        type: integer
        format: int64
      groupDesc:
        type: string
      practiceName:
        type: string
      numberName:
        type: string
      address1:
        type: string
      address2:
        type: string
      cityDesc:
        type: string
      countyName:
        type: string
      regionDesc:
        type: string
      postCode:
        type: string
      countryDesc:
        type: string
      countryId:
        type: integer
        format: int32
  ApiResponseListVetGroupTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/VetGroupTO"
  ApiResponseListCountyTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/CountyTO"
  CountyTO:
    type: object
    properties:
      countyID:
        type: integer
        format: int32
      name:
        type: string
      regionId:
        type: integer
        format: int32
  ApiResponseListCountryTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/CountryTO"
  CountryTO:
    type: object
    properties:
      countryId:
        type: integer
        format: int32
      description:
        type: string
      name:
        type: string
      viewOrder:
        type: integer
        format: int32
  ApiResponseContactVetUserTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/ContactVetUserTO"
  ContactVetUserTO:
    type: object
    properties:
      contactId:
        type: integer
        format: int64
      contactVetUserId:
        type: integer
        format: int64
      disabled:
        type: boolean
      groupId:
        type: integer
        format: int64
      modified:
        type: string
        format: date-time
      valid:
        type: boolean
  ApiResponseListViewGroupCustomisations:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ViewGroupCustomisations"
  ViewGroupCustomisations:
    type: object
    properties:
      id:
        type: integer
        format: int64
      groupId:
        type: integer
        format: int64
      description:
        type: string
      customisationTypeDesc:
        type: string
      value:
        type: string
  ApiResponseContactTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/ContactTO"
  ContactTO:
    type: object
    properties:
      contactID:
        type: integer
        format: int64
      createdOn:
        type: integer
        format: int64
      firstname:
        type: string
      middlename:
        type: string
      registerDate:
        type: integer
        format: int64
      surname:
        type: string
      username:
        type: string
  ApiResponseListViewSiteByGroup:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ViewSiteByGroup"
  ViewSiteByGroup:
    type: object
    properties:
      id:
        type: integer
        format: int32
      groupId:
        type: integer
        format: int64
      countryId:
        type: integer
        format: int32
      groupName:
        type: string
      groupDescription:
        type: string
      disabled:
        type: boolean
      siteName:
        type: string
      practiceName:
        type: string
      addressId:
        type: integer
        format: int64
      isMainSite:
        type: boolean
      emailAddress:
        type: string
      webSite:
        type: string
      phone:
        type: string
      fax:
        type: string
      vatNo:
        type: string
  ApiResponseListApiSiteTO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ApiSiteTO"
  ApiSiteTO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      practiceName:
        type: string
      nameNo:
        type: string
      address1:
        type: string
      address2:
        type: string
      city:
        type: string
      county:
        type: string
      postCode:
        type: string
      emailAddress:
        type: string
      webSite:
        type: string
      phone:
        type: string
      fax:
        type: string
      vetNo:
        type: string
      mainSite:
        type: boolean
      defaultSite:
        type: boolean
  ApiResponseListAppointmentReason:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/AppointmentReason"
  AppointmentReason:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      description:
        type: string
  ApiResponseListAppointmentSlot:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/AppointmentSlot"
  AppointmentSlot:
    type: object
    properties:
      startTime:
        type: string
      duration:
        type: integer
        format: int32
      practitionerId:
        type: integer
        format: int32
      practitioner:
        type: string
  ApiResponseListSiteMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/SiteMO"
    xml:
      name: ApiResponseListSiteMO
  SiteMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      numberName:
        type: string
      address1:
        type: string
      address2:
        type: string
      address3:
        type: string
      city:
        type: string
      postCode:
        type: string
      practiceName:
        type: string
      phone:
        type: string
      emailAddress:
        type: string
    xml:
      name: SiteMO
  ApiResponseListDaylistMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/DaylistMO"
    xml:
      name: ApiResponseListDaylistMO
  DaylistMO:
    type: object
    properties:
      appointmentTime:
        type: integer
        format: int64
      patient:
        type: string
      breed:
        type: string
      patientId:
        type: integer
        format: int32
      clientId:
        type: integer
        format: int32
      site:
        type: string
      client:
        type: string
      location:
        type: string
      surgeonId:
        type: integer
        format: int32
      practitioner:
        type: string
      id:
        type: integer
        format: int32
      appointmentLength:
        type: integer
        format: int32
      note:
        type: string
      siteId:
        type: integer
        format: int32
      reasonId:
        type: integer
        format: int32
      reason:
        type: string
      modifiedTime:
        type: string
        format: date-time
    xml:
      name: DaylistMO
  ApiResponseListBarcodeMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/BarcodeMO"
    xml:
      name: ApiResponseListBarcodeMO
  BarcodeMO:
    type: object
    properties:
      barcodeId:
        type: integer
        format: int32
      treatmentCodeId:
        type: integer
        format: int32
      barcode:
        type: string
    xml:
      name: BarcodeMO
  ApiResponseListPatientMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/PatientMO"
    xml:
      name: ApiResponseListPatientMO
  InsuranceCompanyMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      description:
        type: string
      regNumber:
        type: string
      vatNumber:
        type: string
      website:
        type: string
  PatientMO:
    type: object
    properties:
      category:
        type: string
      name:
        type: string
      weight:
        type: string
      dob:
        type: integer
        format: int64
      gender:
        type: string
      colour:
        type: string
      breed:
        type: string
      species:
        type: string
      contactId:
        type: integer
        format: int32
      id:
        type: integer
        format: int32
      nameNo:
        type: string
      address1:
        type: string
      city:
        type: string
      postCode:
        type: string
      chipNumber:
        type: string
      insuranceCompany:
        "$ref": "#/definitions/InsuranceCompanyMO"
      hasRecallDate:
        type: boolean
      allergies:
        type: string
      recalls:
        type: array
        items:
          "$ref": "#/definitions/PatientRecallMO"
      note1:
        type: string
      note2:
        type: string
      notes:
        type: string
    xml:
      name: PatientMO
  PatientRecallMO:
    type: object
    properties:
      typeName:
        type: string
      lvDate:
        type: integer
        format: int64
      cvDate:
        type: integer
        format: int64
      animalId:
        type: integer
        format: int32
      active:
        type: boolean
      workSite:
        type: string
      clientSite:
        type: string
      reference:
        type: integer
        format: int32
      viewOrder:
        type: integer
        format: int32
      contactId:
        type: integer
        format: int32
      treatmentItemId:
        type: integer
        format: int32
      codeId:
        type: integer
        format: int32
      recallTypeId:
        type: integer
        format: int32
      recallLength:
        type: integer
        format: int32
      recallPeriod:
        type: integer
        format: int32
      description:
        type: string
  ListPatientIds:
    type: object
    properties:
      items:
        type: array
        items:
          type: integer
          format: int32
  ApiResponseListClientMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/ClientMO"
    xml:
      name: ApiResponseListClientMO
  ClientMO:
    type: object
    properties:
      surname:
        type: string
      firstname:
        type: string
      title:
        type: string
      mobile:
        type: string
      nameNo:
        type: string
      address1:
        type: string
      city:
        type: string
      postCode:
        type: string
      homeTel:
        type: string
      balance:
        type: string
      id:
        type: integer
        format: int32
      milesFromPractice:
        type: number
        format: double
    xml:
      name: ClientMO
  ListClientIds:
    type: object
    properties:
      items:
        type: array
        items:
          type: integer
          format: int32
  ApiResponseListDefaultNoteMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/DefaultNoteMO"
    xml:
      name: ApiResponseListDefaultNoteMO
  DefaultNoteMO:
    type: object
    properties:
      noteContent:
        type: string
      siteId:
        type: integer
        format: int32
      noteId:
        type: integer
        format: int32
      listCodes:
        type: array
        items:
          type: integer
          format: int32
          xml:
            name: listCodes
    xml:
      name: DefaultNoteMO
  ApiResponseListPaymentMethodMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/PaymentMethodMO"
    xml:
      name: ApiResponseListPaymentMethodMO
  PaymentMethodMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
    xml:
      name: PaymentMethodMO
  ApiResponseList:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiError, ApiFailure
          or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          type: object
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  ApiResponseListPatientReminderSetMO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/PatientReminderSetMO"
  PatientReminderSetMO:
    type: object
    properties:
      patientId:
        type: integer
        format: int32
      reminders:
        type: array
        items:
          "$ref": "#/definitions/Reminder"
  Reminder:
    type: object
    properties:
      id:
        type: integer
        format: int32
      patientId:
        type: integer
        format: int32
      type:
        type: string
      description:
        type: string
      active:
        type: boolean
      time:
        type: string
        format: date-time
  ApiResponseTreatmentCodesInformationMO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/TreatmentCodesInformationMO"
  BatchMO:
    type: object
    properties:
      batchId:
        type: integer
        format: int32
      batchCode:
        type: string
      expiryDate:
        type: integer
        format: int64
      code:
        type: string
  TreatCodeMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      typeId:
        type: integer
        format: int32
      typeName:
        type: string
      description:
        type: string
      code:
        type: string
      net:
        type: number
        format: double
      vat:
        type: number
        format: double
      price:
        type: number
        format: double
      dispensingFee:
        type: number
        format: double
      stockItem:
        type: boolean
      external:
        type: boolean
      labelRequired:
        type: boolean
      batchRequired:
        type: boolean
      setAttachDoc:
        type: boolean
      linkQtyTo:
        type: boolean
      chip:
        type: boolean
      calcQty:
        type: boolean
      sellAsWholePack:
        type: boolean
      additionalNote:
        type: string
      flag:
        type: integer
        format: int32
      batches:
        type: array
        items:
          "$ref": "#/definitions/BatchMO"
      requiresConsent:
        type: boolean
      productAlert:
        type: string
      multiDispFee:
        type: boolean
    xml:
      name: TreatCodeMO
  TreatmentCodesInformationMO:
    type: object
    properties:
      treatmentCodes:
        type: array
        items:
          "$ref": "#/definitions/TreatCodeMO"
      isSuccess:
        type: boolean
  ClientIdMap:
    type: object
    properties:
      client:
        type: integer
        format: int32
      patientId:
        type: integer
        format: int32
  ClientIdMapHolder:
    type: object
    properties:
      items:
        type: array
        items:
          "$ref": "#/definitions/ClientIdMap"
  ApiResponseListTreatCodeTypeMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/TreatCodeTypeMO"
    xml:
      name: ApiResponseListTreatCodeTypeMO
  TreatCodeTypeMO:
    type: object
    properties:
      viewOrder:
        type: integer
        format: int32
      shortName:
        type: string
      id:
        type: integer
        format: int32
    xml:
      name: TreatCodeTypeMO
  ListTreatmentItemMO:
    type: object
    properties:
      items:
        type: array
        items:
          "$ref": "#/definitions/TreatmentItemMO"
  TreatmentItemMO:
    type: object
    properties:
      itemDate:
        type: integer
        format: int64
      code:
        type: string
      practitioner:
        type: string
      appointmentId:
        type: integer
        format: int32
      weight:
        type: number
        format: float
      image:
        type: string
      taxId:
        type: integer
        format: int32
      preInvoice:
        type: boolean
      contactId:
        type: integer
        format: int32
      microChipId:
        type: string
      practitionerId:
        type: integer
        format: int32
      total:
        type: number
        format: double
      isStockItem:
        type: boolean
      id:
        type: integer
        format: int32
      description:
        type: string
      treatType:
        type: string
      patientId:
        type: integer
        format: int32
      groupId:
        type: integer
        format: int32
      batchId:
        type: integer
        format: int64
      codeTypeId:
        type: integer
        format: int32
      codeId:
        type: integer
        format: int32
      codeType:
        type: string
      net:
        type: number
        format: double
      isArchive:
        type: boolean
      docket:
        type: string
      stockCentreId:
        type: integer
        format: int32
      vat:
        type: number
        format: double
      quantity:
        type: number
        format: double
      productAlert:
        type: string
    xml:
      name: TreatmentItemMO
  ListPaymentItemsMO:
    type: object
    properties:
      items:
        type: array
        items:
          "$ref": "#/definitions/PaymentItemMO"
  PaymentItemMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      contactId:
        type: integer
        format: int32
      total:
        type: string
      itemDate:
        type: integer
        format: int64
      methodId:
        type: integer
        format: int32
      description:
        type: string
      initials:
        type: string
      appointmentId:
        type: integer
        format: int32
      categoryId:
        type: integer
        format: int32
      treatmentId:
        type: integer
        format: int32
      siteId:
        type: integer
        format: int32
  ApiResponseListSurgeonMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/SurgeonMO"
    xml:
      name: ApiResponseListSurgeonMO
  SurgeonMO:
    type: object
    properties:
      viewOrder:
        type: integer
        format: int32
      mobileNumber:
        type: string
      surname:
        type: string
      id:
        type: integer
        format: int32
      firstname:
        type: string
      qualificationId:
        type: integer
        format: int32
      qualificationName:
        type: string
    xml:
      name: SurgeonMO
  ApiResponseListStockLevelsMO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/StockLevelsMO"
  StockLevelsMO:
    type: object
    properties:
      code:
        type: string
        xml:
          name: treatmentName
      codeId:
        type: integer
        format: int32
        xml:
          name: treatmentCodeId
      stockCentre:
        type: string
        xml:
          name: stockCentreName
      actualStockLevel:
        type: number
        format: double
  ApiResponseListTreatGroupMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/TreatGroupMO"
    xml:
      name: ApiResponseListTreatGroupMO
  TreatGroupMO:
    type: object
    properties:
      id:
        type: integer
        format: int32
      description:
        type: string
    xml:
      name: TreatGroupMO
  ApiResponseListCompositeMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/CompositeMO"
    xml:
      name: ApiResponseListCompositeMO
  CompositeMO:
    type: object
    properties:
      parentCodeId:
        type: integer
        format: int32
      codeId:
        type: integer
        format: int32
      quantity:
        type: number
        format: double
      flag:
        type: integer
        format: int32
      compositeId:
        type: integer
        format: int32
      typeFlag:
        type: boolean
      description:
        type: string
      siteId:
        type: integer
        format: int32
      viewOrder:
        type: integer
        format: int32
      codeFlag:
        type: integer
        format: int32
      noCharge:
        type: boolean
      mandatoryItem:
        type: boolean
      optIn:
        type: boolean
      checkInheritedItem:
        type: boolean
      inheritedItem:
        type: boolean
      sellItem:
        type: boolean
    xml:
      name: CompositeMO
  ApiResponseAppointmentReport:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/AppointmentReport"
  Appointment:
    type: object
    properties:
      id:
        type: integer
        format: int32
      startTime:
        type: string
      endTime:
        type: string
      client:
        type: string
      clientId:
        type: integer
        format: int32
      patient:
        type: string
      patientId:
        type: integer
        format: int32
      practitioner:
        type: string
      practitionerId:
        type: integer
        format: int32
      siteName:
        type: string
      siteId:
        type: integer
        format: int32
      reason:
        type: string
      reasonId:
        type: integer
        format: int32
  AppointmentReport:
    type: object
    properties:
      list:
        type: array
        items:
          "$ref": "#/definitions/Appointment"
      failedList:
        type: object
        additionalProperties:
          type: string
      success:
        type: boolean
  AppointmentParameters:
    type: object
    required:
    - clientId
    - endTime
    - patientId
    - practitionerId
    - reasonId
    - siteId
    - startTime
    properties:
      siteId:
        type: integer
        format: int32
        minimum: 1
      practitionerId:
        type: integer
        format: int32
        minimum: 1
      clientId:
        type: integer
        format: int32
        minimum: 1
      patientId:
        type: integer
        format: int32
        minimum: 1
      reasonId:
        type: integer
        format: int32
        minimum: 1
      startTime:
        type: string
        format: date-time
      endTime:
        type: string
        format: date-time
      note:
        type: string
      reason:
        type: string
  ListAppointment:
    type: object
    properties:
      items:
        type: array
        items:
          "$ref": "#/definitions/AppointmentParameters"
  ApiResponseListTaxMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/TaxMO"
    xml:
      name: ApiResponseListTaxMO
  TaxMO:
    type: object
    properties:
      rate:
        type: string
      id:
        type: integer
        format: int32
      name:
        type: string
    xml:
      name: TaxMO
  ApiResponseAppointmentStatusMO:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/AppointmentStatusMO"
  AppointmentStatusMO:
    type: object
    properties:
      appointmentId:
        type: integer
        format: int32
      success:
        type: boolean
  ApiResponseListStockCentreMO:
    type: object
    properties:
      responseType:
        type: string
      responseText:
        type: string
      uuid:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          xml:
            name: responseList
          "$ref": "#/definitions/StockCentreMO"
    xml:
      name: ApiResponseListStockCentreMO
  StockCentreMO:
    type: object
    properties:
      isMain:
        type: boolean
      id:
        type: string
      name:
        type: string
    xml:
      name: StockCentreMO
  ApiResponseHealthCheck:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/HealthCheck"
  HealthCheck:
    type: object
    properties:
      healthy:
        type: boolean
      version:
        type: string
  AccessToken:
    type: object
    properties:
      accessToken:
        type: string
  ApiResponseAccessToken:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/AccessToken"
  ApiResponseUserVerified:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/UserDetailsToken"
  UserDetailsToken:
    type: object
    properties:
      userToken:
        type: string
      userDetails:
        "$ref": "#/definitions/login"
  ViewContactPetOwnerGroups:
    type: object
    properties:
      id:
        type: integer
        format: int64
      contactId:
        type: integer
        format: int64
      username:
        type: string
      password:
        type: string
      defaultPetOwnerGroupId:
        type: integer
        format: int64
      poValid:
        type: boolean
      poDisabled:
        type: boolean
      poModifed:
        type: string
        format: date-time
      localContactId:
        type: integer
        format: int64
      poGroupDesc:
        type: string
      poGroupDs:
        type: string
      poGroupApiKey:
        type: string
      poGroupDisabled:
        type: boolean
      petOwnerId:
        type: integer
        format: int64
  login:
    type: object
    properties:
      createdOn:
        type: integer
        format: int64
      deletedOn:
        type: integer
        format: int64
      firstname:
        type: string
      gender:
        type: string
      password:
        type: string
      registerDate:
        type: integer
        format: int64
      surname:
        type: string
      title:
        type: string
      username:
        type: string
      VUDisabled:
        type: boolean
      VUGroupApiKey:
        type: string
      VUGroup:
        type: string
      VUGroupDisabled:
        type: boolean
      VUGroupDS:
        type: string
      VUPMSDataSource:
        type: string
      VUPMSKey:
        type: string
      VUPMSPass:
        type: string
      VUPMSPrefSite:
        type: integer
        format: int32
      VUPMSUser:
        type: string
      vupmspass:
        type: string
      vuvalid:
        type: boolean
      vugroupId:
        type: integer
        format: int64
      vudisabled:
        type: boolean
      vugroupDS:
        type: string
      vupmsuser:
        type: string
      vugroup:
        type: string
      vupmskey:
        type: string
      vupmsdataSource:
        type: string
      vupmsprefSite:
        type: integer
        format: int32
      vugroupDisabled:
        type: boolean
      vugroupApiKey:
        type: string
      contactId:
        type: integer
        format: int64
      defaultGroupIdForOwner:
        type: integer
        format: int64
      modifiedDate:
        type: integer
        format: int64
      surgeonGroupId:
        type: integer
        format: int64
      isValid:
        type: boolean
      petOwnerGroups:
        type: array
        items:
          "$ref": "#/definitions/ViewContactPetOwnerGroups"
  ApiResponseListCategoryPatientCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/CategoryPatientCL"
  CategoryPatientCL:
    type: object
    properties:
      name:
        type: string
      type:
        type: string
      minDonation:
        type: number
        format: double
      colour:
        type: integer
        format: int32
      dateCreated:
        type: integer
        format: int64
      dateModified:
        type: integer
        format: int64
      font:
        type: boolean
      system:
        type: boolean
      showLastFleaInPatientSummary:
        type: boolean
      showOnline:
        type: boolean
      id:
        type: integer
        format: int32
  ApiResponseBalanceCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/BalanceCL"
  BalanceCL:
    type: object
    properties:
      balance:
        type: number
        format: double
      draft:
        type: number
        format: double
      clientId:
        type: integer
        format: int32
  ApiResponseListSurgeonCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/SurgeonCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  SurgeonCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      surgeonId:
        type: integer
        format: int32
        description: Field surgeonId of type int
      surgeonName:
        type: string
        description: Field surgeonName of type String
      siteId:
        type: integer
        format: int32
        description: Field siteId of type int
      siteName:
        type: string
        description: Field siteName of type String
      rotaWeek:
        type: integer
        format: int32
        description: Field rotaWeek of type int
      day:
        type: string
        description: Field day of type String
      startHour:
        type: integer
        format: int32
        description: Field startHour of type int
      startMin:
        type: integer
        format: int32
        description: Field startMin of type int
      endHour:
        type: integer
        format: int32
        description: Field endHour of type int
      endMin:
        type: integer
        format: int32
        description: Field endMin of type int
      apptLengthMins:
        type: integer
        format: int32
        description: Field apptLengthMins of type int
      date:
        type: integer
        format: int64
        description: Field date of type Long
      dateStr:
        type: string
        description: Field dateStr of type String
  ApiResponseListSiteCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/SiteCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  SiteCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      name:
        type: string
        description: Field name of type String
      mainSite:
        type: boolean
        description: Field mainSite of type Boolean
  AddressListCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      nameno:
        type: string
        description: Field nameno of type String
      address1:
        type: string
        description: Field address1 of type String
      address2:
        type: string
        description: Field address2 of type String
      address3:
        type: string
        description: Field address3 of type String
      town:
        type: string
        description: Field town of type String
      postcode:
        type: string
        description: Field postcode of type String
      postCodeArea:
        type: string
        description: Field postCodeArea of type String
  ApiResponseListSiteDetailsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/SiteDetailsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  SiteDetailsCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      practiceName:
        type: string
        description: Field practiceName of type String
      address:
        type: array
        description: Field address of type ArrayList<AddressListCL>
        items:
          "$ref": "#/definitions/AddressListCL"
      defaultClientCategoryId:
        type: integer
        format: int32
        description: Field defaultClientCategoryId of type int
      defaultCodeEntryVatRate:
        type: integer
        format: int32
        description: Field defaultCodeEntryVatRate of type int
      defaultDiscountVatRate:
        type: integer
        format: int32
        description: Field defaultDiscountVatRate of type int
      defaultManualTreatmentVatRate:
        type: integer
        format: int32
        description: Field defaultManualTreatmentVatRate of type int
      defaultSupplierId:
        type: integer
        format: int32
        description: Field defaultSupplierId of type int
      defaultSurchargeVatRate:
        type: integer
        format: int32
        description: Field defaultSurchargeVatRate of type int
      defaultTitleId:
        type: integer
        format: int32
        description: Field defaultTitleId of type int
      dispensingFee:
        type: number
        format: double
        description: Field dispensingFee of type Double
      emailAddress:
        type: string
        description: Field emailAddress of type String
      fax:
        type: string
        description: Field fax of type String
      phone:
        type: string
        description: Field phone of type String
      website:
        type: string
        description: Field website of type String
      showOnline:
        type: boolean
        description: Field showOnline of type Boolean
      mainSite:
        type: boolean
        description: Field mainSite of type Boolean
  ApiResponseListPetRemindersCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/PetRemindersCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  PetRemindersCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      lvDate:
        type: integer
        format: int64
        description: Field lvDate of type Long
      cvDate:
        type: integer
        format: int64
        description: Field cvDate of type Long
      animalId:
        type: integer
        format: int32
        description: Field animalId of type int
      clientSite:
        type: string
        description: Field clientSite of type String
      reference:
        type: integer
        format: int32
        description: Field reference of type int
      typeName:
        type: string
        description: Field typeName of type String
      treatmentCodeId:
        type: integer
        format: int32
        description: Field treatmentCodeId of type int
      viewOrder:
        type: integer
        format: int32
        description: Field viewOrder of type int
      contactId:
        type: integer
        format: int32
        description: Field contactId of type int
      recallTypeId:
        type: integer
        format: int32
        description: Field recallTypeId of type int
      recallLength:
        type: integer
        format: int32
        description: Field recallLength of type int
      recallPeriod:
        type: integer
        format: int32
        description: Field recallPeriod of type int
  AccountTypeCL:
    type: object
    properties:
      name:
        type: string
  ApiResponseCustomerCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/CustomerCL"
  CategoryCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      name:
        type: string
        description: Field name of type String
      showLastFleaInPatientSummary:
        type: boolean
        description: Field showLastFleaInPatientSummary of type Boolean
      showOnline:
        type: boolean
        description: Field showOnline of type Boolean
  ClientCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
      title:
        type: string
      surname:
        type: string
      firstname:
        type: string
      nameNo:
        type: string
      address1:
        type: string
      cityId:
        type: integer
        format: int32
        xml:
          name: city
      homeTel:
        type: string
      mobile:
        type: string
      balance:
        type: string
  ClientCategoryCL:
    type: object
    properties:
      clientCategoryId:
        type: integer
        format: int32
      name:
        type: string
      colour:
        type: integer
        format: int32
      patientCategoryid:
        type: integer
        format: int32
      preInvoice:
        type: boolean
      docketRequired:
        type: boolean
      viewOrder:
        type: integer
        format: int32
      showLocationInDiary:
        type: boolean
      showTree:
        type: boolean
      showLocationInDiarySummary:
        type: boolean
      populateYardDetails:
        type: boolean
  CustomerCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
      firstname:
        type: string
      surname:
        type: string
      title:
        "$ref": "#/definitions/TitlesCL"
      lastVisit:
        type: integer
        format: int64
      gender:
        type: string
      hasNote:
        type: boolean
      hasRoom:
        type: boolean
      initials:
        type: string
      jobTitle:
        type: string
      jointAccount:
        type: boolean
      mailingAddressCategory:
        type: integer
        format: int32
      maritalStatus:
        type: string
      middlename:
        type: string
      modifiedDate:
        type: integer
        format: int64
      nickname:
        type: string
      noStatement:
        type: boolean
      noStockItems:
        type: boolean
      note:
        type: string
      phoneBusiness:
        type: string
      phoneFax:
        type: string
      phoneHome:
        type: string
      phoneMobilePersonal:
        type: string
      phoneMobileWork:
        type: string
      phoneMobileRelative:
        type: string
      phoneMobileOther:
        type: string
      photo:
        type: string
      popupNote:
        type: string
      referedById:
        type: integer
        format: int32
      registerDate:
        type: integer
        format: int64
      showIndexInBooking:
        type: boolean
      showSurgeonInBooking:
        type: boolean
      siteRegistered:
        "$ref": "#/definitions/SiteCL"
      specialSurgeon:
        type: boolean
      suffix:
        type: string
      summaryWithInvoice:
        type: boolean
      milesFromPractice:
        type: number
        format: double
      treatDiscount:
        type: number
        format: double
      monthlyDiscount:
        type: number
        format: double
      creditLimit:
        type: number
        format: double
      earlySettlementDiscount:
        type: number
        format: double
      balance:
        type: number
        format: double
      tax:
        "$ref": "#/definitions/TaxCL"
      discountTypeId:
        type: integer
        format: int32
      accountType:
        "$ref": "#/definitions/AccountTypeCL"
      categoryAccountItems:
        type: array
        items:
          "$ref": "#/definitions/CategoryCL"
      monthlySurcharge:
        type: number
        format: double
      hasDocuments:
        type: boolean
      hasCommunication:
        type: boolean
      lastVisitedDate:
        type: integer
        format: int64
      clientCategory:
        "$ref": "#/definitions/ClientCategoryCL"
      getbXPCCRefNo:
        type: string
      getbXPCCValidTo:
        type: integer
        format: int64
      pdsaClient:
        "$ref": "#/definitions/PdsaClientCL"
      clientDetails:
        "$ref": "#/definitions/ClientCL"
      noMobileSelected:
        type: boolean
      noMobilePrivateSelected:
        type: boolean
      noEmailSelected:
        type: boolean
      noEmailPrivateSelected:
        type: boolean
      addressListMap:
        type: object
        additionalProperties:
          "$ref": "#/definitions/AddressListCL"
      registeredDateChanged:
        type: boolean
      disallowOnlineBooking:
        type: boolean
  PdsaClientCL:
    type: object
    properties:
      contactId:
        type: integer
        format: int32
      giftAidDeclaration:
        type: boolean
      giftAidDeclarationDate:
        type: integer
        format: int64
      supporterRefNo:
        type: integer
        format: int64
      clientCategoryId:
        type: integer
        format: int32
      clientCategory:
        type: string
      clientCategoryCode:
        type: string
      applicableSubsidyCategory:
        type: string
      latestDonationTotal:
        type: number
        format: double
      latestDonationDate:
        type: string
        format: date-time
  TaxCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      rate:
        type: number
        format: double
  TitlesCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      name:
        type: string
        description: Field name of type String
      imagePath:
        type: string
        description: Field imagePath of type String
      system:
        type: boolean
        description: Field system of type Boolean
      showOnline:
        type: boolean
        description: Field showOnline of type Boolean
      image:
        type: string
        description: Field image of type String
  ApiResponseListColourByBreedCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/ColourByBreedCL"
  ColourByBreedCL:
    type: object
    properties:
      name:
        type: string
      breedId:
        type: integer
        format: int32
      id:
        type: integer
        format: int32
  ApiResponseListGenderBySpeciesCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/GenderBySpeciesCL"
  GenderBySpeciesCL:
    type: object
    properties:
      nuteGenderId:
        type: integer
        format: int32
      name:
        type: string
      categoryId:
        type: integer
        format: int32
      sex:
        type: string
      speciesId:
        type: integer
        format: int32
      neutered:
        type: boolean
  ApiResponseListPetMedicationsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/PetMedicationsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  PetMedicationsCL:
    type: object
    properties:
      flag:
        type: integer
        format: int32
        description: Field flag of type int
      itemDate:
        type: integer
        format: int64
        description: Field itemDate of type long
      nextPrescriptionDate:
        type: integer
        format: int64
        description: Field nextPrescriptionDate of type long
      parentID:
        type: integer
        format: int32
        description: Field parentID of type int
      patient:
        type: string
        description: Field patient of type String
      patientID:
        type: integer
        format: int32
        description: Field patientID of type int
      pricePerPack:
        type: number
        format: double
        description: Field pricePerPack of type double
      quantity:
        type: number
        format: double
        description: Field quantity of type double
      supplierCodeId:
        type: string
        description: Field supplierCodeId of type String
      total:
        type: number
        format: double
        description: Field total of type double
      totalNet:
        type: number
        format: double
        description: Field totalNet of type double
      treatCodeID:
        type: integer
        format: int32
        description: Field treatCodeID of type int
      treatmentItemId:
        type: integer
        format: int64
        description: Field treatmentItemId of type long
      treatmentType:
        type: string
        description: Field treatmentType of type String
      treatmentTypeID:
        type: integer
        format: int32
        description: Field treatmentTypeID of type int
  ApiResponseListBreedsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/BreedsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  BreedsCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
        description: Field description of type String
      name:
        type: string
        description: Field name of type String
      pedigreeCompulsory:
        type: boolean
        description: Field pedigreeCompulsory of type Boolean
      pedigree:
        type: boolean
        description: Field pedigree of type Boolean
  ApiResponseListTitlesCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/TitlesCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  ApiResponseListPetsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/PetsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  PetsCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      animalId:
        type: integer
        format: int32
        description: Field animalId of type int
      description:
        type: string
        description: Field description of type String
      name:
        type: string
        description: Field name of type String
      clientId:
        type: integer
        format: int32
        description: Field clientId of type int
      clientName:
        type: string
        description: Field clientName of type String
      colourName:
        type: string
        description: Field colourName of type String
      colourId:
        type: integer
        format: int32
        description: Field colourId of type int
      speciesName:
        type: string
        description: Field speciesName of type String
      categoryId:
        type: integer
        format: int32
        description: Field categoryId of type int
      gender:
        type: string
        description: Field gender of type String
      chipNo:
        type: string
        description: Field chipNo of type String
      speciesId:
        type: integer
        format: int32
        description: Field speciesId of type int
      dob:
        type: string
        description: Field dob of type String
      genderId:
        type: integer
        format: int32
        description: Field genderId of type int
      breedName:
        type: string
        description: Field breedName of type String
  ApiResponseListAddressListCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/AddressListCL"
  ApiResponsePetsCL:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/PetsCL"
  ApiResponseListWeightsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/WeightsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  WeightsCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      animalId:
        type: integer
        format: int32
        description: Field animalId of type int
      weight:
        type: number
        format: double
        description: Field weight of type double
      dateLogged:
        type: integer
        format: int64
        description: Field dateLogged of type Long
  ApiResponseListAppointmentDetailsCL:
    type: object
    properties:
      responseType:
        type: string
        description: Type of the response, one of ApiReponse, ApiResponseList*, ApiError,
          ApiFailure, or ApiAccessError
      uuid:
        type: string
        description: Unique identifier for the response
      responseText:
        type: string
        description: Response as Text
      responseList:
        type: array
        description: Response as a list for processing
        items:
          "$ref": "#/definitions/AppointmentDetailsCL"
      responseTimestamp:
        type: integer
        format: int64
        description: Timestamp of the response
  AppointmentDetailsCL:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: Field id of type int
      description:
        type: string
      name:
        type: string
      viewOrder:
        type: integer
        format: int32
      subCategoryId:
        type: integer
        format: int32
  ApiResponseListAppointment:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Appointment"
  Address:
    type: object
    properties:
      nameNo:
        type: string
      line1:
        type: string
      town:
        type: string
      postalCode:
        type: string
  ApiResponseListSite:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Site"
  Site:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
      emailAddress:
        type: string
      phoneNumber:
        type: string
      address:
        "$ref": "#/definitions/Address"
  ApiResponsePatient:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/Patient"
  Patient:
    type: object
    properties:
      id:
        type: integer
        format: int32
      clientId:
        type: integer
        format: int32
      species:
        type: string
      breed:
        type: string
      colour:
        type: string
      name:
        type: string
      gender:
        type: string
      microchipNumber:
        type: string
      insuranceCompany:
        type: string
      insuranceNumber:
        type: string
      dateOfBirth:
        type: string
        format: date-time
      neutered:
        type: boolean
      deceased:
        type: boolean
  ApiResponseListReminder:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Reminder"
  ApiResponseClient:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/Client"
  Client:
    type: object
    properties:
      id:
        type: integer
        format: int32
      title:
        type: string
      surname:
        type: string
      firstName:
        type: string
      siteName:
        type: string
      siteId:
        type: integer
        format: int32
      address:
        "$ref": "#/definitions/Address"
      privateEmailAddress:
        type: string
      businessEmailAddress:
        type: string
      homePhoneNumber:
        type: string
      mobilePhoneNumber:
        type: string
  ClinicalNoteParameters:
    type: object
    required:
    - clientId
    - note
    - patientId
    - practitionerId
    - siteId
    properties:
      siteId:
        type: integer
        format: int32
        minimum: 1
      practitionerId:
        type: integer
        format: int32
        minimum: 1
      clientId:
        type: integer
        format: int32
        minimum: 1
      patientId:
        type: integer
        format: int32
        minimum: 1
      note:
        type: string
  ApiResponseAppointment:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        "$ref": "#/definitions/Appointment"
  ApiResponseListPet:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Pet"
  Pet:
    type: object
    properties:
      id:
        type: integer
        format: int32
      species:
        type: string
      breed:
        type: string
      colour:
        type: string
      name:
        type: string
  ApiResponseListClient:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Client"
  ApiResponseListTitle:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/Title"
  Title:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
  ApiResponseBoolean:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseObject:
        type: boolean
  RegistrationsUserDetails:
    type: object
    required:
    - address1
    - cityId
    - email
    - firstName
    - homePhone
    - nameNumber
    - phoneMobile
    - postcode
    - surname
    - titleId
    properties:
      email:
        type: string
      titleId:
        type: integer
        format: int32
        minimum: 1
      firstName:
        type: string
      middleName:
        type: string
      surname:
        type: string
      nameNumber:
        type: string
      address1:
        type: string
      address2:
        type: string
      cityId:
        type: integer
        format: int32
        minimum: 1
      county:
        type: string
      postcode:
        type: string
      phoneMobile:
        type: string
      homePhone:
        type: string
  ApiResponseListCity:
    type: object
    properties:
      responseType:
        type: string
      uuid:
        type: string
      responseText:
        type: string
      responseTimestamp:
        type: integer
        format: int64
      responseList:
        type: array
        items:
          "$ref": "#/definitions/City"
  City:
    type: object
    properties:
      id:
        type: integer
        format: int32
      name:
        type: string
externalDocs:
  description: Global Api Usage Guide
  url: "/documentation"