This reference manual is for developers interested in integrating third-party applications with PRISM for the purpose of initially loading or on-going synchronization. 

It is beyond the scope of this reference manual to discuss PRISM usage or the relationship between PRISM objects (i.e. the relationship between contracts and master agreements).  This information is available in the PRISM Reference Guide.

This guide assumes you:

1.Understand how to view and use the WSDL

2.Understand how to consume web-based services

The PRISM API is based on the SOAP API protocol.  SOAP is a mature, XML-based protocol for connecting applications and servers to web-based back-end services.  Typical SOAP solutions involve desktop applications, enterprise servers, and/or public-facing web products.

PRISM's SOAP API provides an infrastructure that allows you to make create(), get(), update(), and delete() calls on primary PRISM data objects.  You will need to understand the PRISM simple object model to become proficient with the web-based API. 

The PRISM API does not provide absolute control of PRISM.  However, using the API will allow an organization to preform an initial load of data and keep PRISM synchronized with other sources of record.  And, when PRISM is considered the source of record, fundamental PRISM data may be retrieved via the API.

The basic PRISM data objects include vendors, contracts, prime payments, sub payments, and payrolls.  In each case end points (web methods) are provided to perform create, delete, get, and update operations.  For security reasons, the API is throttled.  That is, only sixty (60) calls may be requested to the API over a one minute period.  Moreover, three (3) unsuccessful authentications by the API may result in the consumer IP addresses being blacklisted.

Note: There may be cases where the API reference guide is out of order with the WSDL.  In these cases the information provided by the WDSL takes precedence.

Want to report an issue, click here!