USADATA Leads Engine Service Web Service

USADATA Leads Engine Service

Click here for a complete list of operations.

getSynchronousCounts

Submits count request array in a synchronous manner. This method does not return until the count is complete.

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

<?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>
    <getSynchronousCounts 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>
      <CountRequestList>
        <CountRequest>
          <TableName>string</TableName>
          <AreaCriteria>
            <Address xsi:nil="true" />
            <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
            <RequestValue>double</RequestValue>
            <UseZip4Granularity>boolean</UseZip4Granularity>
            <Addresses xsi:nil="true" />
            <DriveTimeAddress xsi:nil="true" />
          </AreaCriteria>
          <GeographicCriteria>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </GeographicCriteria>
          <SelectionCriteria>
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
          </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 xsi:nil="true" />
            <SuppressionPriorOrders xsi:nil="true" />
          </SuppressionPriorOrder>
          <PolygonPoints>
            <Point xsi:nil="true" />
            <Point xsi:nil="true" />
          </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 xsi:nil="true" />
          </MultiPolygonPoints>
        </CountRequest>
        <CountRequest>
          <TableName>string</TableName>
          <AreaCriteria>
            <Address xsi:nil="true" />
            <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
            <RequestValue>double</RequestValue>
            <UseZip4Granularity>boolean</UseZip4Granularity>
            <Addresses xsi:nil="true" />
            <DriveTimeAddress xsi:nil="true" />
          </AreaCriteria>
          <GeographicCriteria>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </GeographicCriteria>
          <SelectionCriteria>
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
          </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 xsi:nil="true" />
            <SuppressionPriorOrders xsi:nil="true" />
          </SuppressionPriorOrder>
          <PolygonPoints>
            <Point xsi:nil="true" />
            <Point xsi:nil="true" />
          </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 xsi:nil="true" />
          </MultiPolygonPoints>
        </CountRequest>
      </CountRequestList>
    </getSynchronousCounts>
  </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>
    <getSynchronousCountsResponse xmlns="http://Usadata/Services/Service">
      <getSynchronousCountsResult>
        <SynchronousCountResult>
          <ReturnCode>int</ReturnCode>
          <ErrorMessage>string</ErrorMessage>
          <CountID>string</CountID>
          <CountTotal>int</CountTotal>
          <BreakdownResults>
            <BreakdownResult xsi:nil="true" />
            <BreakdownResult xsi:nil="true" />
          </BreakdownResults>
        </SynchronousCountResult>
        <SynchronousCountResult>
          <ReturnCode>int</ReturnCode>
          <ErrorMessage>string</ErrorMessage>
          <CountID>string</CountID>
          <CountTotal>int</CountTotal>
          <BreakdownResults>
            <BreakdownResult xsi:nil="true" />
            <BreakdownResult xsi:nil="true" />
          </BreakdownResults>
        </SynchronousCountResult>
      </getSynchronousCountsResult>
    </getSynchronousCountsResponse>
  </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>
    <getSynchronousCounts 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>
      <CountRequestList>
        <CountRequest>
          <TableName>string</TableName>
          <AreaCriteria>
            <Address xsi:nil="true" />
            <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
            <RequestValue>double</RequestValue>
            <UseZip4Granularity>boolean</UseZip4Granularity>
            <Addresses xsi:nil="true" />
            <DriveTimeAddress xsi:nil="true" />
          </AreaCriteria>
          <GeographicCriteria>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </GeographicCriteria>
          <SelectionCriteria>
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
          </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 xsi:nil="true" />
            <SuppressionPriorOrders xsi:nil="true" />
          </SuppressionPriorOrder>
          <PolygonPoints>
            <Point xsi:nil="true" />
            <Point xsi:nil="true" />
          </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 xsi:nil="true" />
          </MultiPolygonPoints>
        </CountRequest>
        <CountRequest>
          <TableName>string</TableName>
          <AreaCriteria>
            <Address xsi:nil="true" />
            <Type>Proximity or DriveTime or Radius or Polygon or MultiRadius or DriveTimeRadius</Type>
            <RequestValue>double</RequestValue>
            <UseZip4Granularity>boolean</UseZip4Granularity>
            <Addresses xsi:nil="true" />
            <DriveTimeAddress xsi:nil="true" />
          </AreaCriteria>
          <GeographicCriteria>
            <ID>string</ID>
            <Description>string</Description>
            <Type>Selection or Range or SicEntry or OutputColumn or GeoSelection</Type>
            <Values xsi:nil="true" />
          </GeographicCriteria>
          <SelectionCriteria>
            <Column xsi:nil="true" />
            <Column xsi:nil="true" />
          </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 xsi:nil="true" />
            <SuppressionPriorOrders xsi:nil="true" />
          </SuppressionPriorOrder>
          <PolygonPoints>
            <Point xsi:nil="true" />
            <Point xsi:nil="true" />
          </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 xsi:nil="true" />
          </MultiPolygonPoints>
        </CountRequest>
      </CountRequestList>
    </getSynchronousCounts>
  </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>
    <getSynchronousCountsResponse xmlns="http://Usadata/Services/Service">
      <getSynchronousCountsResult>
        <SynchronousCountResult>
          <ReturnCode>int</ReturnCode>
          <ErrorMessage>string</ErrorMessage>
          <CountID>string</CountID>
          <CountTotal>int</CountTotal>
          <BreakdownResults>
            <BreakdownResult xsi:nil="true" />
            <BreakdownResult xsi:nil="true" />
          </BreakdownResults>
        </SynchronousCountResult>
        <SynchronousCountResult>
          <ReturnCode>int</ReturnCode>
          <ErrorMessage>string</ErrorMessage>
          <CountID>string</CountID>
          <CountTotal>int</CountTotal>
          <BreakdownResults>
            <BreakdownResult xsi:nil="true" />
            <BreakdownResult xsi:nil="true" />
          </BreakdownResults>
        </SynchronousCountResult>
      </getSynchronousCountsResult>
    </getSynchronousCountsResponse>
  </soap12:Body>
</soap12:Envelope>