This page describes the services provided by TPS REST API v1.

Each resource will have a unique URL which will be in the following pattern:

• Single resource: /tps/rest/<resource name>

• Collection of resources: /tps/rest/<resource collection>/<resource ID>

The current TPS operations (eg. op=…​) will be mapped into the following HTTP operations:

• GET: searching resources or retrieving individual resource

• POST: adding an object

• PATCH: modifying an object

• DELETE: removing an object

All requests and responses will be sent in XML/JSON format.

These operations will return HTTP 200 (OK) return code upon successful operation. One exception is a successful add operation will return HTTP 201 (Created) and the URL of the newly created resource. Normal application errors will return HTTP 4xx return code. Unexpected server error will return HTTP 5xx return code.

Search operations may support paging. The server will return one page that contains a subset of the search result. The server will also return the total number of entries in the result. The client may request a specific page and also the number of entries per page.

The add and modify operations will return the updated object back, similar to the result of a GET operation. This way the client does not need to send another request to get the object after performing an update.

Some of the TPS operations will not be mapped into REST operations because the are purely used to generate the HTML page which is irrelevant for REST.