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'.

Request Information

Headers

In order to receive live data, you must provide the necessary information to authenticate. This will require an API-Key, which is to be provided within the request header for every request. If an API-Key is not provided, sandbox data will be returned.

Name Description Type Additional Information
API-Key 32 Character GUID key String Required to return live information. If not provided, sandbox data will be returned.

URI Parameters

NameDescriptionTypeAdditional information
grower_id

grower_id is the grower id you enter.

integer

Required

search_type

Enterprise Type; Possible Values: [ I - {represent an Individual} | individual | A - {represent an Address} | address ]

string

Required

search_code

The type of search can be any of the following: Season_Type - Possible Values: [inseason | predictive | currentyear | lastyear] Four digit year - Year must include the century or 'ALL', example: [2019 | ALL | all]

string

Required

Body Parameters

None.

Response Information

Resource Description

Grower/Address Enterprise data

Collection of V1_GrowerEnterprise
NameDescriptionTypeAdditional information
Grower_ID

Grower_ID is the grower you entered

integer

Required

Search_Type

Input Search Type

string

None.

Enterprise_Year

The Enterprise Year to filter for

integer

None.

Enterprise_Quantity

The unit quantity of the specific enterprise

decimal number

None.

Enterprise_Code

The unit code for the enterprise

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Grower_ID": 1,
    "Search_Type": "sample string 2",
    "Enterprise_Year": 3,
    "Enterprise_Quantity": 4.0,
    "Enterprise_Code": "sample string 5"
  },
  {
    "Grower_ID": 1,
    "Search_Type": "sample string 2",
    "Enterprise_Year": 3,
    "Enterprise_Quantity": 4.0,
    "Enterprise_Code": "sample string 5"
  }
]

text/html

Sample:
[{"Grower_ID":1,"Search_Type":"sample string 2","Enterprise_Year":3,"Enterprise_Quantity":4.0,"Enterprise_Code":"sample string 5"},{"Grower_ID":1,"Search_Type":"sample string 2","Enterprise_Year":3,"Enterprise_Quantity":4.0,"Enterprise_Code":"sample string 5"}]

application/xml, text/xml

Sample:
<ArrayOfV1_GrowerEnterprise xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Grower.V1">
  <V1_GrowerEnterprise>
    <Enterprise_Code>sample string 5</Enterprise_Code>
    <Enterprise_Quantity>4</Enterprise_Quantity>
    <Enterprise_Year>3</Enterprise_Year>
    <Grower_ID>1</Grower_ID>
    <Search_Type>sample string 2</Search_Type>
  </V1_GrowerEnterprise>
  <V1_GrowerEnterprise>
    <Enterprise_Code>sample string 5</Enterprise_Code>
    <Enterprise_Quantity>4</Enterprise_Quantity>
    <Enterprise_Year>3</Enterprise_Year>
    <Grower_ID>1</Grower_ID>
    <Search_Type>sample string 2</Search_Type>
  </V1_GrowerEnterprise>
</ArrayOfV1_GrowerEnterprise>