Endpoints

V2_Land

The Land Controller will return information regarding Land specific data.

APIDescription
GET api/v2/land/{fmid_land_id}

Provides land details for a FMID_Land_Id.

POST api/v2/land/list

Provides details by a list of FMID_Land_Ids. Passing in a JSON Array with an identifier of 'id' for each FMID_Land_Ids in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

V1_Usage

APIDescription
GET api/v1/usage

Provides a count of all Events, Growers, FMID_Bin_Ids, FMID_Land_Ids, and Geospatial Land Ids counts since inception.

GET api/v1/usage/startdate/{startdate}

Provides a daily count of all Events, Growers, FMID_Bin_Ids, FMID_Land_Ids, and Geospatial Land Ids counts since date entered.

GET api/v1/usage/startdate/{startdate}/enddate/{enddate}

Provides a count of all Events, Growers, FMID_Bin_Ids, FMID_Land_Ids, and Geospatial Land Ids counts from StartDate to EndDate.

GET api/v1/usage/permissions

Provides a detailed list of permission codes and descriptions associated with the Company API-Key.

V1_Log

The Log Controller will return information regarding API requests. Calls made to Log based endpoints incur no additional cost.

APIDescription
GET api/v1/log

Provides a detailed list of API calls made by a given API Key. The list will contain the most recent 1,000 calls, ordered by most recent to oldest.

GET api/v1/log/summary

Provides a summary of the amount of API Calls per day for a given API Key.

V1_Land

The Land Controller will return information regarding Land specific data.

APIDescription
GET api/v1/land/{fmid_land_id}

Provides land details for a FMID_Land_Id.

POST api/v1/land/list

Provides details by a list of FMID_Land_Ids. Passing in a JSON Array with an identifier of 'id' for each FMID_Land_Ids in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

GET api/v1/land/lat/{lat}/lon/{lon}/radius/{radius_in_meters}

Provides details for land by a specified radius and the latitude and longitude passed in. Minimum radius is 1 meter and maximum radius is 10000 meters. Latitude minimum: -90 and maximum: 90 in decimal degrees. Longitude minimum: -180 and maximum: 180 in decimal degrees.

GET api/v1/land/{fmid_land_id}/crop-year/{year}

Provides Land Crop details for a provided FMID_Land_Id and year. Possible Input Values: FMID_Land_Id and a specific four-digit year, ‘ALL’, or ‘all’.

GET api/v1/land/{fmid_land_id}/crop/{season_type}

Provides Land Crop details for a provided FMID_Land_Id and for a specific season. Possible Input Values: FMID_Land_Id and a specific type: [inseason | predictive | currentyear | lastyear].

GET api/v1/land/{fmid_land_id}/grower

Provides a list of growers for a FMID_Land_Id.

V1_Grower

The Grower Controller will return information regarding Grower specific data.

APIDescription
GET api/v1/grower/{grower_id}

Provides grower details for a specific Grower_ID.

GET api/v1/grower/search/name/{name}/zip-cd/{zip_cd}

Provides list of growers based upon specific search criteria.

GET api/v1/grower/search/name/{name}/fips-cd/{fips_cd}

Provides list of growers based upon specific search criteria.

POST api/v1/grower/match

Provides grower details based upon specific MATCH criteria. A consumer should pass in as much information as possible to receive the best match, This endpoint attempts to find the best MATCH based upon matching criteria supplied. Minimal Matching Criteria should consists of following fields: 1. company or(firstname and lastname) 2. address1(both numeric and street components) 3. zipcode Adding a Phone Number and or Email will improve match quality and frequency. Passing in a JSON Object in the Body of the request and with a Content-Type of application/json. Sample request payload: [{"company": ""}, {"firstname": ""}, {"middleinitial": ""}, {"lastname": ""}, {"suffix": ""}, {"address1": ""}, {"city": ""}, {"state": ""}, {"zipcode": ""}, {"phone": 1023456789}, {"email": ""}]

GET api/v1/grower/{grower_id}/enterprise-type/{search_type}/search-code/{search_code}

Provides grower enterprise data based upon an Individual Grower_Id. Must specify the search type { A - for address, I - for individual} Retrieves a particular season type in the search-code placeholder; Possible Values: [inseason | predictive | currentyear | lastyear]; 'ALL', 'all', or the current year etc., '2019'.

GET api/v1/grower/{grower_id}/land

Provides FMID_Land_Ids for a specified Grower_ID.

GET api/v1/grower/{grower_id}/related

Provides related grower detail for a specified Grower_ID.

GET api/v1/grower/{grower_id}/grainbin

Provides all FMID_Bin_Ids for a specific Grower_ID.

POST api/v1/grower/grainbin/all

Provides all FMID_Bin_Ids for a list of Grower_IDs. Passing in a JSON Array with an identifier of 'id' for each grower_id in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

GET api/v1/grower/address/{address_id}

Provides address details for a specified ADDR_ID.

GET api/v1/grower/lat/{lat}/lon/{lon}/radius/{radius_in_meters}

Provides grower details within a given radius based on the latitude and longitude values.

GET api/v1/grower/{grower_id}/consumer

