API eState

API eState

API Post Requirements

  1. Must be a POST
  2. JSON format
  3. In the Request Header
    1.    Pass the authentication token
§  X-Api-Auth-Token: Individually Generated
  1. Set the content type
§  Content-Type: application/json

 

Authentication and Identification

  1. Each client has its own authentication token which enables access to the database.

 

URL to Post API Request – Dev Environment

  1.  http://dev.fflbizhub.com/api/state/search

 

URL to Post API Request – Live Environment

  1. https://app.fflbizhub.com/api/state/search

 

Call Types

By Firearm Attributes

  1. Accepts a list of firearm attributes to test for potential restrictions in JSON format
  2. May be utilized with or without zip code

 

Attributes WITH Zip Code Submission

      When  API  call  is  submitted with   zip  code,  API  will  return  pass  or  restricted  response  for  that  zip  code  area only.

 

Image 1: Attributes WITH Zip Code Submission



Attributes withOUT Zip Code Submission

      When API call is submitted withOUT a zip code, API will return any areas where the specific firearm has potential transfer restrictions will be provided by state and/or specific municipalities or “pass” if firearm does not appear to be restricted in any area.

 

Image 2: Attributes withOUT Zip Code Submission




API Submission – Required Fields:


1.        FirearmType (Required) Must EXACTLY Match text strings as defined by database (See Text String Definitions: Handgun, Shotgun, Rifle).

a.         FirearmTypes:

i.        rifle

ii.        shotgun

iii.         handgun

b.         Other types will respond with an error

2.        Options (Required) Must EXACTLY Match text strings as defined by database (See Text String Definitions: Handgun, Shotgun, Rifle)

3.        Features (Features object is required but individual features need not be submitted for item) Must EXACTLY Match text strings as defined by database (See Text String Definitions: Handgun, Shotgun, Rifle)

 

API Submission – Optional Fields:

1. Zip Code (Optional) – Must be five (5) digit zip code

 

Submission Errors

1. If  any  text  string  submitted  is  not  an  exact  match  text  strings  defined in database (See Text String Definitions: Handgun, Shotgun, Rifle), API will return an error message.






By Firearm UPC


      Accepts a UPC for a specific firearm to test for potential restrictions in JSON format

      May be utilized with or without zip code

 

UPC WITH Zip Code Submission

      When  API  call  is  submitted  with   zip  code,  API  will  return  a pass  or  restricted  response  for  that  zip  code  area only.

 

Image 4: Attributes WITH Zip Code Submission




UPC withOUT Zip Code Submission

      When API call is submitted withOUT a zip code, API will return any areas where the specific UPC has potential transfer restrictions will be provided by state and/or specific municipalities or “pass” if firearm does not appear to be restricted in any area.

 

Image 5: Attributes withOUT Zip Code Submission




API Submission – Required Fields:

1. UPC (Required) – Must EXACTLY Match UPC for item, including any leading 0’s.

 

API Submission – Optional Fields:

1. Zip Code (Optional) – Must be five (5) digit zip code

 

Submission Errors

1. If UPC submitted is not an exact match to a UPC defined in database, API will return an error message.

 

Image 6: UPC Not Found Error



Transaction Examples

Header Example

POST /api/state/search HTTP/1.1 Host: app.fflbizhub.com

X-Api-Auth-Token: XXXXXXXXXXXX Content-Type: application/json cache-control: no-cache

 

Firearm Attributes Example

{

"zip":"", "firearmType":"Rifle", "options":[

{"OptionName":"Action","value":"Lever"},

{"OptionName":"cartridge","value":"Centerfire"},

{"OptionName":"Magazine","value":"Fixed Magazine"}

],

"features":[

{"featureName":"Magazine Capacity Over 5 Rounds"},

{"featureName":"Magazine Capacity Over 8 Rounds"}

]

}

 

UPC Example

{ "UPC":"6026863130566",

"zip":""

}

State Restrictions Text Strings

 

State Restrictions Text Strings - Handgun:

 

