Skip to main content
API docs by Redocly

Contact Management (3.0.0)

Contact

Data for accessing and managing Contacts

Retrieve contacts

Retrieve a list of contacts

query Parameters
required
object (Pageable)

Pageable parameters

include-deactivated
boolean
Default: false
last-name
string
Example: last-name=Kent
first-name
string
Example: first-name=Clark
contact-type
string
Enum: "Client" "Practitioner" "User"
Example: contact-type=Client
default-location-uuid
string <uuid>
Example: default-location-uuid=4887D81B-F472-4959-94A6-BAD5E54F11F4
modified-start
string <date-time>
Example: modified-start=2021-07-01T00:00:00.00Z
modified-end
string <date-time>
Example: modified-end=2021-07-02T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (Contact)
Array
contact-uuid
string <uuid>
title-uuid
string <uuid>
last-name
string
first-name
string
contact-type
string (ContactType)
Enum: "Client" "Practitioner" "User"
registered-date
string <date-time>
deactivated
boolean
modified
string <date-time>
online-access
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
      • "title-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
      • "last-name": "Kent",
      • "first-name": "Clark",
      • "contact-type": "Client",
      • "registered-date": "2021-01-07T15:50:00.00Z",
      • "deactivated": false,
      • "modified": "2021-02-07T15:50:00.00Z",
      • "online-access": false
      }
    ]
}

Create a contact

Create a contact

Request Body schema: application/json
required
last-name
required
string [ 1 .. 100 ] characters
first-name
required
string [ 1 .. 100 ] characters
contact-type
required
string (ContactType)
Enum: "Client" "Practitioner" "User"
location-uuid
required
string <uuid>
title-uuid
string <uuid>
registered-date
string <date-time>

Defaults to the current date if left blank

online-access
boolean

Responses

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

Request samples

Content type
application/json
{
  • "last-name": "Kent",
  • "first-name": "Clark",
  • "contact-type": "Client",
  • "location-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
  • "title-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
  • "registered-date": "2021-01-07T15:50:00.00Z",
  • "online-access": true
}

Response samples

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

Retrieve contact

Retrieve a single contact

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

Responses

Response Schema: application/json
contact-uuid
string <uuid>
title-uuid
string <uuid>
last-name
string
first-name
string
contact-type
string (ContactType)
Enum: "Client" "Practitioner" "User"
registered-date
string <date-time>
deactivated
boolean
modified
string <date-time>
online-access
boolean

Response samples

Content type
application/json
{
  • "contact-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
  • "title-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
  • "last-name": "Kent",
  • "first-name": "Clark",
  • "contact-type": "Client",
  • "registered-date": "2021-01-07T15:50:00.00Z",
  • "deactivated": false,
  • "modified": "2021-02-07T15:50:00.00Z",
  • "online-access": false
}

Update contact

Update the details of a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
last-name
string [ 1 .. 100 ] characters
first-name
string or null [ 1 .. 100 ] characters
title-uuid
string or null <uuid>
registered-date
string <date-time>
online-access
boolean

Responses

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

Request samples

Content type
application/json
{
  • "last-name": "Kent",
  • "first-name": "Clark",
  • "title-uuid": "D9A21292-606A-4AE2-9655-BD0B6AA51940",
  • "registered-date": "2021-01-07T15:50:00.00Z",
  • "online-access": true
}

Response samples

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

Deactivate contact

Set a contact as deactivated

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

Responses

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

Response samples

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

Search contacts by name

Search for contacts using first and last names

query Parameters
required
object (Pageable)

Pageable parameters

include-deactivated
boolean
Default: false
last-name
string
Example: last-name=Kent
first-name
string
Example: first-name=Clark
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals
contact-type
string (ContactType)
Enum: "Client" "Practitioner" "User"
Example: contact-type=Client

Responses

Response Schema: application/json
Array of objects (Contact)
Array
contact-uuid
string <uuid>
title-uuid
string <uuid>
last-name
string
first-name
string
contact-type
string (ContactType)
Enum: "Client" "Practitioner" "User"
registered-date
string <date-time>
deactivated
boolean
modified
string <date-time>
online-access
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
      • "title-uuid": "57F80D71-9413-44E4-AD24-276037D13070",
      • "last-name": "Kent",
      • "first-name": "Clark",
      • "contact-type": "Client",
      • "registered-date": "2021-01-07T15:50:00.00Z",
      • "deactivated": false,
      • "modified": "2021-02-07T15:50:00.00Z",
      • "online-access": false
      }
    ]
}

User

Data for accessing and managing Users which is an extension of Contact

Client

Data for accessing and managing Clients which is an extension of Contact

Retrieve Communication Preferences

Retrieve a list of communication preferences for a contact

