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.

Create Referral (Post)

Required parameters Type Description
ClientId Object Containing Id GUID of the client
PractitionerId Object Containing Id GUID of the practitioner
ReferrerLocation Object Containing Id GUID of the ReferrerLocation

 

Optional parameters Type Description
StartDate Date StartDate of the Referral in the format – yyyy-mm-dd OR yyyy/mm/dd
EndDate Date EndDate of the Referral in the format – yyyy-mm-dd OR yyyy/mm/dd
Notes String Notes for the Referral
ReferralStatus String Status of the Referral can be – InProgress, Completed, Rejected, Deleted

Note: If there is no ReferralStatus in the JSON – InProgress will be assigned for the Referral

 

Example request URL: /Referral/

BODY:

{
   "ClientId":"F849D59A-C68B-49C6-8759-765A12AF555D",
   "PractitionerId":"C2DDF5B0-CF94-465A-B25B-A1CE9FB5F5E3",
   "StartDate":"2019-07-01",
   "EndDate":"2019-07-31",
   "Notes":"api add test",
   "ReferralStatus":"InProgress",
   "ReferrerLocation":{
      "Id":"0C49D8A7-9505-459A-B571-3594DF6FBD19"
   }
}
Example response
{
   "id":"c5706863-db1a-444f-815e-af5279cc02fb"
}

Develop with us

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


Please leave this field empty.