USADATA Leads Engine Service Web Service

USADATA Leads Engine Service

Click here for a complete list of operations.

submitSaturationOrder

Submits a saturation order to the Leads Engine fulfillment system.

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

<?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>
    <submitSaturationOrder 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>
      <SaturationOrderRequest>
        <CountID>string</CountID>
        <InvoiceReferenceID>string</InvoiceReferenceID>
        <DesiredQuantity>int</DesiredQuantity>
        <AvailableQuantity>int</AvailableQuantity>
        <FileFormat>ASCII</FileFormat>
        <Usage>Single or Multiple or Analytical</Usage>
        <OutputColumns>
          <string>string</string>
          <string>string</string>
        </OutputColumns>
        <CarrierRoutes>
          <CarrierRouteRequest>
            <ZipCode>string</ZipCode>
            <Crrt>string</Crrt>
            <SelectedHomes>long</SelectedHomes>
            <SelectedApartments>long</SelectedApartments>
            <SelectedBusinesses>long</SelectedBusinesses>
          </CarrierRouteRequest>
          <CarrierRouteRequest>
            <ZipCode>string</ZipCode>
            <Crrt>string</Crrt>
            <SelectedHomes>long</SelectedHomes>
            <SelectedApartments>long</SelectedApartments>
            <SelectedBusinesses>long</SelectedBusinesses>
          </CarrierRouteRequest>
        </CarrierRoutes>
      </SaturationOrderRequest>
    </submitSaturationOrder>
  </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>
    <submitSaturationOrderResponse xmlns="http://Usadata/Services/Service">
      <submitSaturationOrderResult>
        <OrderID>string</OrderID>
        <ErrorMessage>string</ErrorMessage>
        <ReturnCode>int</ReturnCode>
      </submitSaturationOrderResult>
    </submitSaturationOrderResponse>
  </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>
    <submitSaturationOrder 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>
      <SaturationOrderRequest>
        <CountID>string</CountID>
        <InvoiceReferenceID>string</InvoiceReferenceID>
        <DesiredQuantity>int</DesiredQuantity>
        <AvailableQuantity>int</AvailableQuantity>
        <FileFormat>ASCII</FileFormat>
        <Usage>Single or Multiple or Analytical</Usage>
        <OutputColumns>
          <string>string</string>
          <string>string</string>
        </OutputColumns>
        <CarrierRoutes>
          <CarrierRouteRequest>
            <ZipCode>string</ZipCode>
            <Crrt>string</Crrt>
            <SelectedHomes>long</SelectedHomes>
            <SelectedApartments>long</SelectedApartments>
            <SelectedBusinesses>long</SelectedBusinesses>
          </CarrierRouteRequest>
          <CarrierRouteRequest>
            <ZipCode>string</ZipCode>
            <Crrt>string</Crrt>
            <SelectedHomes>long</SelectedHomes>
            <SelectedApartments>long</SelectedApartments>
            <SelectedBusinesses>long</SelectedBusinesses>
          </CarrierRouteRequest>
        </CarrierRoutes>
      </SaturationOrderRequest>
    </submitSaturationOrder>
  </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>
    <submitSaturationOrderResponse xmlns="http://Usadata/Services/Service">
      <submitSaturationOrderResult>
        <OrderID>string</OrderID>
        <ErrorMessage>string</ErrorMessage>
        <ReturnCode>int</ReturnCode>
      </submitSaturationOrderResult>
    </submitSaturationOrderResponse>
  </soap12:Body>
</soap12:Envelope>