path Parameters
contact-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 (CommunicationPreference)
Array
communication-type-uuid
string <uuid>
communication-channel-uuid
string <uuid>
active
boolean
created-on
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "communication-type-uuid": "7F816930-E59F-40AE-B8D8-ABEDD4DF7B17",
      • "communication-channel-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
      • "active": true,
      • "created-on": "2020-05-07T15:50:00.00Z"
      }
    ]
}

Create a communication preference

Create a communication preference for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
communication-type-uuid
required
string <uuid>
communication-channel-uuid
required
string <uuid>
active
boolean
Default: true
created-on
string <date-time>

Defaults to the current date if left blank

Responses

Response Schema: application/json
communication-type-uuid
string <uuid>
communication-channel-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "communication-type-uuid": "7F816930-E59F-40AE-B8D8-ABEDD4DF7B17",
  • "communication-channel-uuid": "6A612C31-7DEB-4085-8E57-516B8DC9E026",
  • "active": true,
  • "created-on": "2020-05-07T15:50:00.00Z"
}

Response samples

Content type
application/json
{
  • "communication-type-uuid": "669C92FF-3BA1-4C56-B5FD-32282DEA2C0E",
  • "communication-channel-uuid": "B569E8C1-295D-4CF8-A149-4E273A773F4A"
}

Update a communication preference

Update a communication preference for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
communication-type-uuid
required
string <uuid>
communication-channel-uuid
required
string <uuid>
active
required
boolean

Responses

Response Schema: application/json
communication-type-uuid
string <uuid>
communication-channel-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "communication-type-uuid": "6792921D-D31A-4B80-8658-BE83BD952959",
  • "communication-channel-uuid": "F842F556-47D0-405E-94D6-080003BF6A0A",
  • "active": true
}

Response samples

Content type
application/json
{
  • "communication-type-uuid": "6792921D-D31A-4B80-8658-BE83BD952959",
  • "communication-channel-uuid": "F842F556-47D0-405E-94D6-080003BF6A0A"
}

Retrieve Titles

Retrieve a list of titles

query Parameters
required
object (Pageable)

Pageable parameters

Responses

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

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "title-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "name": "Mr",
      • "description": "Mr",
      • "active": true
      }
    ]
}

Retrieve Title

Retrieve a single title.

path Parameters
title-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

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

Response samples

Content type
application/json
{
  • "title-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
  • "name": "Mr",
  • "description": "Mr",
  • "active": true
}

Address

Data for accessing and managing Addresses which is an extension of Clients

Retrieve Contact Addresses

Retrieve a list of addresses for a contact

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

Pageable parameters

mailing-address
boolean
Example: mailing-address=true

Responses

Response Schema: application/json
Array of objects (Address)
Array
address-uuid
string <uuid>
address-type-id
integer <int32>
name-no
string
address1
string
address2
string
city
string
county
string
postcode
string
mailing-address
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "address-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "address-type-id": 405675,
      • "name-no": "3",
      • "address1": "Pine Hill River Street",
      • "address2": "Surrey",
      • "city": "Kingston upon Thames",
      • "county": "Surrey",
      • "postcode": "GU7 3HT",
      • "mailing-address": true
      }
    ]
}

Create a contact address

Create an address for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
address-type-id
required
integer <int32> >= 1
name-no
string <= 255 characters
address1
string <= 255 characters
address2
string <= 255 characters
city
string
county
string <= 255 characters
postcode
string <= 20 characters
mailing-address
required
boolean

Responses

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

Request samples

Content type
application/json
{
  • "address-type-id": 405675,
  • "name-no": "3",
  • "address1": "Pine Hill River Street",
  • "address2": "Surrey",
  • "city": "London",
  • "county": "Surrey",
  • "postcode": "GU7 3HT",
  • "mailing-address": true
}

Response samples

Content type
application/json
{
  • "address-uuid": "FAA20A8D-8A88-4EE6-AE22-DD87BE1F35BE"
}

Delete a contact address

Delete a contact address

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

Responses

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

Response samples

Content type
application/json
{
  • "address-uuid": "FA0E0D61-198B-469A-81EF-BFF0C5F5493A"
}

Search contacts by Address

