AddressLookup


Click here for a complete list of operations.

ReturnCityState

Checks a zipcode and returns City, State, Lat, Long and more. The latitude and longitude will be more precise with a plus 4. We have added Canadian Postal Codes to this mix. This is the only function that will pull Canadian Geo and City information.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
zipcode:
LicenseKey:

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 /psaddress/addresslookup.asmx HTTP/1.1
Host: ws.cdyne.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.cdyne.com/ReturnCityState"

<?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>
    <ReturnCityState xmlns="http://ws.cdyne.com/">
      <zipcode>string</zipcode>
      <LicenseKey>string</LicenseKey>
    </ReturnCityState>
  </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>
    <ReturnCityStateResponse xmlns="http://ws.cdyne.com/">
      <ReturnCityStateResult>
        <ServiceError>boolean</ServiceError>
        <AddressError>boolean</AddressError>
        <AddressFoundBeMoreSpecific>boolean</AddressFoundBeMoreSpecific>
        <CheckDigit>int</CheckDigit>
        <NeededCorrection>boolean</NeededCorrection>
        <FromLongitude>decimal</FromLongitude>
        <FromLatitude>decimal</FromLatitude>
        <ToLongitude>decimal</ToLongitude>
        <ToLatitude>decimal</ToLatitude>
        <AvgLongitude>decimal</AvgLongitude>
        <AvgLatitude>decimal</AvgLatitude>
        <hasDaylightSavings>boolean</hasDaylightSavings>
        <LLCertainty>int</LLCertainty>
        <CountyNum>int</CountyNum>
        <Firm>string</Firm>
        <DeliveryAddress>string</DeliveryAddress>
        <DeliveryAddress2>string</DeliveryAddress2>
        <PrimaryLow>string</PrimaryLow>
        <PrimaryHigh>string</PrimaryHigh>
        <PriEO>string</PriEO>
        <SecEO>string</SecEO>
        <SecondaryLow>string</SecondaryLow>
        <SecondaryHigh>string</SecondaryHigh>
        <Secondary>string</Secondary>
        <Extra>string</Extra>
        <City>string</City>
        <StateAbbrev>string</StateAbbrev>
        <ZipCode>string</ZipCode>
        <CarrierRoute>string</CarrierRoute>
        <County>string</County>
        <DeliveryPoint>string</DeliveryPoint>
        <BarCode>string</BarCode>
        <CSKey>string</CSKey>
        <UpdateKey>string</UpdateKey>
        <RecordTypeCode>string</RecordTypeCode>
        <CongressDistrictNumber>string</CongressDistrictNumber>
        <FIPS>string</FIPS>
        <FinanceNumber>string</FinanceNumber>
        <CMSA>string</CMSA>
        <PMSA>string</PMSA>
        <MSA>string</MSA>
        <MA>string</MA>
        <TimeZone>string</TimeZone>
        <AreaCode>string</AreaCode>
        <PreferredCityName>string</PreferredCityName>
        <CensusBlockNum>string</CensusBlockNum>
        <CensusTractNum>string</CensusTractNum>
        <Primary>string</Primary>
        <PrefixDirection>string</PrefixDirection>
        <StreetName>string</StreetName>
        <Suffix>string</Suffix>
        <PostDirection>string</PostDirection>
        <SecondaryNumber>string</SecondaryNumber>
        <StateLegislativeUpper>string</StateLegislativeUpper>
        <StateLegislativeLower>string</StateLegislativeLower>
      </ReturnCityStateResult>
    </ReturnCityStateResponse>
  </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 /psaddress/addresslookup.asmx HTTP/1.1
