Cardinus PACE API

The Cardinus.PACE API v1.0 delivers a simple application interface for your organisation. It allows you to develop a client application that can connect to your PACE system and perform certain actions.

It uses the RESTful approach to retrieve, add and update items within the PACE Administration system using standard HTTP methods.

The following areas of PACE can be queried and accessed via the API:

• Users
• Training
• Assessments
• Tasks
• Programmes
• Reports

To get started, read the documentation for setting up your API key before moving on to the different available endpoints.

Conventions

To keep the development of client applications simple, the API uses the following conventions:

• The authentication headers must be included in every request.

• The HTTP method indicates the action being taken.

  Method	Purpose
  get	Retrieving data only.
  post	Creating a new record, or sending advanced filter criteria when retrieving records.
  put	Updating an entire record.
  patch	Partially updating a record.
  delete	Deleting a record.

• All data sent in the body of a request must be valid JSON, with the content-type header set to application/json in the request.

• All responses returned by the API that are successful will return as JSON with the content-type header set to application/json in the response. †
• Properties in payload data and in response data are in PascalCase. ‡
• Errors follow the standards given in RFC7807. See Error responses for details.
• Dates are UTC time.
• Unique identifiers in GUID (UUID) format contain hyphens but no brackets. 00000000-0000-0000-0000-000000000000.
• When sending GUIDs to the endpoints (e.g. requesting specific records), the GUIDs are case insensitive.

† This behaviour can be overridden when running reports by passing through an Accept header in the request. See the Running reports documentation for more information about this feature.

‡ The object returned in non-success results are camelCase.

Updates

The API may receive updates in future which add functionality and data. Cardinus will not modify existing endpoints or the existing properties on data models, but potentially may add new properties to the data models returned from and sent to the endpoints.

Important

Ensure that the client JSON parsing logic does not fail upon encountering unexpected properties.

If an update is to be made that will modify the existing properties or endpoints then this will be restricted to new API endpoints which will be available with a version number.