POST Farm/PostFarm

Add an Agvance Farm.

Request Information

URI Parameters

Body Parameters

Farm object to use for the creation of a farm.

ClsFarmAdd
NameDescriptionTypeAdditional Information
GrowerID

ID of the Grower in Agvance

string

Max length: 6

CustomerGUID

GUID of the Grower in Agvance. Can be used in place of GrowerID

string
FarmID

Name of the Farm in Agvance

string

Required

Max length: 8

FarmGUID

The GUID of the Farm in Agvance

globally unique identifier

Hexadecimal 8-4-4-4-12

Description

Farm Description

string

Max length: 50

FarmNotes

Farm Notes

string

Max length: 20000

SplitName2

The S2 Bill Arrangement Override

string

Max length: 10

SplitName3

The S3 Bill Arrangement Override

string

Max length: 10

FarmSplits

A List of Growers and Their Percentages for This Farm's Split Bill Arrangements

Collection of ClsFarmSplitAdd

Maximum of 8 allowed

FarmClassifications

A List of Classifications for This Farm

Collection of ClsFarmClassAdd
FarmAttributes

A List of Farm Attribute CrossRefs and Their Values for This Farm

Collection of ClsFarmCrossRefAdd

Request Formats

application/json, text/json

Sample:
{
  "GrowerID": "sample string 4",
  "CustomerGUID": "sample string 5",
  "FarmID": "sample string 6",
  "FarmGUID": "4a0dfb69-a23a-4c0f-b6ec-6f466f88d7fd",
  "Description": "sample string 7",
  "FarmNotes": "sample string 8",
  "SplitName2": "sample string 9",
  "SplitName3": "sample string 10",
  "FarmSplits": [
    {
      "GrowerID": "sample string 1",
      "CustomerGUID": "sample string 2",
      "GrowerPercent1": 3.1,
      "GrowerPercent2": 4.1,
      "GrowerPercent3": 5.1
    },
    {
      "GrowerID": "sample string 1",
      "CustomerGUID": "sample string 2",
      "GrowerPercent1": 3.1,
      "GrowerPercent2": 4.1,
      "GrowerPercent3": 5.1
    }
  ],
  "FarmClassifications": [
    {
      "ClassName": "sample string 1"
    },
    {
      "ClassName": "sample string 1"
    }
  ],
  "FarmAttributes": [
    {
      "CrossRef": "sample string 1",
      "AttributeValue": "sample string 2"
    },
    {
      "CrossRef": "sample string 1",
      "AttributeValue": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:
<FarmAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Agv">
  <CustomerGUID>sample string 5</CustomerGUID>
  <Description>sample string 7</Description>
  <FarmAttributes>
    <FarmAttributeAdd>
      <AttributeValue>sample string 2</AttributeValue>
      <CrossRef>sample string 1</CrossRef>
    </FarmAttributeAdd>
    <FarmAttributeAdd>
      <AttributeValue>sample string 2</AttributeValue>
      <CrossRef>sample string 1</CrossRef>
    </FarmAttributeAdd>
  </FarmAttributes>
  <FarmClassifications>
    <FarmClassificationAdd>
      <ClassName>sample string 1</ClassName>
    </FarmClassificationAdd>
    <FarmClassificationAdd>
      <ClassName>sample string 1</ClassName>
    </FarmClassificationAdd>
  </FarmClassifications>
  <FarmGUID>4a0dfb69-a23a-4c0f-b6ec-6f466f88d7fd</FarmGUID>
  <FarmID>sample string 6</FarmID>
  <FarmNotes>sample string 8</FarmNotes>
  <FarmSplits>
    <FarmSplitAdd>
      <CustomerGUID>sample string 2</CustomerGUID>
      <GrowerID>sample string 1</GrowerID>
      <GrowerPercent1>3.1</GrowerPercent1>
      <GrowerPercent2>4.1</GrowerPercent2>
      <GrowerPercent3>5.1</GrowerPercent3>
    </FarmSplitAdd>
    <FarmSplitAdd>
      <CustomerGUID>sample string 2</CustomerGUID>
      <GrowerID>sample string 1</GrowerID>
      <GrowerPercent1>3.1</GrowerPercent1>
      <GrowerPercent2>4.1</GrowerPercent2>
      <GrowerPercent3>5.1</GrowerPercent3>
    </FarmSplitAdd>
  </FarmSplits>
  <GrowerID>sample string 4</GrowerID>
  <SplitName2>sample string 9</SplitName2>
  <SplitName3>sample string 10</SplitName3>
</FarmAdd>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsFarmAdd'.

Response Information

Resource Description

Add an Agvance Farm.

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-08T02:29:47.1497794+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-08T02:29:47.1497794+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-08T02:29:47.1497794+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-08T02:29:47.1497794+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>