Host: ws.cdyne.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>
    <ReturnCityState xmlns="http://ws.cdyne.com/">
      <zipcode>string</zipcode>
      <LicenseKey>string</LicenseKey>
    </ReturnCityState>
  </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>
    <ReturnCityStateResponse xmlns="http://ws.cdyne.com/">
      <ReturnCityStateResult>
        <ServiceError>boolean</ServiceError>
        <AddressError>boolean</AddressError>
        <AddressFoundBeMoreSpecific>boolean</AddressFoundBeMoreSpecific>
        <CheckDigit>int</CheckDigit>
        <NeededCorrection>boolean</NeededCorrection>
        <FromLongitude>decimal</FromLongitude>
        <FromLatitude>decimal</FromLatitude>
        <ToLongitude>decimal</ToLongitude>
        <ToLatitude>decimal</ToLatitude>
        <AvgLongitude>decimal</AvgLongitude>
        <AvgLatitude>decimal</AvgLatitude>
        <hasDaylightSavings>boolean</hasDaylightSavings>
        <LLCertainty>int</LLCertainty>
        <CountyNum>int</CountyNum>
        <Firm>string</Firm>
        <DeliveryAddress>string</DeliveryAddress>
        <DeliveryAddress2>string</DeliveryAddress2>
        <PrimaryLow>string</PrimaryLow>
        <PrimaryHigh>string</PrimaryHigh>
        <PriEO>string</PriEO>
        <SecEO>string</SecEO>
        <SecondaryLow>string</SecondaryLow>
        <SecondaryHigh>string</SecondaryHigh>
        <Secondary>string</Secondary>
        <Extra>string</Extra>
        <City>string</City>
        <StateAbbrev>string</StateAbbrev>
        <ZipCode>string</ZipCode>
        <CarrierRoute>string</CarrierRoute>
        <County>string</County>
        <DeliveryPoint>string</DeliveryPoint>
        <BarCode>string</BarCode>
        <CSKey>string</CSKey>
        <UpdateKey>string</UpdateKey>
        <RecordTypeCode>string</RecordTypeCode>
        <CongressDistrictNumber>string</CongressDistrictNumber>
        <FIPS>string</FIPS>
        <FinanceNumber>string</FinanceNumber>
        <CMSA>string</CMSA>
        <PMSA>string</PMSA>
        <MSA>string</MSA>
        <MA>string</MA>
        <TimeZone>string</TimeZone>
        <AreaCode>string</AreaCode>
        <PreferredCityName>string</PreferredCityName>
        <CensusBlockNum>string</CensusBlockNum>
        <CensusTractNum>string</CensusTractNum>
        <Primary>string</Primary>
        <PrefixDirection>string</PrefixDirection>
        <StreetName>string</StreetName>
        <Suffix>string</Suffix>
        <PostDirection>string</PostDirection>
        <SecondaryNumber>string</SecondaryNumber>
        <StateLegislativeUpper>string</StateLegislativeUpper>
        <StateLegislativeLower>string</StateLegislativeLower>
      </ReturnCityStateResult>
    </ReturnCityStateResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /psaddress/addresslookup.asmx/ReturnCityState?zipcode=string&LicenseKey=string HTTP/1.1
Host: ws.cdyne.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://ws.cdyne.com/">
  <ServiceError>boolean</ServiceError>
  <AddressError>boolean</AddressError>
  <AddressFoundBeMoreSpecific>boolean</AddressFoundBeMoreSpecific>
  <CheckDigit>int</CheckDigit>
  <NeededCorrection>boolean</NeededCorrection>
  <FromLongitude>decimal</FromLongitude>
  <FromLatitude>decimal</FromLatitude>
  <ToLongitude>decimal</ToLongitude>
  <ToLatitude>decimal</ToLatitude>
  <AvgLongitude>decimal</AvgLongitude>
  <AvgLatitude>decimal</AvgLatitude>
  <hasDaylightSavings>boolean</hasDaylightSavings>
  <LLCertainty>int</LLCertainty>
  <CountyNum>int</CountyNum>
  <Firm>string</Firm>
  <DeliveryAddress>string</DeliveryAddress>
  <DeliveryAddress2>string</DeliveryAddress2>
  <PrimaryLow>string</PrimaryLow>
  <PrimaryHigh>string</PrimaryHigh>
  <PriEO>string</PriEO>
  <SecEO>string</SecEO>
  <SecondaryLow>string</SecondaryLow>
  <SecondaryHigh>string</SecondaryHigh>
  <Secondary>string</Secondary>
  <Extra>string</Extra>
  <City>string</City>
  <StateAbbrev>string</StateAbbrev>
  <ZipCode>string</ZipCode>
  <CarrierRoute>string</CarrierRoute>
  <County>string</County>
  <DeliveryPoint>string</DeliveryPoint>
  <BarCode>string</BarCode>
  <CSKey>string</CSKey>
  <UpdateKey>string</UpdateKey>
  <RecordTypeCode>string</RecordTypeCode>
  <CongressDistrictNumber>string</CongressDistrictNumber>
  <FIPS>string</FIPS>
  <FinanceNumber>string</FinanceNumber>
  <CMSA>string</CMSA>
  <PMSA>string</PMSA>
  <MSA>string</MSA>
  <MA>string</MA>
  <TimeZone>string</TimeZone>
  <AreaCode>string</AreaCode>
  <PreferredCityName>string</PreferredCityName>
  <CensusBlockNum>string</CensusBlockNum>
  <CensusTractNum>string</CensusTractNum>
  <Primary>string</Primary>
  <PrefixDirection>string</PrefixDirection>
  <StreetName>string</StreetName>
  <Suffix>string</Suffix>
  <PostDirection>string</PostDirection>
  <SecondaryNumber>string</SecondaryNumber>
  <StateLegislativeUpper>string</StateLegislativeUpper>
  <StateLegislativeLower>string</StateLegislativeLower>