Search for contacts using Address

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
region-uuid
string <uuid>
address-type-id
integer <int32>
Example: address-type-id=405675
search-name-no
string
Example: search-name-no=3
search-address1
string
Example: search-address1=Pine Hill River Street
search-address2
string
Example: search-address2=Surrey
search-city
string
Example: search-city=Kingston upon Thames
search-county
string
Example: search-county=Surrey
search-postcode
string
Example: search-postcode=GU7 3HT
modified-start
string <date-time>
Example: modified-start=2021-07-01T00:00:00.00Z
modified-end
string <date-time>
Example: modified-end=2021-07-02T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (SearchContactAddressesItem)
Array
contact-uuid
string <uuid>
address-uuid
string <uuid>
name-no
string <= 255 characters
address1
string <= 255 characters
address2
string <= 255 characters
city
string
county
string <= 255 characters
postcode
string <= 20 characters
mailing-address
boolean
modified
string <date-time>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "620F3F6E-FDA7-4F4F-BE7D-D8340EB2A7D4",
      • "address-uuid": "FAA20A8D-8A88-4EE6-AE22-DD87BE1F35BE",
      • "name-no": "3",
      • "address1": "Pine Hill River Street",
      • "address2": "Surrey",
      • "city": "London",
      • "county": "Surrey",
      • "postcode": "GU7 3HT",
      • "mailing-address": true,
      • "modified": "2021-02-07T15:50:00.00Z"
      }
    ]
}

Update Contact Address

Update Contact Address

path Parameters
address-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
name-no
string or null <= 255 characters
address1
string or null <= 255 characters
address2
string or null <= 255 characters
city
string or null
county
string or null <= 255 characters
postcode
string or null <= 20 characters

Responses

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

Request samples

Content type
application/json
{
  • "name-no": "3",
  • "address1": "Pine Hill River Street",
  • "address2": "Surrey",
  • "city": "London",
  • "county": "Surrey",
  • "postcode": "GU7 3HT"
}

Response samples

Content type
application/json
{
  • "address-uuid": "FAA20A8D-8A88-4EE6-AE22-DD87BE1F35BE"
}

Retrieve Cities

Retrieve a list of cities

query Parameters
required
object (Pageable)

Pageable parameters

include-inactive
boolean
search-name
string

Filter where the city name starts with this search term

Responses

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

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "city-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "name": "Guildford",
      • "description": "Guildford",
      • "active": true
      }
    ]
}

Retrieve City

Retrieve a single city

path Parameters
city-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

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

Response samples

Content type
application/json
{
  • "city-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "name": "Guildford",
  • "description": "Guildford",
  • "active": true
}

Retrieve Address Types

Retrieve a list of address types such as home.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (AddressType)
Array
address-type-id
integer <int32>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "address-type-id": 876266,
      • "name": "Business",
      • "description": "Business"
      }
    ]
}

Practitioner

Data for accessing and managing Practitioner which is an extension of Contact

Retrieve Practitioners

Retrieve a list of practitioners

query Parameters
required
object (Pageable)

Pageable parameters

show-deactivated
boolean

Include deactivated practitioners. Default: false

practitioner-type-id
integer
Example: practitioner-type-id=1237

Include only practitioners of the specified type

show-deactivated-contacts
boolean

Include practitioners where the owner contact is deactivated. Default: false

search-last-name
string

Filter where the practitioner last name starts with this search term

location-uuid
string <uuid>
Example: location-uuid=E4F8C8C3-2189-4059-9C06-6DF32A38DA15

Include only practitioners attached to the specified location

Responses

Response Schema: application/json
Array of objects (Practitioner)
Array
contact-uuid
string <uuid>
linked-user-uuid
string <uuid>
deactivated
boolean
license-number
string
qualification-uuid
string <uuid>
first-name
string
last-name
string
contact-deactivated
boolean
practitioner-type-id
integer <int32>
Array of objects (Discipline)

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "linked-user-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "deactivated": false,
      • "license-number": "UXJ193UIK",
      • "qualification-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
      • "first-name": "Lois",
      • "last-name": "Lane",
      • "contact-deactivated": false,
      • "practitioner-type-id": 546345,
      • "disciplines": [
        • {
          • "discipline-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
          • "name": "Cardiology"
          }
        ]
      }
    ]
}

Retrieve Practitioner

Retrieve a single practitioner record

path Parameters
contact-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
contact-uuid
string <uuid>
linked-user-uuid
string <uuid>
deactivated
boolean
license-number
string
qualification-uuid
string <uuid>
first-name
string
last-name
string
contact-deactivated
boolean
practitioner-type-id
integer <int32>
Array of objects (Discipline)

Response samples

Content type
application/json
{
  • "contact-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "linked-user-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "deactivated": false,
  • "license-number": "UXJ193UIK",
  • "qualification-uuid": "8819E9FE-DAD9-477A-BF4B-AF6A4036DB50",
  • "first-name": "Lois",
  • "last-name": "Lane",
  • "contact-deactivated": false,
  • "practitioner-type-id": 546345,
  • "disciplines": [
    • {
      • "discipline-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Cardiology"
      }
    ]
}

Retrieve Practitioners Locations

Retrieve a list of practitioners and the locations associated

query Parameters
required
object (Pageable)

Pageable parameters

location-uuid
string <uuid>
Example: location-uuid=6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3
contact-uuid
string <uuid>
Example: contact-uuid=918D012A-E5CE-4391-8D42-8396EF19CE83
display-diary
boolean
Example: display-diary=true
display-treatment
boolean
Example: display-treatment=true

