All Verbs | /service/LookupZipcode |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Zipcode | query | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | string | No | |
Reason | form | string | No | |
InputId | form | string | No | |
InputIndex | form | int | No | |
CityStates | form | CityEntry[] | No | |
ZipCodes | form | ZipCodeEntry[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
City | form | string | No | |
MailableCity | form | bool | No | |
StateAbbreviation | form | string | No | |
State | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ZipCode | form | string | No | |
ZipCodeType | form | string | No | |
DefaultCity | form | string | No | |
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | No | |
Latitude | form | double | No | |
Longitude | form | double | No | |
Precision | form | string | No | |
AlternateCounties | form | AlternateCounty[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CountyFips | form | string | No | |
CountyName | form | string | No | |
StateAbbreviation | form | string | No | |
State | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /service/LookupZipcode HTTP/1.1
Host: www.bernhardthospitality.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
zipcode: String
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { status: String, reason: String, input_id: String, input_index: 0, city_states: [ { city: String, mailable_city: False, state_abbreviation: String, state: String } ], zipcodes: [ { zipcode: String, zipcode_type: String, default_city: String, county_fips: String, county_name: String, state_abbreviation: String, state: String, latitude: 0, longitude: 0, precision: String, alternate_counties: [ { county_fips: String, county_name: String, state_abbreviation: String, state: String } ] } ] }