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 List of Clients

Optional parameters Type Description
pageNumber int Used for paging the list of client – identify what page to get (default = 1)
pageSize int Used for paging the list of client – identify the number of results per page (default = 50)

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/
Example response
{
   "clients":[
      {
         "title":"Mrs",
         "preferredName":"samya",
         "clientId":"a776074e-c80b-4640-b14f-23b0f1b0c0ef",
         "firstName":"Sama",
         "middleName":" ",
         "lastName":"Myra",
         "dateOfBirth":"1972-07-02T00:00:00+10:00",
         "gender":"Female"
      },
      {
         "title":"Mr",
         "preferredName":"",
         "clientId":"b816bd6b-d1e1-4476-a913-d225210e4dc7",
         "firstName":"Raam",
         "middleName":" ",
         "lastName":"Raheem",
         "dateOfBirth":"1946-09-03T00:00:00+10:00",
         "gender":"Male"
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[

   ]
}

Additional Parameter: Get A List of Clients With Additional Fields

Note: This function is only available on API version 2.1

URL https://<server domain name>/api/core/<version>/Client/?Field=phonenumbermobile&Field=email&...>
Description Retrieves all clients along with the specified additional fields

The following additional fields can be used:

  • phoneNumberHome
  • phoneNumberWork
  • phoneNumberMobile
  • phoneNumberFax
  • email
  • addressPostal
  • addressResidential

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/?Field=phonenumbermobile&Field=email
Example response
{
   "clients":[
      {
         "title":"Mr",
         "phoneNumberMobile":"0420000000",
         "email":"abgd@gmail.com",
         "clientId":"a776074e-c80b-4640-b14f-23b0f1b0c0ef",
         "firstName":"Sim",
         "middleName":" ",
         "lastName":"Optus",
         "dateOfBirth":"1972-08-03T00:00:00+10:00",
         "gender":"Male"
      },
      {
         "title":"Mr",
         "phoneNumberMobile":"0411111111",
         "email":"asdf@gmail.com",
         "clientId":"b816bd6b-d1e1-4476-a913-d225210e4dc7",
         "firstName":"Raam",
         "middleName":" ",
         "lastName":"Raheem",
         "dateOfBirth":"2006-08-03T00:00:00+10:00",
         "gender":"Male"
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[

   ]
}

Additional Parameter: Get A List of Clients Updated After Date

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

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

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/ ?updatedSince=2016-12-23%2014:43:30%2B1100

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

?updatedSince=2016-12-23%2014:43:30%2B1100 translates to

?updatedSince=2016-12-23 14:43:30+1100

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

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

Additional Parameter: Search clients by name

This is a client name filter for the Get client list which will retrieve a list of clients within the organisation whose names contains the provided keyword. The filter parameter is part of the URL on the client get call.

URL https://<server domain name>/api/core/<version>/Client/?name=<keyword>
Description Retrieve all clients whose names contains the provided keyword

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Client/?name=alex

 

 

Develop with us

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


Please leave this field empty.