Responses

Response Schema: application/json
Array of objects (PractitionerLocation)
Array
contact-uuid
string <uuid>
location-uuid
string <uuid>
view-order
integer <int32>
display-diary
boolean
display-treatment
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "view-order": 2,
      • "display-diary": true,
      • "display-treatment": true
      }
    ]
}

Retrieve Qualifications

Retrieve a list of qualifications

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Qualification)
Array
qualification-uuid
string <uuid>
name
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "qualification-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "name": "RCVS Masters"
      }
    ]
}

Retrieve Qualification

Retrieve a single qualification

path Parameters
qualification-uuid
required
string <uuid>
Example: E0CCC3B8-75D3-491B-BEB9-97DD982941A7

Responses

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

Response samples

Content type
application/json
{
  • "qualification-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
  • "name": "RCVS Masters"
}

Retrieve Practitioner Types

Retrieve a list of practitioner types

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (PractitionerType)
Array
practitioner-type-id
integer <int32>
name
string
description
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "practitioner-type-id": 546345,
      • "name": "Practitioner",
      • "description": "Surgeon",
      • "view-order": 2
      }
    ]
}

Retrieve Practitioner Type

Retrieve a single practitioner type

path Parameters
practitioner-type-id
required
integer <int32>
Example: 302304

Responses

Response Schema: application/json
practitioner-type-id
integer <int32>
name
string
description
string
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "practitioner-type-id": 546345,
  • "name": "Practitioner",
  • "description": "Surgeon",
  • "view-order": 2
}

Retrieve Contact Data Consent

Retrieve a list of data consent for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 96C1863F-D5F4-4C5D-88DB-3E98EE1FFC69
query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (DataConsent)
Array
consent-type
string
data-consent-uuid
string <uuid>
data-consent-type-uuid
string <uuid>
entry-date
string <date-time>
expiry-date
string <date-time>
notes
string
initials
string
entered-by
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "consent-type": "Communication Consent",
      • "data-consent-uuid": "DBA19314-D426-4CB2-B7E5-910AE34C2A36",
      • "data-consent-type-uuid": "F70316A6-311B-43E9-A399-A9CDD2BB9233",
      • "entry-date": "2021-10-31T14:42:20Z",
      • "expiry-date": "2022-10-31T00:00:00Z",
      • "notes": "Client Accepted",
      • "initials": "SM",
      • "entered-by": "sarah"
      }
    ]
}

Create a data consent entry

Create a data consent entry for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 96C1863F-D5F4-4C5D-88DB-3E98EE1FFC69
Request Body schema: application/json
required
data-consent-type-uuid
string <uuid>
terms-accepted
boolean
entry-date
string <date-time>

Defaults to the current date if left blank

expiry-date
string <date-time>
notes
string <= 3000 characters
initials
required
string [ 1 .. 50 ] characters
entered-by
required
string [ 1 .. 100 ] characters

Responses

Response Schema: application/json
data-consent-uuid
string <uuid>
comms-preference-log-data-consent-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "data-consent-type-uuid": "751B7795-BA45-43F3-B04F-A95CE79078FD",
  • "terms-accepted": true,
  • "entry-date": "2022-01-14T11:32:50Z",
  • "expiry-date": "2023-01-14T00:00:00Z",
  • "notes": "Client Accepted",
  • "initials": "SM",
  • "entered-by": "sarah"
}

Response samples

Content type
application/json
{
  • "data-consent-uuid": "4CDB9413-6D0C-4C8C-B61A-7E6462B99EEE",
  • "comms-preference-log-data-consent-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
}

Retrieve Purge Exemptions

Retrieve a list of purge exemptions for a contact

path Parameters
contact-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 (PurgeExemption)
Array
purge-exemption-uuid
string <uuid>
entry-date
string <date-time>
notes
string
expiry-date
string <date-time>
initials
string
username
string
exemption-reason-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "purge-exemption-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "entry-date": "2021-01-07T15:50:00.00Z",
      • "notes": "string",
      • "expiry-date": "2021-01-07T15:50:00.00Z",
      • "initials": "string",
      • "username": "string",
      • "exemption-reason-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
      }
    ]
}

Create Purge Exemption

Create purge exemption for contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
notes
required
string <= 3000 characters
expiry-date
required
string <date-time>
initials
required
string <= 20 characters
exemption-reason-uuid
required
string <uuid>

Responses

Response Schema: application/json
purge-exemption-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "notes": "string",
  • "expiry-date": "2022-06-16T13:45:27Z",
  • "initials": "string",
  • "exemption-reason-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83"
}

Response samples

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

Delete a purge exemption

Delete a purge exemption

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

Responses

