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.

Associate Client File (Post)

Required parameters Type Description
fileId String Guid of the file which you are going to associate
associationType String Guid of type of association.

*Currently available association types

  • ‘Referral Letter’: ‘882e3a82-6873-4d6f-9f37-0d2822812dc9’,
  • ‘Referral Response’: ’41e26e0d-35b1-4041-bf5d-043c56c6a5e8′,
  • ‘Pathology Report’: ‘5c2a2dd6-44a1-4518-a328-d1c139e376cf’,
  • ‘Fax’: ‘1d326c6c-1e39-43d0-b0c3-ca62274bf2e9’,
  • ‘Other’: ‘2fc3c52d-752b-4ace-8418-9ecdd9f298d0’
associatedEntity String To which entity you are assigning the file. *Currently there is only 1 entity i.e., Appointment
associatedPrimaryDomainKey String The entity’s guid, ie the appointment guid

 

Example request URL: https://sandbox.coreplus.com.au/API/Core/v2/FileAssociation/

BODY:

{
"fileId": " c070da2c-2b4f-462d-9e0e-41741f2c9bf6 ",
"associationType": "882e3a82-6873-4d6f-9f37-0d2822812dc9",
"associatedEntity": Appointment,
"associatedprimaryDomainKey": "4c1a30b6-467a-40f2-b3d9-205c86541818"
}
Example response
{
"id": "fd74e111-8c4c-4aa5-b16e-09ad5bff641e",
"fileId": " c070da2c-2b4f-462d-9e0e-41741f2c9bf6 ",
"associationType": "882e3a82-6873-4d6f-9f37-0d2822812dc9",
"associatedEntity": Appointment,
"associatedprimaryDomainKey": "4c1a30b6-467a-40f2-b3d9-205c86541818"
}

Develop with us

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


Please leave this field empty.