OnlineAPI


Click here for a complete list of operations.

ZipLookup_v2

This method allows one to see the accessible cities, states, and counties for a given zip code. This is best used by allowing a user to enter the zip code and then giving drop-down options for city, state, and county. Note: The only different between ZipLookup and ZipLookup_V2 is the format in which the data is returned.

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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.securefreedom.com/ZipLookup_v2"

<?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>
    <ZipLookup_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ZipCode>string</ZipCode>
    </ZipLookup_v2>
  </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>
    <ZipLookup_v2Response xmlns="http://www.securefreedom.com/">
      <ZipLookup_v2Result>
        <ZipBlock_v2>
          <City>string</City>
          <State>string</State>
          <County>string</County>
        </ZipBlock_v2>
        <ZipBlock_v2>
          <City>string</City>
          <State>string</State>
          <County>string</County>
        </ZipBlock_v2>
      </ZipLookup_v2Result>
    </ZipLookup_v2Response>
  </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 /adapturedemo/webservice/OnlineAPI.asmx HTTP/1.1
Host: api.securefreedom.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>
    <ZipLookup_v2 xmlns="http://www.securefreedom.com/">
      <Credentials>
        <Username>string</Username>
        <Password>string</Password>
        <Token>string</Token>
      </Credentials>
      <ZipCode>string</ZipCode>
    </ZipLookup_v2>
  </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>
    <ZipLookup_v2Response xmlns="http://www.securefreedom.com/">
      <ZipLookup_v2Result>
        <ZipBlock_v2>
          <City>string</City>
          <State>string</State>
          <County>string</County>
        </ZipBlock_v2>
        <ZipBlock_v2>
          <City>string</City>
          <State>string</State>
          <County>string</County>
        </ZipBlock_v2>
      </ZipLookup_v2Result>
    </ZipLookup_v2Response>
  </soap12:Body>
</soap12:Envelope>