Post Request Parameters
All addresses use this format regardless of the country of the address.
Parameter | Description |
---|---|
City |
The city whose postal codes you want to look up. You may put the city and state in the City field. If you do this, you must leave the StateProvince field blank. The total length of the City and StateProvince fields cannot exceed 100 characters. |
StateProvince |
The state or province of the city whose postal codes you want to look up. You may also put the state in the City field instead of the StateProvince field. The total length of the City and StateProvince fields cannot exceed 100 characters.Note: If
the option OutputCityType is set as "Y", the output is
displayed only if you use an abbreviated form of the state or
province in this field. |
OutputVanityCity |
Specifies whether or not to include postal codes for the city's non-mailing city names. 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 postal codes for non-mailing city names. N No, do not include postal codes for non-mailing city names
(default).
Note: Any value other than "Y" or "N" gets
converted to default. |
OutputCityType |
Specifies whether or not to return the city type in the output. If enabled, the city type is returned in the 'City.Type' field. Y Yes, include the city type in the output. N No, do not include the city type in the output
(default).
Note: Any value other than "Y" or "N" gets
converted to default. |