Page tree
Skip to end of metadata
Go to start of metadata



This operation performs basic checks on user supplied inputs; Municipality, Province or Postal Code and returns verified Municipality, Province and Postal Code. This operation also returns time zone and a check on if the supplied location is a P.O. Box, General Delivery or Rural Route. This operation requires either a Postal Code or both Municipality and Province.  Providing all inputs is recommended, because it helps the validation proceed if some of the elements are malformed.

URL Endpoints


XML:

https://trial.serviceobjects.com/AVCA2/api.svc/ValidateCanadianMunicipalityProvince?PostalCode={POSTALCODE}&Province={PROVINCE}&Municipality={MUNICIPALITY}&LicenseKey={LICENSEKEY}


ValidateCanadianMunicipalityProvince Inputs


Name

Type

Description

Municipality

String

Municipality to validate.

Postal Code

String

The Postal Code to validate, which can be supplied instead of Municipality and Province to provide validated Municipality and Province.

Province

String

The Province to validate.

LicenseKey

String

Your license key to use the service. 
Sign up for a free trial key at 
https://www.serviceobjects.com/products/address-geocoding/canada-address-validation


ValidateCanadianMunicipalityProvince Outputs


CanadianAddressResponse

Name

Type

Values

Description

CanadianAddressInfoObjectVariesThe returned values of a valid Canadian Address.
ErrorObjectVariesThe returned error result from a failed address verification or user input error.
DebugString[]VariesUsed internally for testing.


CanadianAddressInfo

Name

Type

Values

Description

Address

String

Varies

No Result.

Address 2StringVaries

No Result.

Municipality

String

Varies

The corrected Municipality.

Province

String

Varies

The corrected Province.

PostalCode

String

Varies

The corrected PostalCode.

TimeZone

String

Varies

The corresponding time zone from the validated municipality province.

AddressNumberFragment

String

Varies

No Result.

StreetNameFragment

String

Varies

No Result.

StreetTypeFragment

String

Varies

No Result.

DirectionalCodeFragment

String

Varies

No Result.

UnitTypeFragment

String

Varies

No Result.

UnitNumberFragment

String

Varies

No Result.

IsPOBox

String

Varies

The returned Boolean value of a validated address as being a PO Box address.

BoxNumberFragmentStringVaries

No Result.

StationInfoStringVaries

No Result.

DeliveryModeStringVariesThe returned Delivery Mode of the Delivery Station.
DeliveryInstallationStringVariesThe returned Delivery Installation Type where the final mail sort happens.

References


  • No labels