Review SOAP Envelopes to Retrieve Information

The SOAP envelope represents all of the elements included in a message. Use this SOAP envelope to review the information present in the message and use your preferred coding language to retrieve information from that envelope.

When reviewing SOAP envelopes, you see two different types of envelopes:

  1. Request - the information passed from you to the API
  2. Response - the information generated by the API after processing your request and returned to you

The example below represents a typical SOAP request envelope:

The example below represents a typical SOAP response envelope.Use this envelope as the model for all calls in this technical article:

The SOAP envelopes include a client ID value used to perform calls in sub-accounts, such as in an Enterprise 2.0 account. If you are performing the action in the same account you are logged into, you don't need to include this value.

In addition to retrieving information from SOAP envelopes, you can use them to get information about errors. The SOAP request below fails because no client ID is specified and the application couldn't find the applicable triggered send because it was located in another account:

The SOAP response envelope contains information about the error. In this case, the create request failed because no client ID was specified and the application couldn't find the applicable triggered send (as it was located in another account):

You can review the successful request envelope below: