Service


Click here for a complete list of operations.

GetSubscribersByField

GetSubscriberDetailByCustomKey
Arguments:

loginEmail: Login Email of Spread.
APIKey: Login Password of Spread or APIKey API Key which you can retrieve from your Spread account (My account=> Settings).
FieldName: The field to search ： customField1,customField2,customField3...customField15 and customPrimarykey,
Value: The value of the custom field。
return dataset.

Dataset Columns:
All subscriber fields.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
loginEmail:
APIKey:
FieldName:
Value:

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/GetSubscribersByField"

<?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>
    <GetSubscribersByField xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <FieldName>string</FieldName>
      <Value>string</Value>
    </GetSubscribersByField>
  </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>
    <GetSubscribersByFieldResponse xmlns="http://service.reasonablespread.com/">
      <GetSubscribersByFieldResult>
        <xsd:schema>schema</xsd:schema>xml</GetSubscribersByFieldResult>
    </GetSubscribersByFieldResponse>
  </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>
    <GetSubscribersByField xmlns="http://service.reasonablespread.com/">
      <loginEmail>string</loginEmail>
      <APIKey>string</APIKey>
      <FieldName>string</FieldName>
      <Value>string</Value>
    </GetSubscribersByField>
  </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>
    <GetSubscribersByFieldResponse xmlns="http://service.reasonablespread.com/">
      <GetSubscribersByFieldResult>
        <xsd:schema>schema</xsd:schema>xml</GetSubscribersByFieldResult>
    </GetSubscribersByFieldResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /service.asmx/GetSubscribersByField?loginEmail=string&APIKey=string&FieldName=string&Value=string HTTP/1.1
Host: service.rspread.com

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

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="http://service.reasonablespread.com/">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>

HTTP POST

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

POST /service.asmx/GetSubscribersByField HTTP/1.1
Host: service.rspread.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

loginEmail=string&APIKey=string&FieldName=string&Value=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<DataSet xmlns="http://service.reasonablespread.com/">
  <schema xmlns="http://www.w3.org/2001/XMLSchema">schema</schema>xml</DataSet>