Start using the SOAP APIs
Before integrating our SOAP APIs, read through the following information to help you get started:
The following are the schema definitions for our SOAP APIs:
The following describes the status codes that result from successful and unsuccessful calls to our SOAP APIs:
If your company uses SOAP, then the process for error detection is different than under REST. Under SOAP, only two HTTP Status Codes are returned.
- Codes in the 2xx range indicate that the function call was successful.
- Codes in the 5xx range indicate an error on the cleverbridge side.
|200||Request did not fail due to server error.|
|500||Request failed due to server error.|
Upon calling an API endpoint, check the HTTP header status code.
- If the status code is 500, then the call failed due to a server error.
- In case of a non-500 status code, search the XML body for a fault node. If a fault node is found, then the call failed. Evaluate the following fault subnodes:
faultcode: Provides information on the type of error that occurred.
faultstring: Contains the error message to aid in handling the error appropriately.
If a fault node is not found, then the call was successful.
The use cases for the SOAP APIs are similar to the backend REST APIs. For more information, see Start using the Backend REST APIs.