Difference between revisions of "API Documentation"
| Line 27: | Line 27: | ||
=Common API Objects= | =Common API Objects= | ||
==PTSAPIEvent== | ==PTSAPIEvent== | ||
Many | Many methods use a PTSAPIEvent object as an input parameter. | ||
{| class="wikitable" | |||
!Property | |||
!Data Type | |||
|- | |||
userBarcode String | |<strong>userBarcode</strong> | ||
|String | |||
targetId Integer | |- | ||
|<strong>targetId</strong> | |||
targetType | |Integer | ||
|- | |||
|<strong>targetType</strong> | |||
|TargetType (Integer) | |||
|- | |||
|<strong>activityId</strong> | |||
dateRecorded Date | |Integer | ||
|- | |||
quantity Integer | |<strong>dateRecorded</strong> | ||
|Date | |||
userPassword String | |- | ||
|<strong>quantity</strong> | |||
|Integer | |||
|- | |||
|<strong>userPassword</strong> | |||
|String | |||
|} | |||
Revision as of 10:05, 18 July 2022
This documentation explains the various methods that can be called on the Application Programming Interface (API) that is exposed by the Prescription Tracking Application (PTS5).
The PTS5 API is an HTTP REST API. Examples using JSON format will be provided throughout the documentation.
Accessing the API
The API can be accessed at the following endpoints:
| Methods relating to Prescriptions | http://ptsservername/PTSWeb/api/Prescriptions |
| Methods relating to Events (activities recorded against prescriptions) | http://ptsservername/PTSWeb/api/Events |
| Methods relating to Notes | http://ptsservername/PTSWeb/api/Notes |
| Methods relating to Users | http://ptsservername/PTSWeb/api/Users |
“ptsservername” will need to be replaced by the name of the server that is hosting PTS5.
“PTSWeb” is the default path for installations. This may be different for your installation.
By default, only API calls that return patient identifiable data will expect any credentials to be passed. These credentials form a username and password that are sent in the GET request query string. To secure these credentials it is recommended that the PTS application is accessed via HTTPS.
Common API Objects
PTSAPIEvent
Many methods use a PTSAPIEvent object as an input parameter.
| Property | Data Type |
|---|---|
| userBarcode | String |
| targetId | Integer |
| targetType | TargetType (Integer) |
| activityId | Integer |
| dateRecorded | Date |
| quantity | Integer |
| userPassword | String |