Overview

Skill Level: Intermediate

Step-by-step

  1. Syntax of the request and response XML for GetContactMailingDetails

    This interface is intended to be used with the SureFrom Code that can be placed in the mailing body.

    Operation <GetContactMailingDetails>    
    Elements SURE_FROM_CODE An ID that can be returned in a mailing body and used to validate that a mailing is legitimate.  
      ORGANIZATION_ID One or more Organization IDs that are checked for the SureFrom Code.  
    Example with normal usage
    <Envelope>
    <Body>
    <GetContactMailingDetails>
    <SURE_FROM_CODE>1-8QhP4YIS-XYPxqdpK-ia6t4PP3-
    +/dKSxVg-uCXkKZka-X77SLMfa-0J+R5TBj-AX3N0CTU
    </SURE_FROM_CODE>
    <ORGANIZATION_ID>1dcd49d-108b594203d-f528764d624db129b32c21fbca0cb8d6</ORGANIZATION_ID>
    </GetContactMailingDetails>
    </Body>
    </Envelope>
       
    Example 2 with multiple orgs
    <Envelope>
    <Body>
    <GetContactMailingDetails>
    <SURE_FROM_CODE>1-8QhP4YIS-XYPxqdpK-ia6t4PP3-
    +/dKSxVg-uCXkKZka-X77SLMfa-0J+R5TBj-AX3N0CTU
    </SURE_FROM_CODE>
    <ORGANIZATION_ID>1dcd49d-108b594203d-
    f528764d624db129b32c21fbca0cb8d6</ORGANIZATION_ID>
    <ORGANIZATION_ID>2edd49d-108b594203d-
    f528764d624db129b32c21fbca0cc9e7</ORGANIZATION_ID>
    </GetContactMailingDetails>
    </Body>
    </Envelope>
       
    Response <RESULT>    
    Elements SUCCESS TRUE if successful.  
      SENT_TIMESTAMP The date/time that the mailing was sent in GMT.  
    ¬† FROM_NAME The From Name of the mailing’s sender. ¬†
    ¬† FROM_ADDRESS The From Address (email) of the mailing’s sender. ¬†
      SUBJECT The Subject of the mailing.  
    Elements TO_ADDRESS OPTIONAL The email address of the recipient whose SEND_FROM_CODE was provided. Only returned if ORGANIZATION_ID is provided in the request.
      CLICK_TO_VIEW OPTIONAL The Click To View URL of the personalized mailing body for the recipient whose SEND_FROM_CODE was provided. Only returned if ORGANIZATION_ID is provided in the request.
      ORGANIZATION_ID OPTIONAL The Organization ID of the Organization that sent the mailing for the provided SEND_FROM_CODE. Only returned if ORGANIZATION_ID is provided in the request.
    Example 1 with org in request
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>true</SUCCESS>
          <SENT_TIMESTAMP>09/30/2010 21:08:59 GMT</SENT_TIMESTAMP>
          <FROM_NAME>IBM Support</FROM_NAME>
          <FROM_ADDRESS></FROM_ADDRESS>
          <SUBJECT>Upcoming Release</SUBJECT>
        </RESULT>
      </Body>
    </Envelope>
    
       
    Example 2 without org in request
    <Envelope>
    <Body>
    <RESULT>
    <SUCCESS>true</SUCCESS>
    <SENT_TIMESTAMP>09/30/2010 21:08:59 GMT</SENT_TIMESTAMP>
    <FROM_NAME>IBM Support</FROM_NAME>
    <FROM_ADDRESS></FROM_ADDRESS>
    <SUBJECT>Upcoming Release</SUBJECT>
    </RESULT>
    </Body>
    </Envelope>
       
    Error Example
    <Envelope>
      <Body>
        <RESULT>
          <SUCCESS>false</SUCCESS>
        </RESULT>
        <Fault>
          <Request/>
          <FaultCode/>
          <FaultString>The value you entered could not be confirmed.</FaultString>
          <detail>
            <error>
              <errorid>330</errorid>
              <module/>
              <class>SP.API</class>
              <method/>
            </error>
          </detail>
        </Fault>
      </Body>
    </Envelope>
    
       

Join The Discussion

Your email address will not be published. Required fields are marked *