Skip to main content
API docs by Redocly

Patient Management (3.0.0)

Patient

Access and Manage the Patients (Animals)

Retrieve Patients

Retrieve a list of patient objects

query Parameters
required
object (Pageable)

Pageable parameters

account-uuid
string <uuid>
Example: account-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
patient-name
string
Example: patient-name=Eggy
microchip
string
Example: microchip=123456789012345
include-deactivated
boolean
modified-start
string <date-time>
Example: modified-start=2021-07-07T15:50:00.00Z

delta start

modified-end
string <date-time>
Example: modified-end=2021-08-07T15:50:00.00Z

delta end

location-uuid
string <uuid>
Example: location-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
Array of objects (Patient)
Array
patient-uuid
string <uuid>
account-uuid
string <uuid>
patient-category-uuid
string <uuid>
patient-name
string
species-uuid
string <uuid>
breed-uuid
string <uuid>
colour-uuid
string <uuid>
gender-uuid
string <uuid>
microchip
string
registered-date
string <date-time>
date-of-birth
string <date-time>
status-deceased
boolean
status-deceased-date
string <date-time>
status-deactivated
boolean
status-sold
boolean
status-sold-date
string <date-time>
status-passport-certified
boolean
status-crossbreed
boolean
insurance-company-uuid
string <uuid>
insurance-policy
string
insurance-start-date
string <date-time>
flea-type-uuid
string <uuid>
flea-last-date
string <date-time>
worm-last-date
string <date-time>
herd-reference
string
herd-size
integer <int32>
status-food-chain
boolean
discount-category-uuid
string <uuid>
last-visit-date
string <date-time>
modified
string <date-time>
conditions
string
notes
string
notes-popup
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "account-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "patient-category-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "patient-name": "Eggy",
      • "species-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "breed-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "colour-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "gender-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "microchip": "123456789012345",
      • "registered-date": "2019-09-07T15:50:00.00Z",
      • "date-of-birth": "2011-09-07T15:50:00.00Z",
      • "status-deceased": false,
      • "status-deceased-date": "2019-09-07T15:50:00.00Z",
      • "status-deactivated": false,
      • "status-sold": false,
      • "status-sold-date": "2019-09-07T15:50:00.00Z",
      • "status-passport-certified": true,
      • "status-crossbreed": true,
      • "insurance-company-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "insurance-policy": "standard",
      • "insurance-start-date": "2019-09-07T15:50:00.00Z",
      • "flea-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "flea-last-date": "2019-09-07T15:50:00.00Z",
      • "worm-last-date": "2019-09-07T15:50:00.00Z",
      • "herd-reference": "A123456",
      • "herd-size": 100,
      • "status-food-chain": false,
      • "discount-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "last-visit-date": "2020-09-07T15:50:00.00Z",
      • "modified": "2020-09-07T15:50:00.00Z",
      • "conditions": "allergic to wheat produce",
      • "notes": "loves snacks",
      • "notes-popup": "loves snacks"
      }
    ]
}

Create a patient

Create a patient

Request Body schema: application/json
required
account-uuid
required
string <uuid>
patient-category-uuid
required
string <uuid>
patient-name
required
string [ 1 .. 70 ] characters
species-uuid
string <uuid>
breed-uuid
string <uuid>
colour-uuid
string <uuid>
gender-uuid
string <uuid>
microchip
string <= 200 characters
registered-date
string <date-time>
date-of-birth
string <date-time>
status-deceased
boolean
status-deceased-date
string <date-time>
status-deactivated
boolean
status-sold
boolean
status-sold-date
string <date-time>
status-passport-certified
boolean
status-crossbreed
boolean
insurance-company-uuid
string <uuid>
insurance-policy
string <= 100 characters
insurance-start-date
string <date-time>
flea-type-uuid
string <uuid>
flea-last-date
string <date-time>
worm-last-date
string <date-time>
herd-reference
string <= 50 characters
herd-size
integer <int32>
status-food-chain
boolean
discount-category-uuid
string <uuid>
conditions
string <= 3000 characters
notes
string <= 3000 characters
notes-popup
string <= 7000 characters

Responses

