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.

AvailabilitySlot

URL https://[server domain name]/api/core/[version]/AvailablitySlot/
Methods Supported GET
Description Retrieves a set available timeslots within a given date range.

 

Required parameters Type Description
startDate Date The start date of the period in which to search for free timeslots (yyyy-mm-dd)
endDate Date The end date of the period in which to search for free timeslots (yyyy-mm-dd)
timezoneId String(50) The timezoneId of the time zone for the search. Input times are assumed to be in this time zone, and results are returned in that time
zone. See GetLocations to determine the timezoneId for a given location.
pageNumber Int The page number of the results to return. The first page is 1, and so on. The results from row 1 to row 50 can be obtained by setting a
pageNumber 1 and a pageSize of 50. The results from row 51 to row 100 can be obtained by setting a pageNumber 2 and a pageSize of 50.
pageSize Int The maximum number of rows to return for the page. The pageSize is limited to a maximum of 100 at the time of writing.

 

Optional parameters Type Description
specialtyId String(50) Search filter: a list of specialties for which to search for available slots. (multiple items can be included for multiple specialties)
appointmentTypeId String(50) The id of the appointment type. (see endpoint “Specialty Types”)When this parameter is given, it will split the available time slots by the appointment type’s time duration. Otherwise the available time slots will not be split.
Example request https://sandbox.coreplus.com.au/API/Core/v2/AvailabilitySlot/?startDate=2015-08-19&endDate=2015-08-19&timezoneId=39D62534-501C-49CD-9DA9-6FA8D6A81F48&pageNumber=1&pageSize=50
Example response
{
   "timeslots":[
      {
         "practitioner":{
            "practitionerId":"a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf"
         },
         "startDateTime":"2017-07-21T09:00:00+10:00",
         "endDateTime":"2017-07-21T12:00:00+10:00",
         "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
         "utcOffsetHours":10.0
      },
      {
         "practitioner":{
            "practitionerId":"a630f4ad-8b4b-4e06-8cee-7db56ba8b9bf"
         },
         "startDateTime":"2017-07-21T13:00:00+10:00",
         "endDateTime":"2017-07-21T17:00:00+10:00",
         "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
         "utcOffsetHours":10.0
      }
   ],
   "paging":{
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[]
}

Develop with us

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


Please leave this field empty.