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.

If you have any questions regarding the API documentation, please do not hesitate to contact us at integrations@coreplus.com.au

Make A Booking (Post)

Required parameters	Type	Description
startDateTime	DateTimeOffset	The start time for the appointment (yyyy-mm-dd hh:mm + timezone offset) (24 hour time)
endDateTime	DateTimeOffset	The end time for the appointment (yyyy-mm-dd hh:mm+ timezone offset) (24 hour time).
practitioner	Object containing Id	The id of practitioner for whom to book the appointment (within a practitioner object)
locationId	String(50)	The id of the location for where the appointment is (see get locations).
clients	Array of objects containing Ids	An array of the client ids for this appointment – each within a client object (at least one). Note: Currently only 1 client is supported.

Optional parameters	Type	Description
appointmentTypeId	String(50)	The id of the applicable appointment type (see endpoint “Specialty Types”)
subject	String(300)	If not provided, coreplus will use the name of the client and their date of birth as the subject
notes	String(300)	Adds any relevant information related to the appointment
isEmailReminderRequired	Boolean	Flag to determine whether the appointment will send an email reminder to the client using the client’s associated email address. (true/false)
isSmsReminderRequired	Boolean	Flag to determine whether the appointment will send an SMS reminder to the client using the client’s associated mobile number. (true/false) Note: SMS will be flagged as true ONLY if the given client has a mobile number associated with their record
notifyPractitioner	Boolean	Flag to determine whether an SMS notification will be sent to the practitioner associated with the appointment (true/false)

Example request

URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/

BODY:

{
   "startDateTime":"2017-07-21T11:00+10:00",
   "endDateTime":"2017-07-21T11:30+10:00",
   "practitioner":{
      "practitionerId":"a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf"
   },
   "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
   "appointmentTypeId":"6e74f531-6392-4b5a-b507-9f732c557778",
   "notes":"Post some notes",
   "notifyPractitioner":"true",
   "appointmentReminder":{
         "isEmailReminderRequired":"false",
         "isSmsReminderRequired":"true"
      },
   "clients":[
      {
         "clientId":"a776074e-c80b-4640-b14f-23b0f1b0c0ef"
      }
   ]
}

Example response

{
   "appointment":{
      "appointmentId":"dbb1a5bb-0fff-450f-b3de-994252fd37d6",
      "appointmentReferenceNumber":"75592468",
      "practitioner":{
         "practitionerId":"a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf"
      },
      "subject":"Test Client 041234567",
      "notes":"Post some notes",
      "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
      "appointmentTypeId":"6e74f531-6392-4b5a-b507-9f732c557778",
      "startDateTime":"2017-07-21T11:00:00 +10:00",
      "endDateTime":"2017-07-21T11:30:00 +10:00",
      "clients":[
         {
            "clientId":"a776074e-c80b-4640-b14f-23b0f1b0c0ef"
         }
      ],
      "notifyPractitioner":true
   },
   "statusMessages":[

   ]
}

Example response (conflict or timeslot not available):

{
   "result":[
      {
         "severity":"error",
         "reason":"The selected time is not available for booking an appointment"
      }
   ]
}

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

coreplus API

Make A Booking (Post)

Develop with us