Introduction

The IPS API exposes operational and track and trace functions. It can be used both in SOAP and RESTful mode.

This API reference explains each of the API endpoints, with example SOAP and REST requests and responses included.

Note: The HTTP requests in the reference are in format http://[hostname:port]/IPSAPIService/xxx. This format may vary in your own environment, depending on whether HTTP or HTTPS is used, and on the name of the web application specified during installation.

Authorization

To use the IPS API, you need to include a token with each call (a GUID that is associated with one or more API operations). You can create new IPS API tokens using the IPS API Management App and associate them with the API methods you want to use. Fore more information, see the IPS API Administrator Guide.

Response codes

The table below gives an overview of the HTTP response codes. For more specific error information, see the relevant endpoint reference page.

Code	Meaning
200	Success
400	Bad Request -- data in the request body is invalid
401	Unauthorized -- authorization failed
500	Internal Server Error -- an exception occurred

If an error or a code other than HTTP 200 is returned, see the response body for details. The format of a JSON error response body is shown below.

Error response body format

    {
      Errors: [
        "Error message 1", "Error message 2"...
      ]
    }