Provides grower consumer data based upon an Individual Grower_Id. Use V1_Dictionary Endpoint to lookup demographic code and value descriptions. Endpoint: GET api/v1/dictionary/demo-cd/{demo_cd} and GET api/v1/dictionary/demo-cd/{demo_cd}/value/{value_cd}

GET api/v1/grower/{grower_id}/persona

Provides grower predicted persona details based upon an Individual Grower_Id for the current and previous year.

V1_Grainbin

The Grainbin Controller will return information regarding specific bin data.

APIDescription
GET api/v1/grainbin/{fmid_bin_id}

Provides grain bin details for a specified FMID_Bin_Id.

POST api/v1/grainbin/all

Provides grain bin details for a list of FMID_Bin_Ids. Passing in a JSON Array with an identifier of 'id' for each fmid_bin_id in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

GET api/v1/grainbin/land/{fmid_land_id}

Provides grain bin details for a specified FMID_Land_Id.

GET api/v1/grainbin/{fmid_bin_id}/pos/{radius_in_miles}

Provides POS location details based on a specified radius of the bin location.

GET api/v1/grainbin/lat/{lat}/lon/{lon}/radius/{radius_in_meters}

Provides grain bin details within a given radius based on the latitude and longitude values.

V1_Geospatial

The Geospatial Controller is responsible for returning GEOJson data for specific data points within FMiD. Note: Requests for latitude and longitude data will be handled within the individual controllers.

APIDescription
GET api/v1/geospatial/grower/{grower_id}

Provides Land Geometry for a Grower_Id. The message will be returned as an array of GeoJSON objects, including attributes: fmid_land_id, grower_id, zip_cd, primary, producer_cd, acres, crops, county, lat, lon.

POST api/v1/geospatial/grower/list

Provides Land Geometry for a list of Grower_Ids. The message will be returned as an array of GeoJSON objects, including attributes: fmid_land_id, grower_id, zip_cd, primary, producer_cd, acres, crops, county, lat, lon. Passing in a JSON Array with an identifier of 'id' for each Grower_ID in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

GET api/v1/geospatial/land/{fmid_land_id}

Provides Land Geometry for a FMID_Land_Id. The message will be returned as an array of GeoJSON objects, including attributes: fmid_land_id, lat, lon, acres, fips_cd, zip_cd, mtrs, name_status, crop_status.

POST api/v1/geospatial/land/list

Provides Land Geometry for a list of FMID_Land_Ids. The message will be returned as an array of GeoJSON objects, including attributes: fmid_land_id, lat, lon, acres, fips_cd, zip_cd, mtrs, name_status, crop_status. Passing in a JSON Array with an identifier of 'id' for each Grower_ID in the Body of the request and with a Content-Type of application/json. Sample request payload - [{"id": 1}, {"id": 2}, {"id": 3}]

V1_Dictionary

The Dictionary Controller will convert common identifiers used within the API into plain-text definitions. Responses will typically be displayed as strings for a given identifier.

APIDescription
GET api/v1/dictionary/enterprise/{enterprise_code}

Provides the definition of a provided enterprise code or all the current enterprise codes. Possible Values: enterprise code, ‘ALL’, or ‘all’.

GET api/v1/dictionary/enterprise-group/{group_code}

Provides the definition of all enterprise codes in the provided enterprise group code. Possible Values: Enterprise Group Code.

GET api/v1/dictionary/link/{link_code}

Provides the link types description that describes the linkage between records. Possible Values: link code, 'ALL', or 'all'.

GET api/v1/dictionary/seasontype/{season_type}

Provides the year of the current season type or years of all season types. Possible Values: [inseason | predictive | currentyear | lastyear], 'ALL', or 'all'.

GET api/v1/dictionary/producer-type/{producer_type}/producer/{producer_code}

Provides the producer description based on the producer type or 'ALL' applicable code for the specified producer type. Possible Values for producer code: producer code, ‘ALL’, or ‘all’.

GET api/v1/dictionary/fips/{fips_cd}

Provides state and the county name based on the Federal Information Processing Standard Code which uniquely identify geographic areas. FIPS Code is a Five digit code with first 2 placeholders representing the State and last 3 digit placeholders representing the county.

GET api/v1/dictionary/gender/{gender_code}

Provides the Gender details for the Individual or Company Name . Possible Values: gender code, ‘ALL’, or ‘all’.

GET api/v1/dictionary/geolevel/{geo_code}

Provides the type of geocode applied to a record. Possible Values: geo code, ‘ALL’, or ‘all’.

GET api/v1/dictionary/grainbin/facility-type/{facility_type}

Provides the definition of a provided bin point of service facility type Possible Values: facility type code, ‘ALL’, or ‘all’.

GET api/v1/dictionary/demo-cd/{demo_cd}

Provides the unqiue demographic code and description based upon a valid demographic value. Possible Values: demographic code. These demographic codes are associated with Endpoint: GET 'api/v1/grower/{grower_id}/consumer' Can be used in conjunction with the returned demographic codes; Consumer Demographic Code Lookup.

GET api/v1/dictionary/demo-cd/{demo_cd}/value/{value_cd}

Provides the collection of unqiue demographic values based upon a valid demographic value. Possible Values: Demo_Code, 'ALL', or 'all'.