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 ReferrerLocations

Required parameters Type Description
referrerId Object containing Id Id of the Referrer
clinicId Object containing Id Id of the clinic
isActive Boolean Active status of the location – True, False

 

Optional parameters Type Description
search String Get list of locations matching the search term (search term can be referrer name or clinic name)
pageNumber Int Used for paging the list of Clinics – identify what page to get (default = 1)
pageSize Int Used for paging the list of Clinics – identify the number of results per page (default = 10)

 

Example request URL: /ReferrerLocation/?referrerId=db5e4559-8c92-4110-b4c5-e271c24728d2&clinicId=&isActive=&search=123&pageNumber=1&pageSize=10

Note: Either ReferrerId or ClinicId is mandatory in the url

If given ReferrerId in the URL – Gets list of locations for the Referrer

If given ClinicId in the URL – Gets list of Referrers for the clinic

Example response
{
   "count":2,
   "pageCount":1,
   "pageNumber":1,
   "pageSize":10,
   "referrerLocations":[
      {
         "id":"bc023e31-8c89-4d2f-b150-3e47d7988bfc",
         "referrerId":"db5e4559-8c92-4110-b4c5-e271c24728d2",
         "clinicId":"f65b1e46-ac5c-41c8-8c5d-e4ae9a5844c3",
         "profession":"GP",
         "street":"21 fronty avenue",
         "suburb":"FOOTSCRAY VIC",
         "postCode":"3011",
         "state":"",
         "phone":"0300000000",
         "mobile":"0400000000",
         "fax":"0300000000",
         "email":"asder@email.com",
         "providerNumber":"1234567X",
         "active":true,
         "createdAt":"2019-06-11T16:20:25.897",
         "updatedAt":"2019-06-11T16:25:14.947"
      },
      {
         "id":"7916cdd8-c0ac-40ef-8e59-8fd568e43766",
         "referrerId":"db5e4559-8c92-4110-b4c5-e271c24728d2",
         "clinicId":"6ffe53af-61d0-4d33-ab21-9fecf1605dbf",
         "profession":"GP",
         "street":"21 auto street",
         "suburb":"FOOTSCRAY VIC",
         "postCode":"3011",
         "state":"",
         "phone":"0300000",
         "mobile":"0400000000",
         "fax":"00123",
         "email":"asder@automail.com",
         "providerNumber":"4000000A",
         "active":true,
         "createdAt":"2019-06-11T16:05:38.057",
         "updatedAt":"2019-06-11T16:05:38.057"
      }
   ]
}

 

Develop with us

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


Please leave this field empty.