PostalCodeServices Web Service

PostalCodeServices

Click here for a complete list of operations.

GetCanadaPostalCodeAddress

Given a Postal Code and a street number, returns valid address range elements for the postal, 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/GetCanadaPostalCodeAddress"

<?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>
    <GetCanadaPostalCodeAddress xmlns="http://postalcodeservices.net">
      <logonID>string</logonID>
      <password>string</password>
      <CalledBy>string</CalledBy>
      <StreetNo>string</StreetNo>
      <PostalCode>string</PostalCode>
    </GetCanadaPostalCodeAddress>
  </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>
    <GetCanadaPostalCodeAddressResponse xmlns="http://postalcodeservices.net">
      <GetCanadaPostalCodeAddressResult>
        <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>
      </GetCanadaPostalCodeAddressResult>
    </GetCanadaPostalCodeAddressResponse>
  </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>
    <GetCanadaPostalCodeAddress xmlns="http://postalcodeservices.net">
      <logonID>string</logonID>
      <password>string</password>
      <CalledBy>string</CalledBy>
      <StreetNo>string</StreetNo>
      <PostalCode>string</PostalCode>
    </GetCanadaPostalCodeAddress>
  </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>
    <GetCanadaPostalCodeAddressResponse xmlns="http://postalcodeservices.net">
      <GetCanadaPostalCodeAddressResult>
        <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>
      </GetCanadaPostalCodeAddressResult>
    </GetCanadaPostalCodeAddressResponse>
  </soap12:Body>
</soap12:Envelope>