Service Web Service

Service

Click here for a complete list of operations.

UploadSubscribersInfo

Add new/existing subscribers into a subscription.
Arguments:

loginEmail: Login Email of Spread.
password: Login Password of Spread.
SubscriberArgs(): email, firstName, middleName, lastName, jobTitle, company, homePhone, address1, address2, address3, city, state, country,postalCode, subPostalCode, customField1, customField2, customField3.
subscription: The subscription where the subscriber being added.
optInType: Double Opt-In Option.

return ResponseResult containing error messages if any.

Remarks: Subscriber would receive confirmation email if user's Double Opt-in option is ON.if the count of subscribers is larger than 100 , the subscribers will be added in backgroud thread anda trackingId will be returned in ResponseResult, or else save subscribers immediately and result can be viewed in the errorDetails of ResponseResult for each subscribers

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://service.reasonablespread.com/UploadSubscribersInfo"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadSubscribersInfo xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <subscriberArgs>
        <SubscriberInfo>
          <email>string</email>
          <firstName>string</firstName>
          <middleName>string</middleName>
          <lastName>string</lastName>
          <jobTitle>string</jobTitle>
          <company>string</company>
          <homePhone>string</homePhone>
          <address1>string</address1>
          <address2>string</address2>
          <address3>string</address3>
          <city>string</city>
          <state>string</state>
          <country>string</country>
          <postalCode>string</postalCode>
          <subPostalCode>string</subPostalCode>
          <fax>string</fax>
          <webUrl>string</webUrl>
          <title>string</title>
          <gender>string</gender>
          <birthday>dateTime</birthday>
          <date1>dateTime</date1>
          <date2>dateTime</date2>
          <customField1>string</customField1>
          <customField2>string</customField2>
          <customField3>string</customField3>
          <customField4>string</customField4>
          <customField5>string</customField5>
          <customField6>string</customField6>
          <customField7>string</customField7>
          <customField8>string</customField8>
          <customField9>string</customField9>
          <customField10>string</customField10>
          <customField11>string</customField11>
          <customField12>string</customField12>
          <customField13>string</customField13>
          <customField14>string</customField14>
          <customField15>string</customField15>
        </SubscriberInfo>
        <SubscriberInfo>
          <email>string</email>
          <firstName>string</firstName>
          <middleName>string</middleName>
          <lastName>string</lastName>
          <jobTitle>string</jobTitle>
          <company>string</company>
          <homePhone>string</homePhone>
          <address1>string</address1>
          <address2>string</address2>
          <address3>string</address3>
          <city>string</city>
          <state>string</state>
          <country>string</country>
          <postalCode>string</postalCode>
          <subPostalCode>string</subPostalCode>
          <fax>string</fax>
          <webUrl>string</webUrl>
          <title>string</title>
          <gender>string</gender>
          <birthday>dateTime</birthday>
          <date1>dateTime</date1>
          <date2>dateTime</date2>
          <customField1>string</customField1>
          <customField2>string</customField2>
          <customField3>string</customField3>
          <customField4>string</customField4>
          <customField5>string</customField5>
          <customField6>string</customField6>
          <customField7>string</customField7>
          <customField8>string</customField8>
          <customField9>string</customField9>
          <customField10>string</customField10>
          <customField11>string</customField11>
          <customField12>string</customField12>
          <customField13>string</customField13>
          <customField14>string</customField14>
          <customField15>string</customField15>
        </SubscriberInfo>
      </subscriberArgs>
      <subscription>string</subscription>
      <optInType>ReferToUserOption or On or Off</optInType>
    </UploadSubscribersInfo>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <UploadSubscribersInfoResponse xmlns="http://service.reasonablespread.com/">
      <UploadSubscribersInfoResult>
        <RequestID>string</RequestID>
        <Status>string</Status>
        <UploadDetails>
          <UploadDetail>
            <StatusCode>string</StatusCode>
            <StatusDesc>string</StatusDesc>
          </UploadDetail>
          <UploadDetail>
            <StatusCode>string</StatusCode>
            <StatusDesc>string</StatusDesc>
          </UploadDetail>
        </UploadDetails>
      </UploadSubscribersInfoResult>
    </UploadSubscribersInfoResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /service.asmx HTTP/1.1
Host: service.rspread.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadSubscribersInfo xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <password>string</password>
      <subscriberArgs>
        <SubscriberInfo>
          <email>string</email>
          <firstName>string</firstName>
          <middleName>string</middleName>
          <lastName>string</lastName>
          <jobTitle>string</jobTitle>
          <company>string</company>
          <homePhone>string</homePhone>
          <address1>string</address1>
          <address2>string</address2>
          <address3>string</address3>
          <city>string</city>
          <state>string</state>
          <country>string</country>
          <postalCode>string</postalCode>
          <subPostalCode>string</subPostalCode>
          <fax>string</fax>
          <webUrl>string</webUrl>
          <title>string</title>
          <gender>string</gender>
          <birthday>dateTime</birthday>
          <date1>dateTime</date1>
          <date2>dateTime</date2>
          <customField1>string</customField1>
          <customField2>string</customField2>
          <customField3>string</customField3>
          <customField4>string</customField4>
          <customField5>string</customField5>
          <customField6>string</customField6>
          <customField7>string</customField7>
          <customField8>string</customField8>
          <customField9>string</customField9>
          <customField10>string</customField10>
          <customField11>string</customField11>
          <customField12>string</customField12>
          <customField13>string</customField13>
          <customField14>string</customField14>
          <customField15>string</customField15>
        </SubscriberInfo>
        <SubscriberInfo>
          <email>string</email>
          <firstName>string</firstName>
          <middleName>string</middleName>
          <lastName>string</lastName>
          <jobTitle>string</jobTitle>
          <company>string</company>
          <homePhone>string</homePhone>
          <address1>string</address1>
          <address2>string</address2>
          <address3>string</address3>
          <city>string</city>
          <state>string</state>
          <country>string</country>
          <postalCode>string</postalCode>
          <subPostalCode>string</subPostalCode>
          <fax>string</fax>
          <webUrl>string</webUrl>
          <title>string</title>
          <gender>string</gender>
          <birthday>dateTime</birthday>
          <date1>dateTime</date1>
          <date2>dateTime</date2>
          <customField1>string</customField1>
          <customField2>string</customField2>
          <customField3>string</customField3>
          <customField4>string</customField4>
          <customField5>string</customField5>
          <customField6>string</customField6>
          <customField7>string</customField7>
          <customField8>string</customField8>
          <customField9>string</customField9>
          <customField10>string</customField10>
          <customField11>string</customField11>
          <customField12>string</customField12>
          <customField13>string</customField13>
          <customField14>string</customField14>
          <customField15>string</customField15>
        </SubscriberInfo>
      </subscriberArgs>
      <subscription>string</subscription>
      <optInType>ReferToUserOption or On or Off</optInType>
    </UploadSubscribersInfo>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <UploadSubscribersInfoResponse xmlns="http://service.reasonablespread.com/">
      <UploadSubscribersInfoResult>
        <RequestID>string</RequestID>
        <Status>string</Status>
        <UploadDetails>
          <UploadDetail>
            <StatusCode>string</StatusCode>
            <StatusDesc>string</StatusDesc>
          </UploadDetail>
          <UploadDetail>
            <StatusCode>string</StatusCode>
            <StatusDesc>string</StatusDesc>
          </UploadDetail>
        </UploadDetails>
      </UploadSubscribersInfoResult>
    </UploadSubscribersInfoResponse>
  </soap12:Body>
</soap12:Envelope>