Skip to main content
API docs by Redocly

Location Management (3.0.0)

Location

Access and Manage locations (sites) of the tenant's practice

Retrieve Locations

Retrieve a list of locations

query Parameters
required
object (Pageable)

Pageable parameters

Responses

Response Schema: application/json
Array of objects (Location)
Array
location-uuid
string <uuid>
name
string
name-no
string
address1
string
address2
string
city
string
county
string
postcode
string
view-order
integer <int32>
main
boolean
locale
string
phone
string
vat-no
string
fax
string
practice-name
string
email-address
string <email>
website
string
region-uuid
string <uuid>
timezone
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Kingston",
      • "name-no": "3",
      • "address1": "Pine Hill River Street",
      • "address2": "Surrey",
      • "city": "Kingston Upon Thames",
      • "county": "Surrey",
      • "postcode": "GU7 3HT",
      • "view-order": 2,
      • "main": false,
      • "locale": "en_GB",
      • "phone": "+44 8896367543",
      • "vat-no": "GB 123 4567 89",
      • "fax": "+44 8896367544",
      • "practice-name": "Vets Kingston",
      • "email-address": "fakeemail@faekdomain.com",
      • "website": "www.fake.domain.com",
      • "region-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "timezone": "Europe/Chisinau"
      }
    ]
}

Retrieve Location

Retrieve a single location

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

Responses

Response Schema: application/json
location-uuid
string <uuid>
name
string
name-no
string
address1
string
address2
string
city
string
county
string
postcode
string
view-order
integer <int32>
main
boolean
locale
string
phone
string
vat-no
string
fax
string
practice-name
string
email-address
string <email>
website
string
region-uuid
string <uuid>
timezone
string

Response samples

Content type
application/json
{
  • "location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "Kingston",
  • "name-no": "3",
  • "address1": "Pine Hill River Street",
  • "address2": "Surrey",
  • "city": "Kingston Upon Thames",
  • "county": "Surrey",
  • "postcode": "GU7 3HT",
  • "view-order": 2,
  • "main": false,
  • "locale": "en_GB",
  • "phone": "+44 8896367543",
  • "vat-no": "GB 123 4567 89",
  • "fax": "+44 8896367544",
  • "practice-name": "Vets Kingston",
  • "email-address": "fakeemail@faekdomain.com",
  • "website": "www.fake.domain.com",
  • "region-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
  • "timezone": "Europe/Chisinau"
}

Space

Access and Manage spaces within the locations (stock centres, etc)

Retrieves Spaces By Location

Retrieve a list of space objects within the specified location

path Parameters
locations-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 (LocationSpace)
Array
location-space-uuid
string <uuid>
parent-location-uuid
string <uuid>
name
string
description
string
view-order
integer <int32>
main
boolean

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "location-space-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "parent-location-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "name": "Kingston Warehouse",
      • "description": "Kingston Warehouse (Central)",
      • "view-order": 3,
      • "main": false
      }
    ]
}

Discipline

Access and Manage disciplines

Retrieves all Disciplines

Retrieve a list of discipline objects

query Parameters
required
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"
      }
    ]
}

Retrieves Disciplines By Location

Retrieve a list of discipline objects within the specified location

path Parameters
location-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 (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 Location

Create Discipline for a Location

path Parameters
location-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 Location

Delete Discipline for a Location

path Parameters
location-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
{ }

Region

Access and Manage location grouping

Retrieve Regions

Retrieve a list of regions

query Parameters
required
object (Pageable)

Pageable parameters

Responses

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

Response samples

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

Retrieve Region

Retrieve a single region object

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

Responses

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

Response samples

Content type
application/json
{
  • "region-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
  • "name": "Head Office"
}

Retrieve Region's Locations

Retrieve a list of locations within the specified region.

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

Responses

Response Schema: application/json
Array of objects (Location)
Array
location-uuid
string <uuid>
name
string
name-no
string
address1
string
address2
string
city
string
county
string
postcode
string
view-order
integer <int32>
main
boolean
locale
string
phone
string
vat-no
string
fax
string
practice-name
string
email-address
string <email>
website
string
region-uuid
string <uuid>
timezone
string

Response samples

Content type
application/json
{
  • "results": [
    • {
      • "location-uuid": "918D012A-E5CE-4391-8D42-8396EF19CE83",
      • "name": "Kingston",
      • "name-no": "3",
      • "address1": "Pine Hill River Street",
      • "address2": "Surrey",
      • "city": "Kingston Upon Thames",
      • "county": "Surrey",
      • "postcode": "GU7 3HT",
      • "view-order": 2,
      • "main": false,
      • "locale": "en_GB",
      • "phone": "+44 8896367543",
      • "vat-no": "GB 123 4567 89",
      • "fax": "+44 8896367544",
      • "practice-name": "Vets Kingston",
      • "email-address": "fakeemail@faekdomain.com",
      • "website": "www.fake.domain.com",
      • "region-uuid": "7ABA8B0A-F279-4175-AB3C-4203103822CB",
      • "timezone": "Europe/Chisinau"
      }
    ]
}

Location Identifiers

Access location identifiers

Retrieve Location identifiers

Retrieve a list of Location identifiers.

query Parameters
required
object (Pageable)

Pageable parameters

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

Responses

Response Schema: application/json
Array of objects (LocationIdentifiers)
Array
location-uuid
string <uuid>
site-id
integer <int32>

Response samples

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