firearmType
handgun
OptionName
Action
Semiautomatic
Revolver
Full Auto
Break
Cartridge
Centerfire
Rimfire
Magazine
Detachable Magazine
Fixed Magazine
Bullet Button Magazine
Belt Fed
N/A
featureName
Ability to accept magazine outside pistol grip
Barrel Shroud
Binary Trigger
Capable of Firing a Projectile Greater Than .60 Caliber
Centerfire with length of 12 inches or more
Folding Stock
Forward Pistol Grip
Handguard
Magazine ability to accept more than 10 rounds
Magazine ability to accept more than 15 rounds
Magazine Capacity Over 10 Rounds
Magazine Capacity Over 15 Rounds
Magazine Capacity Over 16 Rounds
Magazine Capacity Over 17 Rounds
Magazine Capacity Over 30 Rounds
Magazine Capacity Over 35 Rounds
Multiburst Trigger Activator
Muzzle Brake
Muzzle Compensator
Overall Length of 12" or Greater
Second hand grip
Selective-fire Capable of full auto semiauto or burst fire
Semiautomatic Version of an Automatic Firearm
Smooth Bore
Telescoping Stock
Threaded Barrel
Thumbhole Stock
Trigger Crank
Weight of 50 oz. or more when unloaded

State Restrictions Text Strings - Shotgun:

 

firearmType
Shotgun
OptionName
Action
Semiautomatic
Pump
Lever
Bolt
Break
Full Auto
Magazine
Detachable Magazine
Belt Fed
Fixed
N/A
featureName
Barrel Length Less than 18 inches
Barrel shroud
Bayonet mount
Bump Stock
Detachable Stock
Drum magazine over 12 rounds
Flare Launcher
Flash suppressor
Folding stock
Forward pistol grip
Grenade Launcher
Magazine Capacity Over 10 rounds
Magazine Capacity Over 15 rounds
Magazine Capacity Over 16 rounds
Magazine Capacity Over 5 rounds
Magazine Capacity Over 6 rounds
Magazine Capacity Over 7 rounds
Multiburst Trigger Activator
No Stock
Overall Length Less than 26 Inches
Pistol Grip
Pistol Grip Separate From Stock
Revolving Cylinder Magazine
Rocket Launcher
Selective-fire Capable of full auto semiauto or burst fire
Shotgun Without a Fixed Stock Capable of Being Fired from the Shoulder
Sighting Device Making a Target Visible at Night
Stockless Pistol Grip Only
Telescoping stock
Threaded Barrel Designed to Accommodate a Flash Suppressor
Thumbhole stock
Trigger Crank
Binary Trigger
Magazine Capacity Over 35 Rounds
Semiautomatic Version of Automatic Shotgun
Tubular Magazine Extension

State Restrictions Text Strings - Rifle:

 firearmType

Rifle
OptionName
Action
Semiautomatic
Pump
Lever
Bolt
Full Auto
Break
Cartridge
Centerfire
Rimfire
Magazine
Detachable Magazine
Bullet Button Magazine
Fixed Magazine
Belt Fed
N/A
featureName
Barrel Length Less Than 16 inches
Barrel Shroud
Bayonet Lug or Mount
Binary Trigger
Bump Stock
Capable of Firing a .50BMG Cartridge
Capable of Firing a 12.7mm or Other Metric Equivalent of .50BMG
Capable of Firing a Projectile Greater Than .60 Caliber
Capable of Firing a Projectile With a Muzzle Energy of 12,000 Foot Pounds or Greater
Detachable Stock
Flare Launcher
Flash Suppressor
Folding Stock
Forward Pistol Grip
Grenade Launcher
Handguard
Magazine Capacity Over 10 Rounds
Magazine Capacity Over 15 Rounds
Magazine Capacity Over 16 Rounds
Magazine Capacity Over 30 Rounds
Magazine Capacity Over 35 Rounds
Magazine Capacity Over 5 Rounds
Magazine Capacity Over 8 Rounds
Multiburst Trigger Activator
Muzzle Brake
Muzzle Compensator
No Stock
Overall Length Less than 26 Inches
Overall Length Less than 29 Inches
Overall Length Less than 30 Inches
Pistol Grip
Pistol Grip Separate from Stock
Rifle Without a Fixed Stock Capable of Being Fired from theShoulder
Rocket Launcher
Selective-fire Capable of full auto semiauto or burst fire
Semiautomatic Version of an Automatic Rifle
Sighting Device Making a Target Visible at Night
Stockless Pistol Grip Only
Telescoping Stock
Threaded Barrel
Thumbhole Stock
Trigger Crank
    • Related Articles

    • Orchid eState - Technical Support

      API Documentation App Overview
    • eBound Book API Documentation

      API Post Requirements Must be a POST JSON format In the Request Header Pass the authentication token X-Api-Auth-Token: Individually Generated by Bound Book. NOTE: API tokens are generated by Orchid Advisors and will be done so per client request. Set ...
    • Orchid eBound - Technical Support

      API Documentation Creating and Managing eBound Books Creating Data Back ups Generating Reports Managing Master Data Managing Users Performing Special Transactions Performing Transactions in eBound Books Searching your A&D Book Software Updates The ...