coreplus API

The coreplus API provides access to appointment booking related end points, such as clients, practitioners, availability slots and appointments. It is a RESTful API, which utilises the HTTP verbs for creating viewing objects.

If you are a developer looking to create an external consumer server to server application for your coreplus clients, then by signing up for a sandbox account you will get access to your own trial coreplus account on our sandbox server with authorisation credentials.

SpecialtyType

URL https://<server domain name>/api/core/<version>/SpecialtyType/
Methods Supported GET
Description Retrieves a list of specialty types that can be used for searching for available time slots

 

Required parameters None

 

Optional parameters Type Description
getSubspecialties Boolean Flag to determine whether each practitioner’s sub-specialties should be included in the response (true/false)
getAppointmentTypes Boolean Flag to determine whether the appointment types associated with the practitioner’s specialties should be included in the response. (true/false)

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/SpecialtyType/?getSubSpecialties=true&getAppointmentTypes=true
Example response
{
  "specialtyTypes": [
    {
      "specialtyTypeId": "6af5f392-827c-49c4-9c12-9264e848fc18",
      "name": "Chripractic",
      "subSpecialties": [],
      "appointmentTypes": [
        {
          "appointmentTypeId": "a8f1c401-32ad-44a1-8177-97149248b8f6",
          "description": "Consultation",
          "durationMinutes": 60
        }
      ]
    },
    {
      "specialtyTypeId": "bafe9b2b-785f-438c-a1b4-657b0040bee5",
      "name": "Osteo",
      "subSpecialties": [
        {
          "subSpecialtyTypeId": "cafe9b2b-785f-438c-a1b4-657b0040bee5",
          "name": "Osteo Sub 2"
        },
        {
          "subSpecialtyTypeId": "6e708a47-50a7-4039-9415-7252931a95a2",
          "name": "Osteo Sub 3"
        }
      ],
      "appointmentTypes": [
        {
          "appointmentTypeId": "1f50fee7-28eb-4dc1-8ba5-8f0c15e91914",
          "description": "Follow Up",
          "durationMinutes": 30
        },
        {
          "appointmentTypeId": "a8f1c401-32ad-44a1-8177-97149248b8f6",
          "description": "Consultation",
          "durationMinutes": 60
        }
      ]
    }
  ]
}

Develop with us

Use the form to sign-up and start developing with coreplus today.


Please leave this field empty.