</Address>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /psaddress/addresslookup.asmx/ReturnCityState HTTP/1.1
Host: ws.cdyne.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

zipcode=string&LicenseKey=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Address xmlns="http://ws.cdyne.com/">
  <ServiceError>boolean</ServiceError>
  <AddressError>boolean</AddressError>
  <AddressFoundBeMoreSpecific>boolean</AddressFoundBeMoreSpecific>
  <CheckDigit>int</CheckDigit>
  <NeededCorrection>boolean</NeededCorrection>
  <FromLongitude>decimal</FromLongitude>
  <FromLatitude>decimal</FromLatitude>
  <ToLongitude>decimal</ToLongitude>
  <ToLatitude>decimal</ToLatitude>
  <AvgLongitude>decimal</AvgLongitude>
  <AvgLatitude>decimal</AvgLatitude>
  <hasDaylightSavings>boolean</hasDaylightSavings>
  <LLCertainty>int</LLCertainty>
  <CountyNum>int</CountyNum>
  <Firm>string</Firm>
  <DeliveryAddress>string</DeliveryAddress>
  <DeliveryAddress2>string</DeliveryAddress2>
  <PrimaryLow>string</PrimaryLow>
  <PrimaryHigh>string</PrimaryHigh>
  <PriEO>string</PriEO>
  <SecEO>string</SecEO>
  <SecondaryLow>string</SecondaryLow>
  <SecondaryHigh>string</SecondaryHigh>
  <Secondary>string</Secondary>
  <Extra>string</Extra>
  <City>string</City>
  <StateAbbrev>string</StateAbbrev>
  <ZipCode>string</ZipCode>
  <CarrierRoute>string</CarrierRoute>
  <County>string</County>
  <DeliveryPoint>string</DeliveryPoint>
  <BarCode>string</BarCode>
  <CSKey>string</CSKey>
  <UpdateKey>string</UpdateKey>
  <RecordTypeCode>string</RecordTypeCode>
  <CongressDistrictNumber>string</CongressDistrictNumber>
  <FIPS>string</FIPS>
  <FinanceNumber>string</FinanceNumber>
  <CMSA>string</CMSA>
  <PMSA>string</PMSA>
  <MSA>string</MSA>
  <MA>string</MA>
  <TimeZone>string</TimeZone>
  <AreaCode>string</AreaCode>
  <PreferredCityName>string</PreferredCityName>
  <CensusBlockNum>string</CensusBlockNum>
  <CensusTractNum>string</CensusTractNum>
  <Primary>string</Primary>
  <PrefixDirection>string</PrefixDirection>
  <StreetName>string</StreetName>
  <Suffix>string</Suffix>
  <PostDirection>string</PostDirection>
  <SecondaryNumber>string</SecondaryNumber>
  <StateLegislativeUpper>string</StateLegislativeUpper>
  <StateLegislativeLower>string</StateLegislativeLower>
</Address>