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 Locations

 

Required parameters None

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Location/
Example response
{
   "locations":[
      {
         "locationId":"5416fe6b-77ea-4be9-bb0f-ce077c97792e",
         "name":"Jurong site",
         "streetAddress":"20 Sandro ave",
         "postcode":"2322",
         "suburb":"Chisholm NSW",
         "state":"",
         "country":"Australia",
         "timeZone":{
            "timezoneId":"5cc83375-4b61-4a17-9a77-59657cf3da64",
            "tzName":"Australia\\Sydney"
         }
      },
      {
         "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
         "name":"Main Site",
         "streetAddress":"21 swanston street",
         "postcode":"3000",
         "suburb":"MELBOURNE, VIC",
         "state":"",
         "country":"Australia",
         "timeZone":{
            "timezoneId":"39d62534-501c-49cd-9da9-6fa8d6a81f48",
            "tzName":"Australia\\Melbourne"
         }
      }
   ],
   "paging":{
      "totalRows":2,
      "pageNumber":1,
      "pageSize":50
   },
   "statusMessages":[ ]
}

 

 

Optional parameters Type Description
getContactDetails Boolean Retrieves contact details of the location
pageNumber int Used for paging the list of locations – identify what page to get (default = 1)
pageSize int Used for paging the list of locations – identify the number of results per page (default = 50)

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/Location/?getContactDetails=true
Example response
{
   "locations":[
      {
         "locationId":"5416fe6b-77ea-4be9-bb0f-ce077c97792e",
         "name":"Jurong site",
         "streetAddress":"20 sandro ave",
         "postcode":"2322",
         "suburb":"Chisholm NSW",
         "state":"",
         "country":"Australia",
         "timeZone":{
            "timezoneId":"5cc83375-4b61-4a17-9a77-59657cf3da64",
            "tzName":"Australia\\Sydney"
         },
         "contactDetails":{
            "contactName":"Mr Test",
            "contactNumber":"0400000000",
            "contactFax":"0300000000",
            "contactEmail":"example@test.com.au"
         }
      },
      {
         "locationId":"d8d4fe7c-765a-46a3-a389-54ce298a27e9",
         "name":"Main Site",
         "streetAddress":"21 swanston street",
         "postcode":"3000",
         "suburb":"MELBOURNE, VIC",
         "state":"",
         "country":"Australia",
         "timeZone":{
            "timezoneId":"39d62534-501c-49cd-9da9-6fa8d6a81f48",
            "tzName":"Australia\\Melbourne"
         },
         "contactDetails":{
            "contactName":"Kevin Sam",
            "contactNumber":"0400000000",
            "contactFax":"1111111111",
            "contactEmail":"ms@test.com"
         }
      }
   ],
   "paging":{
      "totalRows":2,
      "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.