Response Schema: application/json
patient-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "account-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "patient-category-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "patient-name": "Eggy",
  • "species-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "breed-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
  • "colour-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "gender-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "microchip": "123456789012345",
  • "registered-date": "2019-09-07T15:50:00.00Z",
  • "date-of-birth": "2011-09-07T15:50:00.00Z",
  • "status-deceased": false,
  • "status-deceased-date": "2019-09-07T15:50:00.00Z",
  • "status-deactivated": false,
  • "status-sold": false,
  • "status-sold-date": "2019-09-07T15:50:00.00Z",
  • "status-passport-certified": true,
  • "status-crossbreed": true,
  • "insurance-company-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "insurance-policy": "standard",
  • "insurance-start-date": "2019-09-07T15:50:00.00Z",
  • "flea-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "flea-last-date": "2019-09-07T15:50:00.00Z",
  • "worm-last-date": "2019-09-07T15:50:00.00Z",
  • "herd-reference": "A123456",
  • "herd-size": 100,
  • "status-food-chain": false,
  • "discount-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "conditions": "allergic to wheat produce",
  • "notes": "loves snacks",
  • "notes-popup": "loves snacks"
}

Response samples

Content type
application/json
{
  • "patient-uuid": "0B1CF3D4-D3FA-496E-A060-FB76EE3AC2C7"
}

Deactivate Patients Eligibility

Reset of patient eligibility rules for all animals on a specified account.

Request Body schema: application/json
required
account-uuid
required
string <uuid>
account-type-uuid
required
string <uuid>
location-uuid
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "account-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "account-type-uuid": "3419D0F4-5622-42E3-A79E-201CD175E632",
  • "location-uuid": "5079D0F4-5622-42E3-A79E-201CD175E632"
}

Response samples

Content type
application/json
{
  • "messages": [
    • "string"
    ]
}

Retrieve Patient

Retrieve a single patient.

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
patient-uuid
string <uuid>
account-uuid
string <uuid>
patient-category-uuid
string <uuid>
patient-name
string
species-uuid
string <uuid>
breed-uuid
string <uuid>
colour-uuid
string <uuid>
gender-uuid
string <uuid>
microchip
string
registered-date
string <date-time>
date-of-birth
string <date-time>
status-deceased
boolean
status-deceased-date
string <date-time>
status-deactivated
boolean
status-sold
boolean
status-sold-date
string <date-time>
status-passport-certified
boolean
status-crossbreed
boolean
insurance-company-uuid
string <uuid>
insurance-policy
string
insurance-start-date
string <date-time>
flea-type-uuid
string <uuid>
flea-last-date
string <date-time>
worm-last-date
string <date-time>
herd-reference
string
herd-size
integer <int32>
status-food-chain
boolean
discount-category-uuid
string <uuid>
last-visit-date
string <date-time>
modified
string <date-time>
conditions
string
notes
string
notes-popup
string

Response samples

Content type
application/json
{
  • "patient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "account-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "patient-category-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "patient-name": "Eggy",
  • "species-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "breed-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
  • "colour-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "gender-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "microchip": "123456789012345",
  • "registered-date": "2019-09-07T15:50:00.00Z",
  • "date-of-birth": "2011-09-07T15:50:00.00Z",
  • "status-deceased": false,
  • "status-deceased-date": "2019-09-07T15:50:00.00Z",
  • "status-deactivated": false,
  • "status-sold": false,
  • "status-sold-date": "2019-09-07T15:50:00.00Z",
  • "status-passport-certified": true,
  • "status-crossbreed": true,
  • "insurance-company-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "insurance-policy": "standard",
  • "insurance-start-date": "2019-09-07T15:50:00.00Z",
  • "flea-type-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "flea-last-date": "2019-09-07T15:50:00.00Z",
  • "worm-last-date": "2019-09-07T15:50:00.00Z",
  • "herd-reference": "A123456",
  • "herd-size": 100,
  • "status-food-chain": false,
  • "discount-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "last-visit-date": "2020-09-07T15:50:00.00Z",
  • "modified": "2020-09-07T15:50:00.00Z",
  • "conditions": "allergic to wheat produce",
  • "notes": "loves snacks",
  • "notes-popup": "loves snacks"
}

Update patient

Update the info about a patient

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
patient-category-uuid
string <uuid>
patient-name
string [ 1 .. 70 ] characters
species-uuid
string or null <uuid>
breed-uuid
string or null <uuid>
colour-uuid
string or null <uuid>
gender-uuid
string or null <uuid>
microchip
string <= 200 characters
registered-date
string <date-time>
date-of-birth
string <date-time>
status-deceased
boolean
status-deceased-date
string <date-time>
status-sold
boolean
status-sold-date
string <date-time>
status-passport-certified
boolean
status-crossbreed
boolean
insurance-company-uuid
string or null <uuid>
insurance-policy
string <= 100 characters
insurance-start-date
string <date-time>
flea-type-uuid
string or null <uuid>
flea-last-date
string <date-time>
worm-last-date
string <date-time>
herd-reference
string <= 50 characters
herd-size
integer <int32>
status-food-chain
boolean
discount-category-uuid
string or null <uuid>
conditions
string <= 3000 characters
notes
string <= 3000 characters
notes-popup
string <= 7000 characters

