GET Farm/GetFarmData?locationIdOrGuid={locationIdOrGuid}&growerIdorGuid={growerIdorGuid}&activeGrowerFilter={activeGrowerFilter}&farmIdorGuid={farmIdorGuid}&farmKey={farmKey}&lastModifiedOnOrAfterUtc={lastModifiedOnOrAfterUtc}&lastModifiedOnOrBeforeUtc={lastModifiedOnOrBeforeUtc}

Returns a list of farms.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
locationIdOrGuid

Location ID or GUID (optional)

string

Default value is string.Empty

growerIdorGuid

Grower ID or Grower GUID of the customer on the farm (optional)

string

Default value is string.Empty

activeGrowerFilter

Active Growers - Active, Inactive or All (optional)

string

Default value is Active

farmIdorGuid

Farm ID or GUID (optional)

string

Default value is string.Empty

farmKey

Farm Key (optional)

integer

Default value is 0

lastModifiedOnOrAfterUtc

Filter the list of Farms to those changed on or after the supplied UTC date and time. Format = yyyy-MM-ddTHH:mm:ss (optional)

string

Default value is string.Empty

lastModifiedOnOrBeforeUtc

Filter the list of Farms to those changed on or before the supplied UTC date and time. Format = yyyy-MM-ddTHH:mm:ss (optional)

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns a list of farms.

AgvFarm
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many clsFARM JSON dictionaries.

string
Farms

JSON dictionary of clsFARM.

