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.

Get A List of Appointments

Required parameters Type Description
startDate Date The start date of the period in which to search for appointments (yyyy-mm-dd)
endDate Date The end date of the period in which to search for appointments (yyyy-mm-dd)
timezoneId String(50) The timezoneId of the time zone for the search. Input dates 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.

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/?startDate=2021-09-07&endDate=2021-09-10&timezoneId=39D62534-501C-49CD-9DA9-6FA8D6A81F48
Example response
{
   "appointments":[
      {
         "appointmentId":"5dba9dc2-fecc-4fc3-b16f-6a09d6fbba75",
         "appointmentReferenceNumber":"4846396",
         "status":"Attended",
         "practitioner":{
            "practitionerId":"198f2d42-953b-441f-835e-0e4e15422824"
         },
         "subject":"ADAM Luke 0400000000",
         "locationId":"3c0639cc-0849-438e-b16e-aafd9548a0b8",
         "appointmentTypeId":"4aaa98e1-4bf6-44be-9f1e-eaf7d9a23a76",
         "startDateTime":"2021-09-07T09:00:00 +10:00",
         "endDateTime":"2021-09-07T09:30:00 +10:00",
         "clients":[
            {
               "clientId":"1a4d6238-1be7-4ea3-9436-8d67c2cccd6b"
            }
         ],
         "notifyPractitioner":false
      },
      {
         "appointmentId":"9796ccaf-df93-4788-904e-9f9407a1843e",
         "appointmentReferenceNumber":"15272580",
         "status":"Booked",
         "practitioner":{
            "practitionerId":"198f2d42-953b-441f-835e-0e4e15422824"
         },
         "subject":"JEETH Jadam 0400000000",
         "locationId":"3c0639cc-0849-438e-b16e-aafd9548a0b8",
         "appointmentTypeId":"1fdc3bab-7a37-4423-a44c-ce231a9d1719",
         "startDateTime":"2021-09-07T10:00:00 +10:00",
         "endDateTime":"2021-09-07T10:30:00 +10:00",
         "clients":[
            {
               "clientId":"4b24a646-7604-4c3d-8a84-23d48ec88558"
            }
         ],
         "notifyPractitioner":false
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[ ]
}

 

Optional parameters Type Description
status String Gets list of appointments filtered by appointment status.

Must be one of the following 4 allowed values:

Attended – Retrieves list of Attended Appointments

Cancelled – Retrieves list of Cancelled Appointments

No Show – Retrieves list of No Show Appointments

Rescheduled – Retrieves list of Rescheduled Appointments

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.

 

Note: Get Appointment list will not return Deleted Appointments

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/?startDate=2021-08-19&endDate=2021-08-20&timezoneId=39D62534-501C-49CD-9DA9-6FA8D6A81F48&status=Cancelled&status=No%20Show

This request will returns list of Cancelled and No Show appointments with in the specified date range

Additional Parameter: Get A List of Appointments Updated After Date

This is an appointment update filter for the Get appointment list which will retrieve a list of appointments within the organisation only where the appointment’s details have been updated after a specified date and time. The filter parameter is part of the request on the appointment get call.

URL https://<server domain name>/api/core/<version>/Appointment/?updatedSince=<Url encoded date time stamp with timezone>
Description Retrieve all appointments that have had appointment details updated since the specified date time stamp

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Appointment/?startDate=2017-06-30&endDate=2017-06-30&timezoneId=39D62534-501C-49CD-9DA9-6FA8D6A81F48&getPractitionerProfiles=true&updatedSince=2017-06-30%2014:18:00%2B1000

The date time stamp is url encoded so in the above example

?updatedSince=2017-06-30%2014:18:00%2B1000 translates to

?updatedSince=2017-06-30 14:18:00+1000

See http://www.url-encode-decode.com/ for an encoding decoding example

The returned result will be the same as a normal Appointment Get call except it will be filtered by the requested date time stamp

Develop with us

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


Please leave this field empty.