USADATA Leads Engine Service Web Service

USADATA Leads Engine Service

Click here for a complete list of operations.

submitAsynchronousSaturationCount

Submits an asynchronous saturation count request to the count engine, returnin an id for subsequent count status queries.

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: leadsengine.usadata.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://Usadata/Services/Service/submitAsynchronousSaturationCount"

<?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>
    <submitAsynchronousSaturationCount xmlns="http://Usadata/Services/Service">
      <Login>
        <UserID xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</UserID>
        <Password xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</Password>
        <ClientID xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</ClientID>
      </Login>
      <CountRequest>
        <TableName>string</TableName>
        <AreaCriteria>
          <Address>
            <Address>string</Address>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Location xsi:nil="true" />
            <Radius>double</Radius>
            <Quantity>int</Quantity>
            <KeyCode>string</KeyCode>
          </Address>
          <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
          <RequestValue>double</RequestValue>
          <UseZip4Granularity>boolean</UseZip4Granularity>
          <Addresses>
            <AddressDefinition xsi:nil="true" />
            <AddressDefinition xsi:nil="true" />
          </Addresses>
          <DriveTimeAddress>
            <Location xsi:nil="true" />
            <LocationType>Zip or CarrierRoute or Zip4 or Coodinates</LocationType>
            <DriveTime>int</DriveTime>
            <Centroid>string</Centroid>
          </DriveTimeAddress>
        </AreaCriteria>
        <GeographicCriteria>
          <ID>string</ID>
          <Description>string</Description>
          <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
          <Values>
            <ColumnValue xsi:nil="true" />
            <ColumnValue xsi:nil="true" />
          </Values>
        </GeographicCriteria>
        <SelectionCriteria>
          <Column>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </Column>
          <Column>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </Column>
        </SelectionCriteria>
        <BreakdownResults>boolean</BreakdownResults>
        <PhoneOption>
          <ID>string</ID>
          <Description>string</Description>
        </PhoneOption>
        <PerHouseholdValue>string</PerHouseholdValue>
        <Suppression>
          <AccountID>string</AccountID>
          <SuppressionInterval>int</SuppressionInterval>
        </Suppression>
        <SuppressionPriorOrder>
          <AccountID>string</AccountID>
          <AvailablePrioroOrders>
            <string>string</string>
            <string>string</string>
          </AvailablePrioroOrders>
          <SuppressionPriorOrders>
            <string>string</string>
            <string>string</string>
          </SuppressionPriorOrders>
        </SuppressionPriorOrder>
        <PolygonPoints>
          <Point>
            <X>double</X>
            <Y>double</Y>
          </Point>
          <Point>
            <X>double</X>
            <Y>double</Y>
          </Point>
        </PolygonPoints>
        <PolygonBreakdownType>CarrierRoute or Zipcode or Zip4 or GeoPolygon</PolygonBreakdownType>
        <CountIds>
          <string>string</string>
          <string>string</string>
        </CountIds>
        <CustomSuppression>
          <string>string</string>
          <string>string</string>
        </CustomSuppression>
        <MultiPolygonPoints>
          <PolygonPoints>
            <PolygonPoint xsi:nil="true" />
            <PolygonPoint xsi:nil="true" />
          </PolygonPoints>
        </MultiPolygonPoints>
      </CountRequest>
    </submitAsynchronousSaturationCount>
  </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>
    <submitAsynchronousSaturationCountResponse xmlns="http://Usadata/Services/Service">
      <submitAsynchronousSaturationCountResult>
        <ReturnCode>int</ReturnCode>
        <ErrorMessage>string</ErrorMessage>
        <CountID>string</CountID>
      </submitAsynchronousSaturationCountResult>
    </submitAsynchronousSaturationCountResponse>
  </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: leadsengine.usadata.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>
    <submitAsynchronousSaturationCount xmlns="http://Usadata/Services/Service">
      <Login>
        <UserID xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</UserID>
        <Password xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</Password>
        <ClientID xmlns="http://Usadata.com/Services/LeadsEngine/Login">string</ClientID>
      </Login>
      <CountRequest>
        <TableName>string</TableName>
        <AreaCriteria>
          <Address>
            <Address>string</Address>
            <City>string</City>
            <State>string</State>
            <Zip>string</Zip>
            <Location xsi:nil="true" />
            <Radius>double</Radius>
            <Quantity>int</Quantity>
            <KeyCode>string</KeyCode>
          </Address>
          <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
          <RequestValue>double</RequestValue>
          <UseZip4Granularity>boolean</UseZip4Granularity>
          <Addresses>
            <AddressDefinition xsi:nil="true" />
            <AddressDefinition xsi:nil="true" />
          </Addresses>
          <DriveTimeAddress>
            <Location xsi:nil="true" />
            <LocationType>Zip or CarrierRoute or Zip4 or Coodinates</LocationType>
            <DriveTime>int</DriveTime>
            <Centroid>string</Centroid>
          </DriveTimeAddress>
        </AreaCriteria>
        <GeographicCriteria>
          <ID>string</ID>
          <Description>string</Description>
          <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
          <Values>
            <ColumnValue xsi:nil="true" />
            <ColumnValue xsi:nil="true" />
          </Values>
        </GeographicCriteria>
        <SelectionCriteria>
          <Column>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </Column>
          <Column>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </Column>
        </SelectionCriteria>
        <BreakdownResults>boolean</BreakdownResults>
        <PhoneOption>
          <ID>string</ID>
          <Description>string</Description>
        </PhoneOption>
        <PerHouseholdValue>string</PerHouseholdValue>
        <Suppression>
          <AccountID>string</AccountID>
          <SuppressionInterval>int</SuppressionInterval>
        </Suppression>
        <SuppressionPriorOrder>
          <AccountID>string</AccountID>
          <AvailablePrioroOrders>
            <string>string</string>
            <string>string</string>
          </AvailablePrioroOrders>
          <SuppressionPriorOrders>
            <string>string</string>
            <string>string</string>
          </SuppressionPriorOrders>
        </SuppressionPriorOrder>
        <PolygonPoints>
          <Point>
            <X>double</X>
            <Y>double</Y>
          </Point>
          <Point>
            <X>double</X>
            <Y>double</Y>
          </Point>
        </PolygonPoints>
        <PolygonBreakdownType>CarrierRoute or Zipcode or Zip4 or GeoPolygon</PolygonBreakdownType>
        <CountIds>
          <string>string</string>
          <string>string</string>
        </CountIds>
        <CustomSuppression>
          <string>string</string>
          <string>string</string>
        </CustomSuppression>
        <MultiPolygonPoints>
          <PolygonPoints>
            <PolygonPoint xsi:nil="true" />
            <PolygonPoint xsi:nil="true" />
          </PolygonPoints>
        </MultiPolygonPoints>
      </CountRequest>
    </submitAsynchronousSaturationCount>
  </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>
    <submitAsynchronousSaturationCountResponse xmlns="http://Usadata/Services/Service">
      <submitAsynchronousSaturationCountResult>
        <ReturnCode>int</ReturnCode>
        <ErrorMessage>string</ErrorMessage>
        <CountID>string</CountID>
      </submitAsynchronousSaturationCountResult>
    </submitAsynchronousSaturationCountResponse>
  </soap12:Body>
</soap12:Envelope>