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.

HTTP Post Callback

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

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

Sample C# Request

APIObject[] subscribers = new APIObject[1];
Subscriber subscriber = new Subscriber();
subscriber.EmailAddress = "john@example.com";
subscriber.SubscriberKey = "23456789";
/*
 * Attribute selection:
 * For best performance ensure the triggered send is using fields that exist on a data extension as attributes
 *
 * HTML__ is a prefix valuable when sending larger than 2000 characters through a legacy subscriber attribute
 * The HTML__ prefix is not neccessary for data extension fields.
 */
subscriber.Attributes = new AsyncTestSuite.IntegrationFramework.Attribute[2];
subscriber.Attributes[0] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[0].Name = "FirstName";
subscriber.Attributes[0].Value = "John";
subscriber.Attributes[1] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[1].Name = "YearOfBirth";
subscriber.Attributes[1].Value = "1989";
subscribers[0] = subscriber;
CreateOptions co = new CreateOptions();
co.RequestType = RequestType.Asynchronous;
co.RequestTypeSpecified = true;
co.SendResponseTo = new AsyncResponse[1];
co.SendResponseTo[0] = new AsyncResponse();
co.SendResponseTo[0].ConversationID = "firsttest";
co.SendResponseTo[0].RespondWhen = RespondWhen.OnCallComplete;
co.SendResponseTo[0].RespondWhenSpecified = true;
co.SendResponseTo[0].ResponseType = AsyncResponseType.HTTPPost;
co.SendResponseTo[0].ResponseAddress = "https://dev.example.com/partneremail";
co.SendResponseTo[0].IncludeResults = true;
co.SendResponseTo[0].IncludeResultsSpecified = true;
co.SendResponseTo[0].IncludeObjects = true;
co.SendResponseTo[0].IncludeObjectsSpecified = true;
CreateResult[] results = integrationFramework.Create(co, subscribers, out requestID, out status);
Console.WriteLine(results[0].StatusCode);
Console.WriteLine(results[0].StatusMessage);
Assert.IsNotNull(results);
Assert.AreEqual("OK", status);

Sample C# Result

// Publicly Available ASPX Web Page
string requestID = Request.Form["RequestID"];
string conversationID = Request.Form["ConversationID"];
string overallStatusCode = Request.Form["OverallStatusCode"];
string statusCode = Request.Form["StatusCode"];
string statusMessage = Request.Form["StatusMessage"];
// The error code associated with the first errored object (the one that stopped the conversation)
string errorCode = Request.Form["ErrorCode"];
string requestType = Request.Form["RequestType"];
string resultType = Request.Form["ResultType"];
// Optional and may be large
string resultDetailXML = Request.Form["ResultDetailXML"];
string sequenceCode = Request.Form["SequenceCode"];
switch (overallStatusCode)
{
    case "OK":
        // log the conversationID successful
        break;

    case "Has Error":
        // Handle Errors
        // Submit new conversation if needed
        break;

    case "Error":
        // Handle Errors
        // Submit new conversation if needed
       break;
}

APIObject[] subscribers = new APIObject[1];
Subscriber subscriber = new Subscriber();
subscriber.EmailAddress = "john@example.com";
subscriber.SubscriberKey = "23456789";
/*
 * Attribute selection:
 * For best performance ensure the triggered send is using fields that exist on a data extension as attributes
 *
 * HTML__ is a prefix valuable when sending larger than 2000 characters through a legacy subscriber attribute
 * The HTML__ prefix is not neccessary for data extension fields.
 */
subscriber.Attributes = new AsyncTestSuite.IntegrationFramework.Attribute[2];
subscriber.Attributes[0] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[0].Name = "FirstName";
subscriber.Attributes[0].Value = "John";
subscriber.Attributes[1] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[1].Name = "YearOfBirth";
subscriber.Attributes[1].Value = "1989";
subscribers[0] = subscriber;
CreateOptions co = new CreateOptions();
co.RequestType = RequestType.Asynchronous;
co.RequestTypeSpecified = true;
co.SendResponseTo = new AsyncResponse[1];
co.SendResponseTo[0] = new AsyncResponse();
co.SendResponseTo[0].ConversationID = "firsttest";
co.SendResponseTo[0].RespondWhen = RespondWhen.OnCallComplete;
co.SendResponseTo[0].RespondWhenSpecified = true;
co.SendResponseTo[0].ResponseType = AsyncResponseType.HTTPPost;
co.SendResponseTo[0].ResponseAddress = "https://dev.example.com/partneremail";
co.SendResponseTo[0].IncludeResults = true;
co.SendResponseTo[0].IncludeResultsSpecified = true;
co.SendResponseTo[0].IncludeObjects = true;
co.SendResponseTo[0].IncludeObjectsSpecified = true;
CreateResult[] results = integrationFramework.Create(co, subscribers, out requestID, out status);
Console.WriteLine(results[0].StatusCode);
Console.WriteLine(results[0].StatusMessage);
Assert.IsNotNull(results);
Assert.AreEqual("OK", status);

