AsyncResponse

From $1

    Doc-Wiki-BannerHK.png

    (Click the banner to go to the related Docs.Code.ExactTarget.com page.)

    Definition

    Used to modify return of data sent in response to asynchronous API request.

    Properties

    This object has following properties.

    NameData TypeDescription
    IncludeObjectsxsd:booleanIndicates whether the APIObject should be included in the response.
    IncludeResultsxsd:booleanDetermines whether the Result objects will be included in the response when an asynchronous API call completes processing.
    OnlyIncludeBasexsd:booleanReduce object to base APIObject information. Includes basic reference data associating object and request.
    RespondWhenRespondWhenSpecifies event triggers the AsyncResponse object action.
    ResponseAddressxsd:stringEmail address or public URL to receive POST response to asynchronous request.
    ResponseTypeAsyncResponseTypeSpecifies type of response associated with an asynchronous operation.

    Description

    Available for 30 days after initial response. Refer to this link for examples using the AsyncResponse object.

    If you are only interested in the Result object and want to reduce the size of the response message, set the IncludeObjects property value to True.

    Sample RespondWhen SOAP Request

    <?xml version="1.0" encoding="UTF-8"?>
    <SOAP-ENV:Envelope xmlns:SOAP-ENV=http://schemas.xmlsoap.org/soap/envelope/ xmlns:xsd=http://www.w3.org/2001/XMLSchema xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <SOAP-ENV:Header>
      <wsse:Security xmlns:wsse=http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
       <wsu:Timestamp>
        <wsu:Created>2010-03-18T20:49:28Z</wsu:Created>
        <wsu:Expires>2010-03-18T20:54:28Z</wsu:Expires>
       </wsu:Timestamp>
       <wsse:UsernameToken>
        <wsse:Username>username</wsse:Username>
        <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">password</wsse:Password>
        <wsse:Nonce>vl2E/kZmcAr9bh5kd2OILaHVTIs=</wsse:Nonce>
        <wsu:Created>2010-03-18T20:49:28Z</wsu:Created>
       </wsse:UsernameToken>
      </wsse:Security>
     </SOAP-ENV:Header>
     <SOAP-ENV:Body>
      <CreateRequest xmlns="http://exacttarget.com/wsdl/partnerAPI">
       <Options>
        <SendResponseTo>
         <ResponseType>HTTPPost</ResponseType>
         <ResponseAddress>http://localhost/PartnerAPI/HTTPPostTest.aspx</ResponseAddress>
         <RespondWhen>OnCallComplete</RespondWhen>
         <IncludeResults>true</IncludeResults>
        </SendResponseTo>
        <SendResponseTo>
         <ResponseType>HTTPPost</ResponseType>
         <ResponseAddress>http://localhost/PartnerAPI/HTTPPostTest.aspx</ResponseAddress>
         <RespondWhen>OnConversationComplete</RespondWhen>
         <IncludeResults>true</IncludeResults>
        </SendResponseTo>
        <ConversationID>Test List 20100318164922160</ConversationID>
        <SequenceCode>1</SequenceCode>
        <CallsInConversation>3</CallsInConversation>
        <RequestType>Asynchronous</RequestType>
       </Options>
       <ns1:Objects xmlns:ns1=http://exacttarget.com/wsdl/partnerAPI xsi:type="ns1:List">
        <ns1:PartnerKey>Test List 20100318164922160</ns1:PartnerKey>
        <ns1:ModifiedDate xsi:nil="true"/>
        <ns1:ObjectID xsi:nil="true"/>
        <ns1:ListName>Mark List</ns1:ListName>
        <ns1:Type>Public</ns1:Type>
        <ns1:Description>Mark List-Private</ns1:Description>
       </ns1:Objects>
      </CreateRequest>
     </SOAP-ENV:Body>
    </SOAP-ENV:Envelope>

    Methods

    No supported methods.

    Use Cases


    This page was last updated by Ryan Williams on Fri, 06 Jan 2012 21:58:17 GMT.

    If you require assistance with the ExactTarget application, please contact Global Support. If you wish to send Ryan direct feedback, fill out the form below:

     


    Was This Page Helpful?
    Suggestions or Comments:
    Name (optional):
    Email Address (optional):
    Enter 18565 backwards:
       
    Tags: (Edit tags)
    • No tags
     
    Comments (0)
    You must login to post a comment.

     
    Powered by MindTouch 2010
    Admin