API Documentation

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

PTSAPIEvent

Property Data Type

userBarcode String

targetId Integer

targetType TargetTypes (Integer)

Integer Target Type 0 None 1 Prescription 2 Bag 3 Ward 4 WardGroup

activityId Integer

dateRecorded Date

quantity Integer

userPassword String