Response Schema: application/json
purge-exemption-uuid
string <uuid>

Response samples

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

Retrieve Data Consents

Retrieve a list of data consents

query Parameters
entry-date-start
string <date-time>
Example: entry-date-start=2021-07-02T00:00:00.00Z
entry-date-end
string <date-time>
Example: entry-date-end=2021-07-03T00:00:00.00Z
expiry-date-start
string <date-time>
Example: expiry-date-start=2021-07-02T00:00:00.00Z
expiry-date-end
string <date-time>
Example: expiry-date-end=2021-07-03T00:00:00.00Z
data-consent-type-uuid
string <uuid>
Example: data-consent-type-uuid=96C1863F-D5F4-4C5D-88DB-3E98EE1FFC69
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (DataConsentEnhanced)
Array
contact-uuid
string <uuid>
consent-type
string
data-consent-uuid
string <uuid>
data-consent-type-uuid
string <uuid>
entry-date
string <date-time>
expiry-date
string <date-time>
notes
string
initials
string
entered-by
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "DBA19314-D426-4CB2-B7E5-910AE34C2A36",
      • "consent-type": "Communication Consent",
      • "data-consent-uuid": "DBA19314-D426-4CB2-B7E5-910AE34C2A36",
      • "data-consent-type-uuid": "F70316A6-311B-43E9-A399-A9CDD2BB9233",
      • "entry-date": "2021-10-31T14:42:20Z",
      • "expiry-date": "2022-10-31T00:00:00Z",
      • "notes": "Client Accepted",
      • "initials": "SM",
      • "entered-by": "sarah"
      }
    ]
}

Retrieve Data Consent Types

Retrieve a list of data consent types

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (DataConsentType)
Array
data-consent-type-uuid
string <uuid>
name
string
description
string
duration
integer <int32>
duration-type
string
Enum: "DAY" "WEEK" "MONTH"
view-order
integer <int32>
active
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "data-consent-type-uuid": "7BEFA8A1-ACF2-4EC7-823D-3985D4B17B09",
      • "name": "Registration - Phone",
      • "description": "Registration - Phone",
      • "duration": 12,
      • "duration-type": "MONTH",
      • "view-order": 1,
      • "active": true
      }
    ]
}

Email

Data for accessing and managing Emails which is an extension of Clients

Retrieve Contact Emails

Retrieve a list of emails for the contact

path Parameters
contact-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 (Email)
Array
email-address-uuid
string <uuid>
email-address-type-id
integer <int32>
email-address
string <email>
clean-email-address
string <email>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "email-address-uuid": "6CD03DF8-4D87-4E41-B73D-B2C39EBFDDB3",
      • "email-address-type-id": 322465,
      • "email-address": "fakeemail@fakedomain.com",
      • "clean-email-address": "fakeemail@fakedomain.com"
      }
    ]
}

Create a contact email

Create an email address for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
email-address-type-id
required
integer <int32> >= 1
email-address
required
string <email> [ 1 .. 100 ] characters

Responses

Response Schema: application/json
email-address-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "email-address-type-id": 322465,
  • "email-address": "fakeemail@fakedomain.com"
}

Response samples

Content type
application/json
{
  • "email-address-uuid": "DAF7D879-0446-419C-9B66-6EBFA8FFFA9C"
}

Delete a contact email address

Delete a contact email address

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

Responses

Response Schema: application/json
email-address-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "email-address-uuid": "FA0E0D61-198B-469A-81EF-BFF0C5F5493A"
}

Search contacts by email

Search for contacts using email address

query Parameters
required
object (Pageable)

Pageable parameters

search-term
required
string
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals
location-uuid
Array of strings <uuid> <= 10 items [ items <uuid > ]
region-uuid
string <uuid>

Responses

Response Schema: application/json
Array of objects (SearchContactEmailsItem)
Array
contact-uuid
string <uuid>
email-address-uuid
string <uuid>
email-address-type-id
integer <int32>
email-address
string <email>
clean-email-address
string <email>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "6B3636BA-37F3-4811-A602-291A3CDD57B7",
      • "email-address-uuid": "C535C77C-6462-468D-9377-C5DE345EA5F0",
      • "email-address-type-id": 322465,
      • "email-address": "fakeemail@fakedomain.com",
      • "clean-email-address": "fakeemail@fakedomain.com"
      }
    ]
}

Update a contact email

Update a contact email

path Parameters
email-address-uuid
required
string <uuid>
Example: 96C1863F-D5F4-4C5D-88DB-3E98EE1FFC69
Request Body schema: application/json
required
email-address
required
string <email> [ 1 .. 100 ] characters

Responses

Response Schema: application/json
email-address-uuid
string <uuid>

Request samples

Content type
application/json
{
  • "email-address": "fakeemail@fakedomain.com"
}

