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 Referrals for a Client

URL https://<server domain name>/api/core/<version>/Referral/
Description Get Referral details of the client

 

Required Parameters Type Description
clientId Object Containing Id GUID of the client

 

Example request URL: /Referral/?clientId=5abcceac-0fdb-4c5a-93db-02549ba2fe3e
Example response
{
   'count':1,
   'pageCount':1,
   'pageNumber':1,
   'pageSize':30,
   'referrals':[
      {
         'id':'661349af-ec46-4954-805a-bb95d204ae23',
         'clientId':'5abcceac-0fdb-4c5a-93db-02549ba2fe3e ',
         'practitionerId':'b630f4ad-8b4b-4e06-8cee-7db56ba8b9bf',
         'referralStatus':'InProgress',
         'startDate':'2019-07-31T00:00:00',
         'endDate':'2019-07-31T00:00:00',
         'notes':'Testing referral endpoint 31Jul19-12:17:46',
         'active':True,
         'referrerLocation':{
            'id':'922c7b17-a67a-4894-a3e8-d20966756ae1',
            'referrerId':'1b5a7eba-05e8-4df1-9619-b5b971990f6a',
            'clinicId':'61c79967-1a7d-424b-a820-eae34b29b362',
            '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-07-30T08:41:29.72',
            'updatedAt':'2019-07-30T08:41:29.72'
         },
         'createdAt':'2019-07-31T12:17:50.073',
         'updatedAt':'2019-07-31T12:17:51.65'
      }
   ]
}

Develop with us

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


Please leave this field empty.