Retrieve

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.

RetrieveRequest rr = new RetrieveRequest();
rr.ObjectType = "ResultMessage";
rr.Properties = new string[] { "CreatedDate", "RequestID", "ConversationID", "CallsInConversation", "SequenceCode", "StatusCode", "ErrorCode", "StatusMessage" };
SimpleFilterPart sfp = new SimpleFilterPart();
sfp.Property = "RequestID";
sfp.SimpleOperator = SimpleOperators.equals;
sfp.Value = new string[] {"2519c614-6817-4e9e-a6e1-26b7d160c8b5"};

rr.Filter = sfp;
APIObject[] results;
String status = integrationFramework.Retrieve(rr, out requestID, out results);
// Will return a maximum of 2500 without paging support
Console.WriteLine(String.Format("Number of Results:\t{0}", results.Length));
Console.WriteLine("Result Details");
Console.WriteLine("--------------------------");
Console.WriteLine("CreatedDate\tRequestID\tConversationID\tCallsInConversation\tSequenceCode\tStatus\tErrorCode\tMessage");
foreach (APIObject result in results)
{
    ResultMessage resultMsg = result as ResultMessage;
    Console.WriteLine(String.Format("{0}\t{1}\t{2}\t{3}\t{4}\t{5}\t{6}\t{7}", resultMsg.CreatedDate, resultMsg.RequestID, resultMsg.ConversationID, resultMsg.CallsInConversation, resultMsg.SequenceCode, resultMsg.StatusCode, resultMsg.ErrorCode, resultMsg.StatusMessage));
}

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.

Email

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.

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

APIObject[] subscribers = new APIObject[1];
Subscriber subscriber = new Subscriber();
subscriber.EmailAddress = "john@example.com";
subscriber.SubscriberKey = "12345";
subscriber.Attributes = new AsyncTestSuite.IntegrationFramework.Attribute[2];
subscriber.Attributes[0] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[0].Name = "FirstName";
subscriber.Attributes[0].Value = "john";
subscriber.Attributes[1] = new AsyncTestSuite.IntegrationFramework.Attribute();
subscriber.Attributes[1].Name = "YearOfBirth";
subscriber.Attributes[1].Value = "1989";
subscribers[0] = subscriber;
CreateOptions co = new CreateOptions();
co.RequestType = RequestType.Asynchronous;
co.RequestTypeSpecified = true;
co.SendResponseTo = new AsyncResponse[1];
co.SendResponseTo[0] = new AsyncResponse();
co.SendResponseTo[0].RespondWhen = RespondWhen.OnCallComplete;
co.SendResponseTo[0].RespondWhenSpecified = true;
co.SendResponseTo[0].ResponseType = AsyncResponseType.email;
co.SendResponseTo[0].ResponseAddress = "responses@example.com";
co.SendResponseTo[0].IncludeResults = true;
co.SendResponseTo[0].IncludeResultsSpecified = true;
co.SendResponseTo[0].IncludeObjects = true;
co.SendResponseTo[0].IncludeObjectsSpecified = true;
co.SendResponseTo[0].OnlyIncludeBase = true;
co.SendResponseTo[0].OnlyIncludeBaseSpecified = true;
CreateResult[] results = integrationFramework.Create(co, subscribers, out requestID, out status);
Console.WriteLine(results[0].StatusCode);
Console.WriteLine(results[0].StatusMessage);
Assert.IsNotNull(results);
Assert.AreEqual("OK", status);

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

<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://exacttarget.com/wsdl/partnerAPI">
  <StatusCode>Error</StatusCode>
  <StatusMessage>The subscriber is already on the list</StatusMessage>
  <OrdinalID>0</OrdinalID>
  <ErrorCode>12014</ErrorCode>
  <NewID>0</NewID>
</CreateResult>

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

<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://exacttarget.com/wsdl/partnerAPI">
  <StatusCode>Error</StatusCode>
  <StatusMessage>The subscriber is already on the list</StatusMessage>
  <OrdinalID>0</OrdinalID>
  <ErrorCode>12014</ErrorCode>
  <NewID>0</NewID>
  <Object xsi:type="Subscriber">
    <ObjectID xsi:nil="true" />
    <EmailAddress>john@example.com</EmailAddress>
    <Attributes>
      <Name>FirstName</Name>
      <Value>Dale</Value>
    </Attributes>
    <Attributes>
      <Name>YearOfBirth</Name>
      <Value>1989</Value>
    </Attributes>
    <SubscriberKey>2345672</SubscriberKey>
  </Object>
</CreateResult>

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

<CreateResult xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns="http://exacttarget.com/wsdl/partnerAPI">
  <StatusCode>Error</StatusCode>
  <StatusMessage>The subscriber is already on the list</StatusMessage>
  <OrdinalID>0</OrdinalID>
  <ErrorCode>12014</ErrorCode>
  <NewID>0</NewID>
  <Object xsi:type="Subscriber">
    <ObjectID xsi:nil="true" />
  </Object>
</CreateResult>