Collection of ClsFARM

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "Farms": [
    {
      "FarmKey": 5,
      "FarmGUID": "sample string 6",
      "GrowerID": "sample string 8",
      "GrowerFirstName": "sample string 11",
      "GrowerLastName": "sample string 12",
      "FarmID": "sample string 14",
      "Description": "sample string 15",
      "FarmNotes": "sample string 22",
      "SplitName2": "sample string 23",
      "SplitName3": "sample string 24",
      "LastModifiedUTC": "2022-12-08T03:39:22.0175634+00:00",
      "FarmSplits": [
        {
          "GrowerID": "sample string 3",
          "GrowerPercent1": 6.1,
          "GrowerPercent2": 7.1,
          "GrowerPercent3": 8.1,
          "SplitFirstName": "sample string 9",
          "SplitLastName": "sample string 10"
        },
        {
          "GrowerID": "sample string 3",
          "GrowerPercent1": 6.1,
          "GrowerPercent2": 7.1,
          "GrowerPercent3": 8.1,
          "SplitFirstName": "sample string 9",
          "SplitLastName": "sample string 10"
        }
      ],
      "FarmClassifications": [
        {
          "ClassName": "sample string 4"
        },
        {
          "ClassName": "sample string 4"
        }
      ],
      "FarmAttributes": [
        {
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        },
        {
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        }
      ]
    },
    {
      "FarmKey": 5,
      "FarmGUID": "sample string 6",
      "GrowerID": "sample string 8",
      "GrowerFirstName": "sample string 11",
      "GrowerLastName": "sample string 12",
      "FarmID": "sample string 14",
      "Description": "sample string 15",
      "FarmNotes": "sample string 22",
      "SplitName2": "sample string 23",
      "SplitName3": "sample string 24",
      "LastModifiedUTC": "2022-12-08T03:39:22.0175634+00:00",
      "FarmSplits": [
        {
          "GrowerID": "sample string 3",
          "GrowerPercent1": 6.1,
          "GrowerPercent2": 7.1,
          "GrowerPercent3": 8.1,
          "SplitFirstName": "sample string 9",
          "SplitLastName": "sample string 10"
        },
        {
          "GrowerID": "sample string 3",
          "GrowerPercent1": 6.1,
          "GrowerPercent2": 7.1,
          "GrowerPercent3": 8.1,
          "SplitFirstName": "sample string 9",
          "SplitLastName": "sample string 10"
        }
      ],
      "FarmClassifications": [
        {
          "ClassName": "sample string 4"
        },
        {
          "ClassName": "sample string 4"
        }
      ],
      "FarmAttributes": [
        {
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        },
        {
          "CrossRef": "sample string 4",
          "AttributeValue": "sample string 5"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<AgvFarm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Farm">
  <Farms xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Agv">
    <d2p1:ClsFARM>
      <d2p1:Description>sample string 15</d2p1:Description>
      <d2p1:FarmAttributes>
        <d2p1:FarmAttribute>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
        </d2p1:FarmAttribute>
        <d2p1:FarmAttribute>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
        </d2p1:FarmAttribute>
      </d2p1:FarmAttributes>
      <d2p1:FarmClassifications>
        <d2p1:FarmClassification>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
        </d2p1:FarmClassification>
        <d2p1:FarmClassification>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
        </d2p1:FarmClassification>
      </d2p1:FarmClassifications>
      <d2p1:FarmGUID>sample string 6</d2p1:FarmGUID>
      <d2p1:FarmID>sample string 14</d2p1:FarmID>
      <d2p1:FarmKey>5</d2p1:FarmKey>
      <d2p1:FarmNotes>sample string 22</d2p1:FarmNotes>
      <d2p1:FarmSplits>
        <d2p1:ClsFARM.ClsFarmSplit>
          <d2p1:GrowerID>sample string 3</d2p1:GrowerID>
          <d2p1:GrowerPercent1>6.1</d2p1:GrowerPercent1>
          <d2p1:GrowerPercent2>7.1</d2p1:GrowerPercent2>
          <d2p1:GrowerPercent3>8.1</d2p1:GrowerPercent3>
          <d2p1:SplitFirstName>sample string 9</d2p1:SplitFirstName>
          <d2p1:SplitLastName>sample string 10</d2p1:SplitLastName>
        </d2p1:ClsFARM.ClsFarmSplit>
        <d2p1:ClsFARM.ClsFarmSplit>
          <d2p1:GrowerID>sample string 3</d2p1:GrowerID>
          <d2p1:GrowerPercent1>6.1</d2p1:GrowerPercent1>
          <d2p1:GrowerPercent2>7.1</d2p1:GrowerPercent2>
          <d2p1:GrowerPercent3>8.1</d2p1:GrowerPercent3>
          <d2p1:SplitFirstName>sample string 9</d2p1:SplitFirstName>
          <d2p1:SplitLastName>sample string 10</d2p1:SplitLastName>
        </d2p1:ClsFARM.ClsFarmSplit>
      </d2p1:FarmSplits>
      <d2p1:GrowerFirstName>sample string 11</d2p1:GrowerFirstName>
      <d2p1:GrowerID>sample string 8</d2p1:GrowerID>
      <d2p1:GrowerLastName>sample string 12</d2p1:GrowerLastName>
      <d2p1:LastModifiedUTC>2022-12-08T03:39:22.0175634+00:00</d2p1:LastModifiedUTC>
      <d2p1:SplitName2>sample string 23</d2p1:SplitName2>
      <d2p1:SplitName3>sample string 24</d2p1:SplitName3>
    </d2p1:ClsFARM>
    <d2p1:ClsFARM>
      <d2p1:Description>sample string 15</d2p1:Description>
      <d2p1:FarmAttributes>
        <d2p1:FarmAttribute>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
        </d2p1:FarmAttribute>
        <d2p1:FarmAttribute>
          <d2p1:AttributeValue>sample string 5</d2p1:AttributeValue>
          <d2p1:CrossRef>sample string 4</d2p1:CrossRef>
        </d2p1:FarmAttribute>
      </d2p1:FarmAttributes>
      <d2p1:FarmClassifications>
        <d2p1:FarmClassification>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
        </d2p1:FarmClassification>
        <d2p1:FarmClassification>
          <d2p1:ClassName>sample string 4</d2p1:ClassName>
        </d2p1:FarmClassification>
      </d2p1:FarmClassifications>
      <d2p1:FarmGUID>sample string 6</d2p1:FarmGUID>
      <d2p1:FarmID>sample string 14</d2p1:FarmID>
      <d2p1:FarmKey>5</d2p1:FarmKey>
      <d2p1:FarmNotes>sample string 22</d2p1:FarmNotes>
      <d2p1:FarmSplits>
        <d2p1:ClsFARM.ClsFarmSplit>
          <d2p1:GrowerID>sample string 3</d2p1:GrowerID>
          <d2p1:GrowerPercent1>6.1</d2p1:GrowerPercent1>
          <d2p1:GrowerPercent2>7.1</d2p1:GrowerPercent2>
          <d2p1:GrowerPercent3>8.1</d2p1:GrowerPercent3>
          <d2p1:SplitFirstName>sample string 9</d2p1:SplitFirstName>
          <d2p1:SplitLastName>sample string 10</d2p1:SplitLastName>
        </d2p1:ClsFARM.ClsFarmSplit>
        <d2p1:ClsFARM.ClsFarmSplit>
          <d2p1:GrowerID>sample string 3</d2p1:GrowerID>
          <d2p1:GrowerPercent1>6.1</d2p1:GrowerPercent1>
          <d2p1:GrowerPercent2>7.1</d2p1:GrowerPercent2>
          <d2p1:GrowerPercent3>8.1</d2p1:GrowerPercent3>
          <d2p1:SplitFirstName>sample string 9</d2p1:SplitFirstName>
          <d2p1:SplitLastName>sample string 10</d2p1:SplitLastName>
        </d2p1:ClsFARM.ClsFarmSplit>
      </d2p1:FarmSplits>
      <d2p1:GrowerFirstName>sample string 11</d2p1:GrowerFirstName>
      <d2p1:GrowerID>sample string 8</d2p1:GrowerID>
      <d2p1:GrowerLastName>sample string 12</d2p1:GrowerLastName>
      <d2p1:LastModifiedUTC>2022-12-08T03:39:22.0175634+00:00</d2p1:LastModifiedUTC>
      <d2p1:SplitName2>sample string 23</d2p1:SplitName2>
      <d2p1:SplitName3>sample string 24</d2p1:SplitName3>
    </d2p1:ClsFARM>
  </Farms>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvFarm>