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

Provides related grower detail for a specified Grower_ID.

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

Body Parameters

None.

Response Information

Resource Description

Links of the related growers

Collection of V1_GrowerRelated
NameDescriptionTypeAdditional information
Grower_ID

Grower_ID is the grower_id you entered

integer

Required

Link

Link describes how the Grower_ID relates to the Related Grower_ID; the following relationships exist: B - Business, E - Email, H - Household, L - Land, P - Phone, S - Subsidy Payment

string

None.

Related_Grower_ID

Related Grower ID

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Grower_ID": 1,
    "Link": "sample string 2",
    "Related_Grower_ID": 3
  },
  {
    "Grower_ID": 1,
    "Link": "sample string 2",
    "Related_Grower_ID": 3
  }
]

text/html

Sample:
[{"Grower_ID":1,"Link":"sample string 2","Related_Grower_ID":3},{"Grower_ID":1,"Link":"sample string 2","Related_Grower_ID":3}]

application/xml, text/xml

Sample:
<ArrayOfV1_GrowerRelated xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FF_API.Models.Grower.V1">
  <V1_GrowerRelated>
    <Grower_ID>1</Grower_ID>
    <Link>sample string 2</Link>
    <Related_Grower_ID>3</Related_Grower_ID>
  </V1_GrowerRelated>
  <V1_GrowerRelated>
    <Grower_ID>1</Grower_ID>
    <Link>sample string 2</Link>
    <Related_Grower_ID>3</Related_Grower_ID>
  </V1_GrowerRelated>
</ArrayOfV1_GrowerRelated>