REST vs SOAP - BlueCat Integrity - 9.5.0

Address Manager Legacy v1 API Guide

Product name
BlueCat Integrity

The v1 REST APIs have many similarities with the widely used SOAP-based APIs supported by Address Manager. However, there are a few things to note regarding the v1 REST interface and existing SOAP implementation:

  • The names of API methods for v1 REST remain the same as the SOAP API names.
  • Signatures of all methods including input and output parameters in v1 REST are the same as in SOAP.
  • For v1 REST APIs, various primitive request parameters such as int, long, and String are expected as URL query parameters. Whereas in SOAP, all the request parameters are communicated as part of XML body.
  • Complex parameter types such as APIEntity or APIDeploymentOption need to be passed as a part of HTTP body of the call in JSON format.