Introduction

The Priority REST API is based on the Open Data Protocol (OData), a data access protocol built on HTTP and REST. This documentation provides basic examples of the various requests and responses you can make using the Priority REST API. For a more detailed understanding of OData, please refer to OData Documentation.

Service Root URL

All the examples in this documentation are based on sample requests made to a Priority OData service. Please replace the serviceRoot below with a service root URL appropriate to your installation of Priority. Note that all other URLs in the OData service use this URL as a basis. Consult with your System Administrator if you are not sure what the service root for your installation is.

Authentication

The Priority OData service requires that every HTTP request contain an authentication header according to the Basic-Authentication standard, in order to apply any relevant permission restrictions. HTTP requests that lack such a header will be denied. Consult with your System Administrator if you do not have a valid user or password.

Personal Authentication Tokens

Accessing the API via Personal Authentication Tokens is available as of version 19.1 of Priority, but may be available for versions starting with 18.3 upon special request.

To use an authentication token to access the Rest API, your System Administrator must first generate the token. To access the Rest API via the token, specify the following credentials:

Username INSERT TOKEN HERE

Password PAT

Application License

In version 18.3, Priority Software introduced an additional form of licensing - per-application licenses. When accessing the system under this license, requests to the Priority OData service must contain additional headers providing application license information:

Header Contents
X-App-Id The unique application ID assigned to your application by Priority Software.
X-App-Key The unique application license key assigned to your application by Priority Software.

Example:

X-App-Id: APP001
X-App-Key: 15nXqSDXnNeaIEFQSSDXkNeZ16DXodeV16TXmSDXoteb16nXmdeVISEh

Requests that do not contain these headers will be treated as using generic API licensing.

Features by Version

Certain features are tagged with a version number reflective of the Priority version in which they were released. Features in development are marked as Beta, indicating they will be available in the next Priority release. In certain cases, features (including beta features) can be obtained for previous versions of Priority pending a request to Priority Software.

Postman Collection

Run in Postman

You can use this Postman collection to run the requests in the API against our demo environment. For authentication, use the following credentials:

Username apidemo

Password 123

Error Message Format

Starting with version 19.1 of Priority, the REST API can output errors in either JSON or XML format.

To change the error format, ask the Priority System Administrator to change the value of the RESTERRSFORMAT constant in Priority. System constants can be found through the menu path System Management > System Maintenance > Constant Forms > System Constants in Priority.