This article includes:
The API v4 consists of a transactional API service and a reporting API service.
The Help Center will detail all the methods available through the transactional and reporting API services and the data contract objects that are used by these methods.
It is recommended that developers automatically generate proxy clients for the PRiSMPro API services using the integrated development environment of their choice. These proxy clients can then be easily used to call the transactional and reporting API services.
Transactional API
The transactional API service has provisioning oriented methods that allow users to manage their devices and get information about trouble tickets.
The transactional API is available through JSON. All calls to this API require that the user's credentials are sent in a basic authentication HTTPS header with each request.
All error conditions raise a PRiSMProAPIFault which includes an errorCode and errorMessage field. If an unanticipated error occurs, the corresponding error code will be a SystemError.
A full list of PRiSMPro API status codes can be found in the response codes.
Any types listed will be detailed in the data contracts section.
Reporting API
The reporting API service has reporting oriented functions that allow the download of prepared reports such as billing reports.
The reporting API is only available via SOAP, and theFile data is encoded using MTOM.
All calls to this API require that the user's credentials are sent in a basic authentication HTTPS header with each request.
All error conditions raise a PRiSMProAPIFault which includes an errorCode and errorMessage field. If an unanticipated error occurs, the error code will be a SystemError.
A full list of PRiSMPro API status codes can be found in the response codes article.
Any types listed will be detailed in the Data Contracts section.
Data contracts
Data contracts are used by the Transactional and Reporting API services. All string values are nillable.