BCC ZIPFOURce Web Service Web Service

BCC ZIPFOURce Web Service

Click here for a complete list of operations.

EncodeAddressWithOptions

This method provides for single address encoding with options set.

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 /zipfourcews.asmx HTTP/1.1
Host: ws.bccsoftware.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ws.bccsoftware.com/ZIPFOURce/EncodeAddressWithOptions"

<?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>
    <EncodeAddressWithOptions xmlns="http://ws.bccsoftware.com/ZIPFOURce">
      <LicenseKey>string</LicenseKey>
      <Options>
        <ReturnCase>Upper or Lower or Mixed or Automatic or AsIs</ReturnCase>
        <FirmAsIs>boolean</FirmAsIs>
        <UseCapitalizationTable>boolean</UseCapitalizationTable>
        <SwapAddressLines>boolean</SwapAddressLines>
        <StandardizeDeliveryAddress>boolean</StandardizeDeliveryAddress>
        <StandardizeCity>boolean</StandardizeCity>
        <AbbreviateCity>boolean</AbbreviateCity>
        <ExtendedMatching>boolean</ExtendedMatching>
        <UseSmallTownDefault>boolean</UseSmallTownDefault>
        <HyphenateZIPCode>boolean</HyphenateZIPCode>
        <IgnoreNonUSPS>boolean</IgnoreNonUSPS>
        <Reserved2>boolean</Reserved2>
        <Reserved3>boolean</Reserved3>
        <Reserved4>boolean</Reserved4>
        <StandardizeCountry>boolean</StandardizeCountry>
        <GeoCodeAddress>boolean</GeoCodeAddress>
        <ReturnZIP5GeoCodes>boolean</ReturnZIP5GeoCodes>
        <RDILookup>boolean</RDILookup>
        <AddCountryInformation>boolean</AddCountryInformation>
        <AreaCodeTimeZoneLookup>boolean</AreaCodeTimeZoneLookup>
        <ReturnZIP5CheckDigit>boolean</ReturnZIP5CheckDigit>
        <LACSLinkLookup>boolean</LACSLinkLookup>
        <UseSecondaryAddress>boolean</UseSecondaryAddress>
        <ReturnCounty>boolean</ReturnCounty>
        <ReturnParsedAddressInformation>boolean</ReturnParsedAddressInformation>
        <FourStateCustomerBarcode>boolean</FourStateCustomerBarcode>
        <SuiteLinkLookup>boolean</SuiteLinkLookup>
        <NoDPVCMRA>boolean</NoDPVCMRA>
        <NoDPVNoStat>boolean</NoDPVNoStat>
        <NoDPVVacant>boolean</NoDPVVacant>
        <AbbreviateAddress>boolean</AbbreviateAddress>
      </Options>
      <UserDefinedId>string</UserDefinedId>
      <Firm>string</Firm>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Address3>string</Address3>
      <SecondaryAddressInfo>string</SecondaryAddressInfo>
      <Urbanization>string</Urbanization>
      <City>string</City>
      <State>string</State>
      <Zipcode>string</Zipcode>
      <ResellerCustId>string</ResellerCustId>
      <Country>string</Country>
    </EncodeAddressWithOptions>
  </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>
    <EncodeAddressWithOptionsResponse xmlns="http://ws.bccsoftware.com/ZIPFOURce">
      <EncodeAddressWithOptionsResult>
        <UserDefinedId>string</UserDefinedId>
        <Firm>string</Firm>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <SecondaryAddressInfo>string</SecondaryAddressInfo>
        <Urbanization>string</Urbanization>
        <City>string</City>
        <State>string</State>
        <Zipcode>string</Zipcode>
        <CityAbbreviation>string</CityAbbreviation>
        <County>string</County>
        <DeliveryPoint>string</DeliveryPoint>
        <CheckDigit>string</CheckDigit>
        <CarrierRoute>string</CarrierRoute>
        <ELOT>string</ELOT>
        <DPV>string</DPV>
        <DPVCMRA>string</DPVCMRA>
        <DPVFP>string</DPVFP>
        <DPVFootnotes>string</DPVFootnotes>
        <RDI>string</RDI>
        <RecordType>string</RecordType>
        <FIPSCountyCode>string</FIPSCountyCode>
        <LACSIndicator>string</LACSIndicator>
        <LACSLinkFootnote>string</LACSLinkFootnote>
        <LACSLinkIndicator>string</LACSLinkIndicator>
        <CongressionalDistrict>string</CongressionalDistrict>
        <ReturnCode>int</ReturnCode>
        <Footnotes>string</Footnotes>
        <CountryCode>string</CountryCode>
        <GeoCoded>boolean</GeoCoded>
        <Latitude>double</Latitude>
        <Longitude>double</Longitude>
        <ParsedPMBDesignator>string</ParsedPMBDesignator>
        <ParsedPMBNumber>string</ParsedPMBNumber>
        <ParsedPostDirectional>string</ParsedPostDirectional>
        <ParsedPreDirectional>string</ParsedPreDirectional>
        <ParsedPrimaryNumber>string</ParsedPrimaryNumber>
        <ParsedStreetName>string</ParsedStreetName>
        <ParsedSuffix>string</ParsedSuffix>
        <ParsedUnitDesignator>string</ParsedUnitDesignator>
        <ParsedUnitNumber>string</ParsedUnitNumber>
        <AreaCode>string</AreaCode>
        <TimeZone>string</TimeZone>
        <DayLightSavings>boolean</DayLightSavings>
        <StatusMessage>string</StatusMessage>
        <ErrorMessage>string</ErrorMessage>
        <ErrorNumber>int</ErrorNumber>
        <SuiteLinkFootnote>string</SuiteLinkFootnote>
        <FinanceNumber>string</FinanceNumber>
        <DPVNoStat>string</DPVNoStat>
        <DPVVacant>string</DPVVacant>
      </EncodeAddressWithOptionsResult>
    </EncodeAddressWithOptionsResponse>
  </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 /zipfourcews.asmx HTTP/1.1