Responses

Response Schema: application/json
patient-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "patient-category-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "patient-name": "Milly",
  • "species-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "breed-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
  • "colour-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "gender-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "microchip": "981000002642705",
  • "registered-date": "2021-01-07T15:50:00.00Z",
  • "date-of-birth": "2021-01-07T15:50:00.00Z",
  • "status-deceased": true,
  • "status-deceased-date": "2021-01-07T15:50:00.00Z",
  • "status-sold": true,
  • "status-sold-date": "2021-01-07T15:50:00.00Z",
  • "status-passport-certified": true,
  • "status-crossbreed": true,
  • "insurance-company-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "insurance-policy": "SD382644824",
  • "insurance-start-date": "2021-01-07T15:50:00.00Z",
  • "flea-type-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "flea-last-date": "2021-01-07T15:50:00.00Z",
  • "worm-last-date": "2021-01-07T15:50:00.00Z",
  • "herd-reference": "12382644824",
  • "herd-size": 123,
  • "status-food-chain": true,
  • "discount-category-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632",
  • "conditions": "allergic to wheat produce",
  • "notes": "loves snacks",
  • "notes-popup": "loves snacks"
}

Response samples

Content type
application/json
{
  • "patient-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Delete a patient

Delete a patient

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
patient-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "patient-uuid": "3B0A1726-3D39-49EB-AA12-4207662481FB"
}

Activate patient

Activate patient

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
patient-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "patient-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Activate patient eligibility

Activate patient eligibility

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
account-type-uuid
required
string <uuid>
location-uuid
required
string <uuid>
notes
string
deactivation-timeout-override
boolean
Default: false
activation-reason-uuid
string <uuid>

Responses

Response Schema: application/json
patient-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "account-type-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "location-uuid": "CCA51A01-CC79-4EA2-BD38-B9A7E66F1812",
  • "notes": "notes",
  • "deactivation-timeout-override": true,
  • "activation-reason-uuid": "EB265C16-AC70-4EFE-A533-EE863FE4B504"
}

Response samples

Content type
application/json
{
  • "patient-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Deactivate Patient Eligibility

Reset of patient eligibility rules

path Parameters
patient-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
account-type-uuid
required
string <uuid>
location-uuid
required
string <uuid>
activation-reason-uuid
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "account-type-uuid": "3419D0F4-5622-42E3-A79E-201CD175E632",
  • "location-uuid": "5079D0F4-5622-42E3-A79E-201CD175E632",
  • "activation-reason-uuid": "1319D0F4-5622-42E3-A79E-201CD175E632"
}

Response samples

Content type
application/json
{
  • "messages": [
    • "string"
    ]
}

Patient Category

Access and Manage the Patient category metadata

Retrieve Patient Categories

Retrieve a list of patient categories from the library.

query Parameters
required
object (Pageable)

Pageable parameters

species-uuid
string <uuid>
Example: species-uuid=915CA63A-2762-4BD2-BFB8-0B067327095D

Filter categories based on species

Responses

Response Schema: application/json
Array of objects (PatientCategory)
Array
patient-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Equine",
      • "description": "Equine"
      }
    ]
}

Retrieve Patient Category

Retrieve a single patient category

path Parameters
patient-categories-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
patient-category-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "patient-category-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "Equine",
  • "description": "Equine"
}

Species

Access and Manage species metadata

Retrieve Patient Category Species

Retrieve a list of species for the specified patient category.

path Parameters
patient-categories-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PatientCategorySpecies)
Array
species-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "species-uuid": "CCA51A01-CC79-4EA2-BD38-B9A7E66F1812"
      }
    ]
}

Retrieve Species

Retrieve a list of species objects

query Parameters
required
object (Pageable)

Pageable parameters

search-name
string

Filter where the species name starts with this search term

Responses

Response Schema: application/json
Array of objects (Species)
Array
species-uuid
string <uuid>
name
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "species-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "name": "Canine",
      • "view-order": 0
      }
    ]
}

Manage Single Species

Retrieve a single specified species

path Parameters
species-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
species-uuid
string <uuid>
name
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "species-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "name": "Canine",
  • "view-order": 0
}

Breed

Access and Manage Breed metadata

Retrieve Species Breeds

