PostalCodeServices Web Service

PostalCodeServices

Click here for a complete list of operations.

GetCanadaPostalCodeAndConstituents

Given address parts, returns a list of postal codes and the well-formed parts of address, ordered by probability.

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 /ws/postalcodeservices.asmx HTTP/1.1
Host: ws.postalcodeservices.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://postalcodeservices.net/GetCanadaPostalCodeAndConstituents"

<?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>
    <GetCanadaPostalCodeAndConstituents xmlns="http://postalcodeservices.net">
      <logonID>string</logonID>
      <password>string</password>
      <CalledBy>string</CalledBy>
      <Address>string</Address>
      <city>string</city>
      <ProvAbbrev>string</ProvAbbrev>
    </GetCanadaPostalCodeAndConstituents>
  </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>
    <GetCanadaPostalCodeAndConstituentsResponse xmlns="http://postalcodeservices.net">
      <GetCanadaPostalCodeAndConstituentsResult>
        <CAN_Address>
          <ResultCode>int</ResultCode>
          <ResultText>string</ResultText>
          <PostalCode>string</PostalCode>
          <Province>string</Province>
          <Municipality>string</Municipality>
          <UnitType>string</UnitType>
          <UnitTypeAbbrev>string</UnitTypeAbbrev>
          <UnitNumber>string</UnitNumber>
          <StreetNumber>string</StreetNumber>
          <NumberSequence>string</NumberSequence>
          <StreetDirection>string</StreetDirection>
          <StreetDirectionAbbrev>string</StreetDirectionAbbrev>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <StreetTypeAbbrev>string</StreetTypeAbbrev>
          <RouteServiceType>string</RouteServiceType>
          <RouteServiceNumber>string</RouteServiceNumber>
          <RouteServiceBoxMarker>string</RouteServiceBoxMarker>
          <RouteServiceBox>string</RouteServiceBox>
          <DeliveryInstallationType>string</DeliveryInstallationType>
          <DeliveryInstallationAreaName>string</DeliveryInstallationAreaName>
          <DeliveryInstallationQualifier>string</DeliveryInstallationQualifier>
          <LockBoxMarker>string</LockBoxMarker>
          <LockBoxBagNumber>string</LockBoxBagNumber>
          <LockBoxBagFromTo>string</LockBoxBagFromTo>
          <LargeVolumeReceiverName>string</LargeVolumeReceiverName>
        </CAN_Address>
        <CAN_Address>
          <ResultCode>int</ResultCode>
          <ResultText>string</ResultText>
          <PostalCode>string</PostalCode>
          <Province>string</Province>
          <Municipality>string</Municipality>
          <UnitType>string</UnitType>
          <UnitTypeAbbrev>string</UnitTypeAbbrev>
          <UnitNumber>string</UnitNumber>
          <StreetNumber>string</StreetNumber>
          <NumberSequence>string</NumberSequence>
          <StreetDirection>string</StreetDirection>
          <StreetDirectionAbbrev>string</StreetDirectionAbbrev>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <StreetTypeAbbrev>string</StreetTypeAbbrev>
          <RouteServiceType>string</RouteServiceType>
          <RouteServiceNumber>string</RouteServiceNumber>
          <RouteServiceBoxMarker>string</RouteServiceBoxMarker>
          <RouteServiceBox>string</RouteServiceBox>
          <DeliveryInstallationType>string</DeliveryInstallationType>
          <DeliveryInstallationAreaName>string</DeliveryInstallationAreaName>
          <DeliveryInstallationQualifier>string</DeliveryInstallationQualifier>
          <LockBoxMarker>string</LockBoxMarker>
          <LockBoxBagNumber>string</LockBoxBagNumber>
          <LockBoxBagFromTo>string</LockBoxBagFromTo>
          <LargeVolumeReceiverName>string</LargeVolumeReceiverName>
        </CAN_Address>
      </GetCanadaPostalCodeAndConstituentsResult>
    </GetCanadaPostalCodeAndConstituentsResponse>
  </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 /ws/postalcodeservices.asmx HTTP/1.1
Host: ws.postalcodeservices.net
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>
    <GetCanadaPostalCodeAndConstituents xmlns="http://postalcodeservices.net">
      <logonID>string</logonID>
      <password>string</password>
      <CalledBy>string</CalledBy>
      <Address>string</Address>
      <city>string</city>
      <ProvAbbrev>string</ProvAbbrev>
    </GetCanadaPostalCodeAndConstituents>
  </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>
    <GetCanadaPostalCodeAndConstituentsResponse xmlns="http://postalcodeservices.net">
      <GetCanadaPostalCodeAndConstituentsResult>
        <CAN_Address>
          <ResultCode>int</ResultCode>
          <ResultText>string</ResultText>
          <PostalCode>string</PostalCode>
          <Province>string</Province>
          <Municipality>string</Municipality>
          <UnitType>string</UnitType>
          <UnitTypeAbbrev>string</UnitTypeAbbrev>
          <UnitNumber>string</UnitNumber>
          <StreetNumber>string</StreetNumber>
          <NumberSequence>string</NumberSequence>
          <StreetDirection>string</StreetDirection>
          <StreetDirectionAbbrev>string</StreetDirectionAbbrev>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <StreetTypeAbbrev>string</StreetTypeAbbrev>
          <RouteServiceType>string</RouteServiceType>
          <RouteServiceNumber>string</RouteServiceNumber>
          <RouteServiceBoxMarker>string</RouteServiceBoxMarker>
          <RouteServiceBox>string</RouteServiceBox>
          <DeliveryInstallationType>string</DeliveryInstallationType>
          <DeliveryInstallationAreaName>string</DeliveryInstallationAreaName>
          <DeliveryInstallationQualifier>string</DeliveryInstallationQualifier>
          <LockBoxMarker>string</LockBoxMarker>
          <LockBoxBagNumber>string</LockBoxBagNumber>
          <LockBoxBagFromTo>string</LockBoxBagFromTo>
          <LargeVolumeReceiverName>string</LargeVolumeReceiverName>
        </CAN_Address>
        <CAN_Address>
          <ResultCode>int</ResultCode>
          <ResultText>string</ResultText>
          <PostalCode>string</PostalCode>
          <Province>string</Province>
          <Municipality>string</Municipality>
          <UnitType>string</UnitType>
          <UnitTypeAbbrev>string</UnitTypeAbbrev>
          <UnitNumber>string</UnitNumber>
          <StreetNumber>string</StreetNumber>
          <NumberSequence>string</NumberSequence>
          <StreetDirection>string</StreetDirection>
          <StreetDirectionAbbrev>string</StreetDirectionAbbrev>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <StreetTypeAbbrev>string</StreetTypeAbbrev>
          <RouteServiceType>string</RouteServiceType>
          <RouteServiceNumber>string</RouteServiceNumber>
          <RouteServiceBoxMarker>string</RouteServiceBoxMarker>
          <RouteServiceBox>string</RouteServiceBox>
          <DeliveryInstallationType>string</DeliveryInstallationType>
          <DeliveryInstallationAreaName>string</DeliveryInstallationAreaName>
          <DeliveryInstallationQualifier>string</DeliveryInstallationQualifier>
          <LockBoxMarker>string</LockBoxMarker>
          <LockBoxBagNumber>string</LockBoxBagNumber>
          <LockBoxBagFromTo>string</LockBoxBagFromTo>
          <LargeVolumeReceiverName>string</LargeVolumeReceiverName>
        </CAN_Address>
      </GetCanadaPostalCodeAndConstituentsResult>
    </GetCanadaPostalCodeAndConstituentsResponse>
  </soap12:Body>
</soap12:Envelope>