USADATA Leads Engine Service


Click here for a complete list of operations.

getTableDefinition

Gets the available column and column values for a given table.

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

<?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>
    <getTableDefinition 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>
      <TableName>string</TableName>
    </getTableDefinition>
  </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>
    <getTableDefinitionResponse xmlns="http://Usadata/Services/Service">
      <getTableDefinitionResult>
        <TableDefinition>
          <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>
        </TableDefinition>
        <ErrorMessage>string</ErrorMessage>
        <ReturnCode>int</ReturnCode>
      </getTableDefinitionResult>
    </getTableDefinitionResponse>
  </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>
    <getTableDefinition 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>
      <TableName>string</TableName>
    </getTableDefinition>
  </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>
    <getTableDefinitionResponse xmlns="http://Usadata/Services/Service">
      <getTableDefinitionResult>
        <TableDefinition>
          <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>
        </TableDefinition>
        <ErrorMessage>string</ErrorMessage>
        <ReturnCode>int</ReturnCode>
      </getTableDefinitionResult>
    </getTableDefinitionResponse>
  </soap12:Body>
</soap12:Envelope>