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.
Detailed boolean true,false An optional parameter to request more detail for each matching FFL.

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

The output from this call depends on the value or existence of the Detailed parameter

When Detailed is not provided or is false

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.

When Detailed is true

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.
CellPhone string string The cell phone number for the FFL.
City string string The city for the FFL.
Company string string The company name for the FFL.
Fax string string The fax number for the FFL.
HandGunDescription string string The Hand Gun Fee Description for the FFL.
HandGunFee decimal decimal The Hand Gun Fee for the FFL.
Hours string string The hours of operation for the FFL.
Latitude decimal decimal The Latitude for the FFL.
Longitude decimal decimal The Longitude for the FFL.
LongGunDescription string string The Long Gun Fee Description for the FFL.
LongGunFee decimal decimal The Long Gun Fee for the FFL.
LicenseNumber string string The FFL license number.
Name string string The name of the FFL.
NICSGunDescription string string The NICS Fee Description for the FFL.
NICSGunFee decimal decimal The NICS Fee for the FFL.
OtherDescription string string The Other Fee Description for the FFL.
OtherFee decimal decimal Any Other Fee for the FFL.
OtherPhone string string The other phone number for the FFL.
Phone string string The phone number for the FFL.
PromotionalText string string Promotional text as entered by the FFL.
State string string The state for the FFL.
Website string string The FFL Dealer's website.
Zip string string The zip code for the FFL.

Links

Rel Description Condition
contact Contact the FFL Dealer

Links

Rel Description Condition
details FFL Dealer details