Response samples

Content type
application/json
{
  • "email-address-uuid": "DAF7D879-0446-419C-9B66-6EBFA8FFFA9C"
}

Retrieve Email Address Types

Retrieve a list of email address types, such as home and business.

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (EmailAddressType)
Array
email-address-type-id
integer <int32>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "email-address-type-id": 546768,
      • "name": "Business",
      • "description": "Business"
      }
    ]
}

Number

Data for accessing and managing Numbers which is an extension of Clients

Retrieve Contact Numbers

Retrieve a list of phone numbers for a contact

path Parameters
contact-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 (Number)
Array
numbers-uuid
string <uuid>
numbers-type-id
integer <int32>
number
string
clean-number
string
Deprecated
country-iso
string
country-code
integer <int32>
e164
string <int32>
international
string
notes
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "numbers-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "numbers-type-id": 435953,
      • "number": "01785282314",
      • "clean-number": "+44 8896367543",
      • "country-iso": "GB",
      • "country-code": "44",
      • "e164": "+447710123456",
      • "international": "+44 7710 123456",
      • "notes": "This is a note."
      }
    ]
}

Create a contact number

Create a phone number for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
number-type-id
required
integer <int32> >= 1
number
required
string [ 1 .. 50 ] characters
country-iso
string
e164
string <int32>
notes
string

Responses

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

Request samples

Content type
application/json
{
  • "number-type-id": 435953,
  • "number": "01785282314",
  • "country-iso": "GB",
  • "e164": "+447710123456",
  • "notes": "This is a note."
}

Response samples

Content type
application/json
{
  • "number-uuid": "DAF7D879-0446-419C-9B66-6EBFA8FFFA9C"
}

Delete a contact phone number

Delete a contact phone number

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

Responses

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

Response samples

Content type
application/json
{
  • "number-uuid": "FA0E0D61-198B-469A-81EF-BFF0C5F5493A"
}

Search contacts by phone number

Search for contacts using phone number

query Parameters
required
object (Pageable)

Pageable parameters

search-term
required
string
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals
search-field
string (SearchField)
Default: "clean-number"
Enum: "number" "e164" "clean-number"
Example: search-field=number
location-uuid
Array of strings <uuid> <= 10 items [ items <uuid > ]
region-uuid
string <uuid>

Responses

Response Schema: application/json
Array of objects (SearchContactPhonesItem)
Array
contact-uuid
string <uuid>
number-uuid
string <uuid>
number-type-id
integer <int32>
number
string
clean-number
string
Deprecated
country-iso
string
country-code
integer <int32>
e164
string <int32>
international
string
notes
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "620F3F6E-FDA7-4F4F-BE7D-D8340EB2A7D4",
      • "number-uuid": "1E4AAFF3-43E0-425A-9F65-2705F1237FA1",
      • "number-type-id": 322465,
      • "number": "01785282314",
      • "clean-number": "+44 8896367543",
      • "country-iso": "GB",
      • "country-code": "44",
      • "e164": "+447710123456",
      • "international": "+44 7710 123456",
      • "notes": "This is a note."
      }
    ]
}

Update a contact number

Update a contact number

path Parameters
number-uuid
required
string <uuid>
Example: 96C1863F-D5F4-4C5D-88DB-3E98EE1FFC69
Request Body schema: application/json
required
number
string or null [ 1 .. 50 ] characters
country-iso
string or null [ 1 .. 2 ] characters
e164
string or null <int32> [ 1 .. 30 ] characters
notes
string or null <= 50 characters

Responses

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

Request samples

Content type
application/json
{
  • "number": "0751672266899",
  • "country-iso": "GB",
  • "e164": "+447710123456",
  • "notes": "This is a note."
}

Response samples

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

Retrieve Number Types

Retrieve a list of number types, such as Mobile, Home, Fax

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (NumberType)
Array
number-type-id
integer <int32>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "number-type-id": 657234,
      • "name": "Company",
      • "description": "Company"
      }
    ]
}

Contact Identifiers

Access contact identifiers

Retrieve Contact identifiers

Retrieve a list of Contact identifiers.

query Parameters
required
object (Pageable)

Pageable parameters

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

Responses

Response Schema: application/json
Array of objects (ContactIdentifiers)
Array
contact-uuid
string <uuid>
account-uuid
string <uuid>
contact-id
integer <int32>

Response samples

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

Notes

Data for accessing and managing Notes

Search contact notes

Search for contact notes

query Parameters
required
object (Pageable)

Pageable parameters

search-term
string
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals

Responses