Host: ws.bccsoftware.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>
    <EncodeAddressWithOptions xmlns="http://ws.bccsoftware.com/ZIPFOURce">
      <LicenseKey>string</LicenseKey>
      <Options>
        <ReturnCase>Upper or Lower or Mixed or Automatic or AsIs</ReturnCase>
        <FirmAsIs>boolean</FirmAsIs>
        <UseCapitalizationTable>boolean</UseCapitalizationTable>
        <SwapAddressLines>boolean</SwapAddressLines>
        <StandardizeDeliveryAddress>boolean</StandardizeDeliveryAddress>
        <StandardizeCity>boolean</StandardizeCity>
        <AbbreviateCity>boolean</AbbreviateCity>
        <ExtendedMatching>boolean</ExtendedMatching>
        <UseSmallTownDefault>boolean</UseSmallTownDefault>
        <HyphenateZIPCode>boolean</HyphenateZIPCode>
        <IgnoreNonUSPS>boolean</IgnoreNonUSPS>
        <Reserved2>boolean</Reserved2>
        <Reserved3>boolean</Reserved3>
        <Reserved4>boolean</Reserved4>
        <StandardizeCountry>boolean</StandardizeCountry>
        <GeoCodeAddress>boolean</GeoCodeAddress>
        <ReturnZIP5GeoCodes>boolean</ReturnZIP5GeoCodes>
        <RDILookup>boolean</RDILookup>
        <AddCountryInformation>boolean</AddCountryInformation>
        <AreaCodeTimeZoneLookup>boolean</AreaCodeTimeZoneLookup>
        <ReturnZIP5CheckDigit>boolean</ReturnZIP5CheckDigit>
        <LACSLinkLookup>boolean</LACSLinkLookup>
        <UseSecondaryAddress>boolean</UseSecondaryAddress>
        <ReturnCounty>boolean</ReturnCounty>
        <ReturnParsedAddressInformation>boolean</ReturnParsedAddressInformation>
        <FourStateCustomerBarcode>boolean</FourStateCustomerBarcode>
        <SuiteLinkLookup>boolean</SuiteLinkLookup>
        <NoDPVCMRA>boolean</NoDPVCMRA>
        <NoDPVNoStat>boolean</NoDPVNoStat>
        <NoDPVVacant>boolean</NoDPVVacant>
        <AbbreviateAddress>boolean</AbbreviateAddress>
      </Options>
      <UserDefinedId>string</UserDefinedId>
      <Firm>string</Firm>
      <Address1>string</Address1>
      <Address2>string</Address2>
      <Address3>string</Address3>
      <SecondaryAddressInfo>string</SecondaryAddressInfo>
      <Urbanization>string</Urbanization>
      <City>string</City>
      <State>string</State>
      <Zipcode>string</Zipcode>
      <ResellerCustId>string</ResellerCustId>
      <Country>string</Country>
    </EncodeAddressWithOptions>
  </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>
    <EncodeAddressWithOptionsResponse xmlns="http://ws.bccsoftware.com/ZIPFOURce">
      <EncodeAddressWithOptionsResult>
        <UserDefinedId>string</UserDefinedId>
        <Firm>string</Firm>
        <Address1>string</Address1>
        <Address2>string</Address2>
        <Address3>string</Address3>
        <SecondaryAddressInfo>string</SecondaryAddressInfo>
        <Urbanization>string</Urbanization>
        <City>string</City>
        <State>string</State>
        <Zipcode>string</Zipcode>
        <CityAbbreviation>string</CityAbbreviation>
        <County>string</County>
        <DeliveryPoint>string</DeliveryPoint>
        <CheckDigit>string</CheckDigit>
        <CarrierRoute>string</CarrierRoute>
        <ELOT>string</ELOT>
        <DPV>string</DPV>
        <DPVCMRA>string</DPVCMRA>
        <DPVFP>string</DPVFP>
        <DPVFootnotes>string</DPVFootnotes>
        <RDI>string</RDI>
        <RecordType>string</RecordType>
        <FIPSCountyCode>string</FIPSCountyCode>
        <LACSIndicator>string</LACSIndicator>
        <LACSLinkFootnote>string</LACSLinkFootnote>
        <LACSLinkIndicator>string</LACSLinkIndicator>
        <CongressionalDistrict>string</CongressionalDistrict>
        <ReturnCode>int</ReturnCode>
        <Footnotes>string</Footnotes>
        <CountryCode>string</CountryCode>
        <GeoCoded>boolean</GeoCoded>
        <Latitude>double</Latitude>
        <Longitude>double</Longitude>
        <ParsedPMBDesignator>string</ParsedPMBDesignator>
        <ParsedPMBNumber>string</ParsedPMBNumber>
        <ParsedPostDirectional>string</ParsedPostDirectional>
        <ParsedPreDirectional>string</ParsedPreDirectional>
        <ParsedPrimaryNumber>string</ParsedPrimaryNumber>
        <ParsedStreetName>string</ParsedStreetName>
        <ParsedSuffix>string</ParsedSuffix>
        <ParsedUnitDesignator>string</ParsedUnitDesignator>
        <ParsedUnitNumber>string</ParsedUnitNumber>
        <AreaCode>string</AreaCode>
        <TimeZone>string</TimeZone>
        <DayLightSavings>boolean</DayLightSavings>
        <StatusMessage>string</StatusMessage>
        <ErrorMessage>string</ErrorMessage>
        <ErrorNumber>int</ErrorNumber>
        <SuiteLinkFootnote>string</SuiteLinkFootnote>
        <FinanceNumber>string</FinanceNumber>
        <DPVNoStat>string</DPVNoStat>
        <DPVVacant>string</DPVVacant>
      </EncodeAddressWithOptionsResult>
    </EncodeAddressWithOptionsResponse>
  </soap12:Body>
</soap12:Envelope>