FFLs by /FFLs/Zip/{zip} GET

Returns FFLs as a List Response sorted by distance descending based upon the location of a US postal zip code.

URL
/FFLs/Zip/{zip}
Verb
GET

Headers

Header Data Type Valid Values Required Description
Content-Type string application/json YES The format your data will be sent to our site.
X-DevKey string string YES The devkey assigned to the developer.
X-AccessToken string string Optional The token acquired from a POST to Users/AccessToken.

Input

NOTE: Variables to place in the body of the request.

Parameter Data Type Valid Values Description
State string 2 character abbreviation for the state An optional parameter to only return results for a given state.
Radius decimal positive # An optional parameter to filter results based upon the radius measured in miles.
PartnerID integer positive # An optional parameter to filter results based upon a specific partner.

Optional PagingParameters

Output

If the zipcode is not a valid 5 digit zipcode, you will receive a 400 BadRequest and a Message Response indicating the reason.

If the zipcode is valid but not found, you will receive a 404 NotFound and a Message Response indicating the reason.

If there are no errors with the input parameters, this call will respond with a 200 OK and the following data as serialized JSON

Parameter Data Type Valid Values Description
FFLID integer positive integer The id of the FFL.
Address1 string string The street address for the FFL.
Address2 string string The street address for the FFL.
City string string The city for the FFL.
Company string string The company name for the FFL.
Distance decimal 0 to positive # The distance from the given search criteria of the FFL.
Latitude decimal decimal The Latitude for the FFL.
Longitude decimal decimal The Longitude for the FFL.
Name string string The name of the FFL.
State string string The state for the FFL.
Zip string string The zip code for the FFL.

Links

Rel Description Condition
details FFL Dealer details