Response Schema: application/json
Array of objects (SearchContactNotesItem)
Array
contact-uuid
string <uuid>
note-uuid
string <uuid>
note-date
string <date-time>
note
string
initials
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "1DDE3920-9273-45F3-BCAD-BDE4B32A0B3F",
      • "note-uuid": "0FB0E4C4-9797-4874-A4DB-69598852E28D",
      • "note-date": "2022-07-22T08:58:00Z",
      • "note": "Meds collected. Claim form signed.",
      • "initials": "HJS"
      }
    ]
}

Search contact notes for a given contact

Search for contact notes by a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB
query Parameters
required
object (Pageable)

Pageable parameters

search-term
string
search-operation
string (SearchOperation)
Default: "equals"
Enum: "equals" "contains" "endswith" "startswith"
Example: search-operation=equals

Responses

Response Schema: application/json
Array of objects (SearchContactNotesItem)
Array
contact-uuid
string <uuid>
note-uuid
string <uuid>
note-date
string <date-time>
note
string
initials
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "contact-uuid": "1DDE3920-9273-45F3-BCAD-BDE4B32A0B3F",
      • "note-uuid": "0FB0E4C4-9797-4874-A4DB-69598852E28D",
      • "note-date": "2022-07-22T08:58:00Z",
      • "note": "Meds collected. Claim form signed.",
      • "initials": "HJS"
      }
    ]
}

Create Contact Note

Create contact note for contact

path Parameters
contact-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB
Request Body schema: application/json
required
note-date
string <date-time>

Defaults to the current date if left blank

note
required
string [ 1 .. 7000 ] characters
initials
required
string [ 1 .. 50 ] characters

Responses

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

Request samples

Content type
application/json
{
  • "note-date": "2022-07-22T08:58:00Z",
  • "note": "Meds collected. Claim form signed.",
  • "initials": "HJS"
}

Response samples

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

Retrieve contact note

Retrieve a single contact note

path Parameters
note-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
contact-uuid
string <uuid>
note-uuid
string <uuid>
note-date
string <date-time>
note
string
initials
string

Response samples

Content type
application/json
{
  • "contact-uuid": "1DDE3920-9273-45F3-BCAD-BDE4B32A0B3F",
  • "note-uuid": "0FB0E4C4-9797-4874-A4DB-69598852E28D",
  • "note-date": "2022-07-22T08:58:00Z",
  • "note": "Meds collected. Claim form signed.",
  • "initials": "HJS"
}

Delete a contact note

Delete a contact note

path Parameters
note-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

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

Response samples

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

Update contact note

Update the details of a contact note

path Parameters
note-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB
Request Body schema: application/json
required
note-date
string or null <date-time>

Defaults to the current date if left blank

note
required
string or null [ 1 .. 7000 ] characters
initials
required
string or null [ 1 .. 50 ] characters

Responses

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

Request samples

Content type
application/json
{
  • "note-date": "2022-07-22T08:58:00Z",
  • "note": "Meds collected. Claim form signed.",
  • "initials": "HJS"
}

Response samples

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

Discipline

Access and Manage disciplines for the practitioners

Retrieves Disciplines by Practitioner

Retrieve a list of discipline objects within the specified practitioner

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

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Discipline)
Array
discipline-uuid
string <uuid>
name
string

Response samples

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

Create Discipline for a Practitioner

Create Discipline for a Practitioner

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

Responses

Response Schema: application/json
object (DisciplineLinkUpdateResponse)

Response samples

Content type
application/json
{ }

Delete Discipline for a Practitioner

Delete Discipline for a Practitioner

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

Responses

Response Schema: application/json
object (DisciplineLinkUpdateResponse)

Response samples

Content type
application/json
{ }

Eligibility

Data for accessing and managing Eligibilities

Retrieve Eligibility Registrations

Retrieve a list of eligibility registrations for a contact

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

Pageable parameters

record-date-start
string <date-time>
Example: record-date-start=2021-07-02T00:00:00.00Z
record-date-end
string <date-time>
Example: record-date-end=2021-07-02T00:00:00.00Z

Responses

Response Schema: application/json
Array of objects (EligibilityRegistration)
Array
eligibility-uuid
string <uuid>
record-date
string <date-time>
eligibility-document-uuid
string <uuid>
eligibility-document-ref
string
eligibility-identification-uuid
string <uuid>
eligibility-identification-ref
string
expiry-date
string <date>
user-reference
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "eligibility-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "record-date": "2022-06-16T13:45:27Z",
      • "eligibility-document-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "eligibility-document-ref": "Discount",
      • "eligibility-identification-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "eligibility-identification-ref": "Passport",
      • "expiry-date": "2022-06-16",
      • "user-reference": "Passport"
      }
    ]
}

Create Eligibility

Create eligibility for a contact

path Parameters
contact-uuid
required
string <uuid>
Example: 918D012A-E5CE-4391-8D42-8396EF19CE83
Request Body schema: application/json
required
eligibility-document-uuid
required
string <uuid>
eligibility-document-ref
string <= 50 characters
eligibility-identification-uuid
required
string <uuid>
eligibility-identification-ref
string <= 50 characters
expiry-date-override
string <date>
user-reference
required
string <= 100 characters

Responses

Response Schema: application/json
eligibility-uuid
string <uuid>
message
string

Request samples

Content type
application/json
{
  • "eligibility-document-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "eligibility-document-ref": "string",
  • "eligibility-identification-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "eligibility-identification-ref": "string",
  • "expiry-date-override": "2022-06-16",
  • "user-reference": "string"
}

Response samples

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

Retrieve a presented document

Retrieve a single presented document

path Parameters
eligibility-document-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
eligibility-document-uuid
string <uuid>
name
string
description
string
account-type-uuid-active
string <uuid>
account-type-uuid-expired
string <uuid>
duration
integer <int32>
duration-type
string
Enum: "DAY" "WEEK" "MONTH" "YEAR" "MANUAL"
force-patient-deactivate
boolean
force-patient-discount-type
boolean
document-template-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "eligibility-document-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
  • "name": "Passport",
  • "description": "Passport",
  • "account-type-uuid-active": "D206E866-D7C3-4B67-997E-017E61FA94E2",
  • "account-type-uuid-expired": "D206E866-D7C3-4B67-997E-017E61FA94E2",
  • "duration": 7,
  • "duration-type": "MONTH",
  • "force-patient-deactivate": true,
  • "force-patient-discount-type": true,
  • "document-template-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2"
}

Retrieve presented documents

Retrieve a list of presented documents

query Parameters
required
object (Pageable)

Pageable parameters

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

Responses

Response Schema: application/json
Array of objects (PresentedDocument)
Array
eligibility-document-uuid
string <uuid>
name
string
description
string
account-type-uuid-active
string <uuid>
account-type-uuid-expired
string <uuid>
duration
integer <int32>
duration-type
string
Enum: "DAY" "WEEK" "MONTH" "YEAR" "MANUAL"
force-patient-deactivate
boolean
force-patient-discount-type
boolean
document-template-uuid
string <uuid>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "eligibility-document-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "name": "Passport",
      • "description": "Passport",
      • "account-type-uuid-active": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "account-type-uuid-expired": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "duration": 7,
      • "duration-type": "MONTH",
      • "force-patient-deactivate": true,
      • "force-patient-discount-type": true,
      • "document-template-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2"
      }
    ]
}

Retrieve a presented identification

Retrieve a single presented identification

path Parameters
eligibility-identification-uuid
required
string <uuid>
Example: 7ABA8B0A-F279-4175-AB3C-4203103822CB

Responses

Response Schema: application/json
eligibility-identification-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "eligibility-identification-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
  • "name": "Passport",
  • "description": "Passport"
}

Retrieve presented identifications

Retrieve a list of presented identifications

query Parameters
required
object (Pageable)

Pageable parameters

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

Responses

Response Schema: application/json
Array of objects (ProofOfId)
Array
eligibility-identification-uuid
string <uuid>
name
string
description
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "eligibility-identification-uuid": "D206E866-D7C3-4B67-997E-017E61FA94E2",
      • "name": "Passport",
      • "description": "Passport"
      }
    ]
}

Retrieve eligibility activation reasons

Retrieve a list of eligibility activation reasons

query Parameters
required
object (Pageable)

Pageable parameters

active
boolean

Responses

Response Schema: application/json
Array of objects (EligibilityActivationReason)
Array
activation-reason-uuid
string <uuid>
name
string
description
string
waiting-period-days
integer <int32>
deceased
boolean
active
boolean
visible
boolean
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "activation-reason-uuid": "2882E6F6-12EC-4E93-BD10-8053BBF56597",
      • "name": "Activate Animal - Manual Status Change",
      • "description": "Activate Animal - Manual Status Change",
      • "waiting-period-days": 7,
      • "deceased": false,
      • "active": true,
      • "visible": true,
      • "view-order": 2
      }
    ]
}

Retrieve eligibility activation reason

Retrieve an eligibility activation reason

path Parameters
activation_reason_uuid
required
string <uuid>
Example: EA73A5E7-98EA-4448-876D-335A6746BBC3

Responses

Response Schema: application/json
activation-reason-uuid
string <uuid>
name
string
description
string
waiting-period-days
integer <int32>
deceased
boolean
active
boolean
visible
boolean
view-order
integer <int32>

Response samples

Content type
application/json
{
  • "activation-reason-uuid": "2882E6F6-12EC-4E93-BD10-8053BBF56597",
  • "name": "Activate Animal - Manual Status Change",
  • "description": "Activate Animal - Manual Status Change",
  • "waiting-period-days": 7,
  • "deceased": false,
  • "active": true,
  • "visible": true,
  • "view-order": 2
}