Response Options

All response options allow you to retrieve the raw XML body of the response. To process the XML in an object-oriented environment, deserialize it. Your web server must have the capacity to handle the expected call volume. Callbacks that fail aren’t retried.

Use the properties in this table to specify which callbacks to perform.

Name	Description
`RequestID`	The unique identifier of the request. This value is returned the first time the call is made.
`ConversationID`	The ConversationID that the request belongs to. If the request isn’t part of a conversation, this value is blank.
`OverallStatusCode`	The value that is returned in a synchronous call.
`StatusCode`	Contains the same content as `OverallStatusCode`.
`StatusMessage`	The value that is returned in the `Status` property in a synchronous call.
`ErrorCode`	The first error code in the result. If no errors were found, this value is blank.
`RequestType`	The type of request. Always returns `Asynchronous`.
`ResultType`	Contains the same content as `RequestType`.
`ResultDetailXML`	The XML serialized results.
`SequenceCode`	The `SequenceCode` that was specified in the request. If the request isn’t part of a conversation, this value is blank.
`SendResponseTo.RespondWhen`	Determines the types of events that cause the system to send an email with results. `OnCallComplete` — Send a notification when the request finishes processing, regardless of whether it finishes successfully or with errors. `OnConversationComplete` — Send a notification when the conversation finishes processing, regardless of whether the conversation finishes successfully or with errors. `OnError` — Send a notification when an error occurs in the request. `OnConversationError` — Send a notification when an error occurs in the conversation. `Never` — Don't send notifications. The default value is `Never`.
`SendResponseTo.ResponseAddress`	The URL to send the callback to. HTTP Post callbacks require a public HTTPS URL.
`SendResponseTo.IncludeResults`	When `true`, the response includes XML serialized Result objects. When `false`, the HTTP POST is a basic notification. The default value is `false`.
`SendResponseTo.IncludeObjects`	When `true`, the `Object` property in the response is populated in the result XML. If the value of the `IncludeResults` property is `false`, this property is ignored.
`SendResponseTo.OnlyIncludeBase`	When `true`, the `Object` property in the response includes only the base API object. If the value of the `IncludeObjects` property is `false`, this property is ignored.

This C# code example performs an HTTP Post action to https://dev.example.com/partneremail. The results include the entire Object property.

You can retrieve one ResultMessage object per request. To retrieve the full XML result, add the ResultDetailXML to the Properties collection. To optimize performance, include a filter so that data is only returned for specific requests.

This example retrieves data for a single request ID.

One ResultItem is available for every top-level object in the request. If a request creates 3 Subscriber objects, 3 ResultItem objects are available for the request.

This call returns an email after processing of the request or conversation is complete. The email can include a ZIP file attachment named results.zip, which contains an XML file called results.xml.

Property	Data Type	Description
`RespondWhen`	String	Determines the types of events that cause the system to send an email with results. `OnCallComplete` — Send a notification when the request finishes processing, regardless of whether it finishes successfully or with errors. `OnConversationComplete` — Send a notification when the conversation finishes processing, regardless of whether the conversation finishes successfully or with errors. `OnError` — Send a notification when an error occurs in the request. `OnConversationError` — Send a notification when an error occurs in the conversation. `Never` — Don't send notifications. The default value is `Never`.
`ResponseAddress`	String	The email address to send results to.
`IncludeResults`	Boolean	When `true`, result data is included as an attachment to the response email. If the value is `false`, the email is a basic notification. The default value is `false`.
`IncludeObjects`	Boolean	When `true`, object data is populated in each `Result` object.

This example sends an email to responses@example.com with an attachment that contains results with the APIObject properties on the Object property.

When the value of IncludeResults is true, the response data included in the email attachment resembles this example.

When the values of IncludeResults and IncludeObjects are both true, the response resembles this example.

When the values of IncludeResults, IncludeObjects, and OnlyIncludeBase are all true, the response resembles this example.