PostalCodeServices
Click here for a complete list of operations.
GetCanadaPostalCodeDetails
Given a Postal Code, this returns valid address range elements for the postal code ranked by most probable.
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/GetCanadaPostalCodeDetails" <?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> <GetCanadaPostalCodeDetails xmlns="http://postalcodeservices.net"> <logonID>string</logonID> <password>string</password> <CalledBy>string</CalledBy> <PostalCode>string</PostalCode> </GetCanadaPostalCodeDetails> </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> <GetCanadaPostalCodeDetailsResponse xmlns="http://postalcodeservices.net"> <GetCanadaPostalCodeDetailsResult> <CAN_PostalCodeDetails> <ResultCode>int</ResultCode> <ResultText>string</ResultText> <PostalCode>string</PostalCode> <Province>string</Province> <Municipality>string</Municipality> <StreetDirection>string</StreetDirection> <StreetDirectionAbbrev>string</StreetDirectionAbbrev> <StreetName>string</StreetName> <StreetType>string</StreetType> <RouteServiceType>string</RouteServiceType> <RouteServiceNumber>string</RouteServiceNumber> <LargeVolumeReceiverName>string</LargeVolumeReceiverName> <StreetAddressToNumber>string</StreetAddressToNumber> <StreetAddressFromNumber>string</StreetAddressFromNumber> <SuiteToNumber>string</SuiteToNumber> <SuiteFromNumber>string</SuiteFromNumber> <RouteServiceBoxToNumber>string</RouteServiceBoxToNumber> <RouteServiceBoxFromNumber>string</RouteServiceBoxFromNumber> <LockBoxBagToNumber>string</LockBoxBagToNumber> <LockBoxBagFromNumber>string</LockBoxBagFromNumber> <LargeVolumeReceiver>string</LargeVolumeReceiver> </CAN_PostalCodeDetails> <CAN_PostalCodeDetails> <ResultCode>int</ResultCode> <ResultText>string</ResultText> <PostalCode>string</PostalCode> <Province>string</Province> <Municipality>string</Municipality> <StreetDirection>string</StreetDirection> <StreetDirectionAbbrev>string</StreetDirectionAbbrev> <StreetName>string</StreetName> <StreetType>string</StreetType> <RouteServiceType>string</RouteServiceType> <RouteServiceNumber>string</RouteServiceNumber> <LargeVolumeReceiverName>string</LargeVolumeReceiverName> <StreetAddressToNumber>string</StreetAddressToNumber> <StreetAddressFromNumber>string</StreetAddressFromNumber> <SuiteToNumber>string</SuiteToNumber> <SuiteFromNumber>string</SuiteFromNumber> <RouteServiceBoxToNumber>string</RouteServiceBoxToNumber> <RouteServiceBoxFromNumber>string</RouteServiceBoxFromNumber> <LockBoxBagToNumber>string</LockBoxBagToNumber> <LockBoxBagFromNumber>string</LockBoxBagFromNumber> <LargeVolumeReceiver>string</LargeVolumeReceiver> </CAN_PostalCodeDetails> </GetCanadaPostalCodeDetailsResult> </GetCanadaPostalCodeDetailsResponse> </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> <GetCanadaPostalCodeDetails xmlns="http://postalcodeservices.net"> <logonID>string</logonID> <password>string</password> <CalledBy>string</CalledBy> <PostalCode>string</PostalCode> </GetCanadaPostalCodeDetails> </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> <GetCanadaPostalCodeDetailsResponse xmlns="http://postalcodeservices.net"> <GetCanadaPostalCodeDetailsResult> <CAN_PostalCodeDetails> <ResultCode>int</ResultCode> <ResultText>string</ResultText> <PostalCode>string</PostalCode> <Province>string</Province> <Municipality>string</Municipality> <StreetDirection>string</StreetDirection> <StreetDirectionAbbrev>string</StreetDirectionAbbrev> <StreetName>string</StreetName> <StreetType>string</StreetType> <RouteServiceType>string</RouteServiceType> <RouteServiceNumber>string</RouteServiceNumber> <LargeVolumeReceiverName>string</LargeVolumeReceiverName> <StreetAddressToNumber>string</StreetAddressToNumber> <StreetAddressFromNumber>string</StreetAddressFromNumber> <SuiteToNumber>string</SuiteToNumber> <SuiteFromNumber>string</SuiteFromNumber> <RouteServiceBoxToNumber>string</RouteServiceBoxToNumber> <RouteServiceBoxFromNumber>string</RouteServiceBoxFromNumber> <LockBoxBagToNumber>string</LockBoxBagToNumber> <LockBoxBagFromNumber>string</LockBoxBagFromNumber> <LargeVolumeReceiver>string</LargeVolumeReceiver> </CAN_PostalCodeDetails> <CAN_PostalCodeDetails> <ResultCode>int</ResultCode> <ResultText>string</ResultText> <PostalCode>string</PostalCode> <Province>string</Province> <Municipality>string</Municipality> <StreetDirection>string</StreetDirection> <StreetDirectionAbbrev>string</StreetDirectionAbbrev> <StreetName>string</StreetName> <StreetType>string</StreetType> <RouteServiceType>string</RouteServiceType> <RouteServiceNumber>string</RouteServiceNumber> <LargeVolumeReceiverName>string</LargeVolumeReceiverName> <StreetAddressToNumber>string</StreetAddressToNumber> <StreetAddressFromNumber>string</StreetAddressFromNumber> <SuiteToNumber>string</SuiteToNumber> <SuiteFromNumber>string</SuiteFromNumber> <RouteServiceBoxToNumber>string</RouteServiceBoxToNumber> <RouteServiceBoxFromNumber>string</RouteServiceBoxFromNumber> <LockBoxBagToNumber>string</LockBoxBagToNumber> <LockBoxBagFromNumber>string</LockBoxBagFromNumber> <LargeVolumeReceiver>string</LargeVolumeReceiver> </CAN_PostalCodeDetails> </GetCanadaPostalCodeDetailsResult> </GetCanadaPostalCodeDetailsResponse> </soap12:Body> </soap12:Envelope>