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

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",
   "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":false
   },
   "statusMessages":[

   ]
}

Example response (conflict or timeslot not available):

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

coreplus API

Develop with us