Post Request Parameters
All addresses use this format regardless of the country of the address.
| Parameter | Description |
|---|---|
| PostalCode |
A U.S. ZIP Code™ or Canadian postal code in one of the following formats: 99999 99999-9999 A9A9A9 A9A 9A9 |
| PerformUSProcessing |
Specifies whether or not to process U.S. addresses. If you enable U.S. address processing GetCityStateProvince will attempt to return the state for U.S. addresses. If you disable U.S. address processing, U.S. addresses will fail, meaning they are returned with an "F" in the Status output field. The output field Status.Code will say "DisabledCoder." . Y Yes, process U.S. addresses (default). N No, do not process U.S. addresses.
Note: Any value other than "Y"
or "N" gets converted to default. |
| PerformCanadianProcessing | Specifies whether or not to process Canadian addresses. If you
enable Canadian address processing GetCityStateProvince will attempt
to return the province for Canadian addresses. If you disable
Canadian address processing, Canadian addresses will fail, meaning
they are returned with an "F" in the Status output field. The output
field Status.Code will say "DisabledCoder." . Y Yes, process Canadian addresses (default). N No,
do not process Canadian addresses. Note: Any value other than "Y"
or "N" gets converted to default. |
| OutputVanityCity |
Specifies whether or not to include non-mailing city names in the output. A non-mailing city name is an alternate name for the primary city name. For example, Hollywood is a non-mailing city name for Los Angeles. Y Yes, include non-mailing city names. N No, do not include non-mailing city names (default).
Note: Any
value other than "Y" or "N" gets converted to
default. |
| MaximumResults | Specifies the maximum number of city-state/province pairs to return. The default value is 10. |