Retrieve a list of breeds related to the specified species

path Parameters
species-uuid
required
string <uuid>
Example: 1432705A-9820-4AA1-BA5F-010716C3067E
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (SpeciesBreed)
Array
breed-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "breed-uuid": "EB265C16-AC70-4EFE-A533-EE863FE4B504"
      }
    ]
}

Retrieve Breeds

Retrieve a list of species from the library

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean
search-name
string

Filter where the breed name starts with this search term

Responses

Response Schema: application/json
Array of objects (Breed)
Array
breed-uuid
string <uuid>
name
string
pedigree
boolean
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "breed-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "name": "Jack Russell Terrier",
      • "pedigree": false,
      • "active": true
      }
    ]
}

Retrieve Breed

Retrieve a single breed object

path Parameters
breed-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
breed-uuid
string <uuid>
name
string
pedigree
boolean
active
boolean

Response samples

Content type
application/json
{
  • "breed-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "name": "Jack Russell Terrier",
  • "pedigree": false,
  • "active": true
}

Gender

Access and Manage Gender metadata

Retrieve Species Genders

Retrieve a list of genders for the specified species

path Parameters
species-uuid
required
string <uuid>
Example: 866C9BEA-4D4D-492F-870B-38652369B5EF
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (SpeciesGender)
Array
gender-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "gender-uuid": "F8F29EF2-AE08-4A9F-945B-8069DA3BFFB8"
      }
    ]
}

Retrieve Genders

Retrieve a list of genders

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean

Responses

Response Schema: application/json
Array of objects (Gender)
Array
gender-uuid
string <uuid>
name
string
sex
string
Enum: "M" "F" "U"
neutered
boolean
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "gender-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
      • "name": "Neut Male",
      • "sex": "M",
      • "neutered": true,
      • "active": true
      }
    ]
}

Retrieve Gender

Retrieve a single gender

path Parameters
gender-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
gender-uuid
string <uuid>
name
string
sex
string
Enum: "M" "F" "U"
neutered
boolean
active
boolean

Response samples

Content type
application/json
{
  • "gender-uuid": "E0CCC3B8-75D3-491B-BEB9-97DD982941A7",
  • "name": "Neut Male",
  • "sex": "M",
  • "neutered": true,
  • "active": true
}

Colour

Access and Manage Colour metadata

Retrieve Breed Colours

Retrieve a colours linked to the specified breed.

path Parameters
breed-uuid
required
string <uuid>
Example: C5DE2BA7-F237-468D-9623-15EFF2E3718B
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (BreedColour)
Array
colour-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "colour-uuid": "B6E83459-7A94-4D24-A1A9-055E0E89B6F6"
      }
    ]
}

Retrieve Colours

Retrieve a list of colours from the library

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean

Responses

Response Schema: application/json
Array of objects (Colour)
Array
colour-uuid
string <uuid>
name
string
description
string
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "colour-uuid": "B803CC34-B55E-47C7-B2BB-674512465111",
      • "name": "Brindle",
      • "description": "Brindle",
      • "active": true
      }
    ]
}

Retrieve Colour

Retrieve a single colour

path Parameters
colour-uuid
required
string <uuid>
Example: AFD94B57-57C0-4960-9B9E-C463EA2CEC1C

Responses

Response Schema: application/json
colour-uuid
string <uuid>
name
string
description
string
active
boolean

Response samples

Content type
application/json
{
  • "colour-uuid": "B803CC34-B55E-47C7-B2BB-674512465111",
  • "name": "Brindle",
  • "description": "Brindle",
  • "active": true
}

Patient Identifiers

Retrieve Patient identifiers

Retrieve a list of Patient identifiers.

query Parameters
required
object (Pageable)

Pageable parameters

patient-uuid
string <uuid>
Example: patient-uuid=7ABA8B0A-F279-4175-AB3C-4203103822CB
animal-id
integer <int32>
Example: animal-id=123

Responses

Response Schema: application/json
Array of objects (PatientIdentifiers)
Array
patient-uuid
string <uuid>
animal-id
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "patient-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "animal-id": "123"
      }
    ]
}

Insurance Companies

Access to insurance companies

Retrieve Insurance Companies

Retrieve a list of insurance companies from the library.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (InsuranceCompany)
Array
insurance-company-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "insurance-company-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "ACME Insurance"
      }
    ]
}

Retrieve Insurance Company

Retrieve a single insurance company.

path Parameters
uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83

Responses

Response Schema: application/json
insurance-company-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "insurance-company-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "ACME Insurance"
}