Document
| API | Description |
|---|---|
| GET document/document/getanonymous?session_id={session_id}&document_key={document_key} |
Get PDF file by passing in the document_key and a valid session_id. Document_key can be obtained from the prescription information |
| GET Document?session_id={session_id}&document_key={document_key} |
Get PDF file by passing in the document_key and a valid session_id. Document_key can be obtained from the prescription information |
Catalog
| API | Description |
|---|---|
| GET catalog/search?searchText={searchText}&pagesize={pagesize}&pageNumber={pageNumber}&session_id={session_id} |
Search product by name |
| POST catalog/add |
Add new product |
| GET Catalog?product_id={product_id}&session_id={session_id} |
Get product from its product_id |
Prescription
| API | Description |
|---|---|
| GET prescription/web?patient_id={patient_id}&doctor_id={doctor_id}&session_id={session_id} |
Get prescription webpage UI link for adding to an external system via Iframe etc. configured to work on IE7+ |
| GET prescription/status |
Get prescription status for multiple prescription references |
| GET prescription/updates?token={token}&sinceDateTime={sinceDateTime}&session_id={session_id} |
Get prescription status for multiple prescription references |
| POST prescription/Web2 |
V2. Get prescription webpage UI link for adding to an external system via Iframe etc. configured to work on IE7+ |
| PUT prescription/cancel?reference_no={reference_no}&session_id={session_id} |
Update Prescription status, default: cancel |
| GET prescription/statusupdates |
No documentation available. |
| PUT prescription/statusconfirmation?statusUpdateId={statusUpdateId} |
No documentation available. |
| DELETE prescription/resetstatuses |
No documentation available. |
| GET Prescription?reference_no={reference_no}&session_id={session_id} |
Get prescription from reference_no |
| POST Prescription |
Add prescription |
Patient
| API | Description |
|---|---|
| GET patient/addresstype?session_id={session_id} |
Get patient address types. this is needed when adding different address types for a new patient |
| GET Patient?patient_id={patient_id}&session_id={session_id} |
Get patient from their ID |
| POST Patient |
Add new patient |
| PUT Patient |
Updating patient |
Register
| API | Description |
|---|---|
| POST Register/Update |
Update existing user details |
| GET Register/Usertype?session_id={session_id} |
Get different user types. this is needed in order to define the user type when adding a new user to the system |
| GET Register/Clinic?postcode={postcode}&session_id={session_id} |
lookup clinics by postcode |
| GET Register/Web |
Get registration webpage UI link for adding to an external system via Iframe etc. configured to work on IE7+ |
| GET Register?username={username}&session_id={session_id} |
Lookup us if a user exists via their username. this is only for an exact match. |
| POST Register |
Register a new user |
Login
| API | Description |
|---|---|
| POST Login |
Login to the API, This will provide a session_id that will need to passed into all the other API end points. |
Ping
| API | Description |
|---|---|
| GET Ping |
Login to the API, This will provide a session_id that will need to passed into all the other API end points. |
ApiPDF
| API | Description |
|---|---|
| POST ApiPDF |
No documentation available. |
Authorise
| API | Description |
|---|---|
| GET Authorise?reference_no={reference_no}&session_id={session_id} |
Check to see if a script is authorised using reference_no and session_id |
| POST Authorise |
Authorise a script using reference_no, you can set this against a doctor_id with the correct pin |