GET api/v2/Group/GetGroupsByFarm?FarmId={FarmId}

Request Information

URI Parameters

Name	Description	Type	Additional information
FarmId		integer	Required

Body Parameters

None.

Response Information

Resource Description

Collection of GroupsContract

Name	Type	Additional information
GroupId	integer	None.
GroupTemplateId	integer	None.
FarmId	integer	None.
Description	string	None.
Status	integer	None.
CreationDate	date	None.
StartDate	date	None.
EndDate	date	None.
Remarks	string	None.
Heads	integer	None.
GroupBehavior	integer	None.
FarmName	string	None.
GroupTemplateDescription	string	None.
StatusName	string	None.
GroupBehaviorName	string	None.
CurrentGroupSequenceIndex	integer	None.
IntegratorId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "GroupId": 1,
    "GroupTemplateId": 2,
    "FarmId": 3,
    "Description": "sample string 4",
    "Status": 5,
    "CreationDate": "2026-09-22 12:11:37",
    "StartDate": "2026-09-22 12:11:37",
    "EndDate": "2026-09-22 12:11:37",
    "Remarks": "sample string 6",
    "Heads": 7,
    "GroupBehavior": 8,
    "FarmName": "sample string 9",
    "GroupTemplateDescription": "sample string 10",
    "StatusName": "sample string 11",
    "GroupBehaviorName": "sample string 12",
    "CurrentGroupSequenceIndex": 13,
    "IntegratorId": 14
  },
  {
    "GroupId": 1,
    "GroupTemplateId": 2,
    "FarmId": 3,
    "Description": "sample string 4",
    "Status": 5,
    "CreationDate": "2026-09-22 12:11:37",
    "StartDate": "2026-09-22 12:11:37",
    "EndDate": "2026-09-22 12:11:37",
    "Remarks": "sample string 6",
    "Heads": 7,
    "GroupBehavior": 8,
    "FarmName": "sample string 9",
    "GroupTemplateDescription": "sample string 10",
    "StatusName": "sample string 11",
    "GroupBehaviorName": "sample string 12",
    "CurrentGroupSequenceIndex": 13,
    "IntegratorId": 14
  }
]

application/xml, text/xml

Sample:

<ArrayOfGroupsContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.agrifoodatsolutions.com/FPService/v2/contracts/2017/01">
  <GroupsContract>
    <CreationDate>2026-09-22T12:11:37.2859454+00:00</CreationDate>
    <CurrentGroupSequenceIndex>13</CurrentGroupSequenceIndex>
    <Description>sample string 4</Description>
    <EndDate>2026-09-22T12:11:37.2859454+00:00</EndDate>
    <FarmId>3</FarmId>
    <FarmName>sample string 9</FarmName>
    <GroupBehavior>8</GroupBehavior>
    <GroupBehaviorName>sample string 12</GroupBehaviorName>
    <GroupId>1</GroupId>
    <GroupTemplateDescription>sample string 10</GroupTemplateDescription>
    <GroupTemplateId>2</GroupTemplateId>
    <Heads>7</Heads>
    <IntegratorId>14</IntegratorId>
    <Remarks>sample string 6</Remarks>
    <StartDate>2026-09-22T12:11:37.2859454+00:00</StartDate>
    <Status>5</Status>
    <StatusName>sample string 11</StatusName>
  </GroupsContract>
  <GroupsContract>
    <CreationDate>2026-09-22T12:11:37.2859454+00:00</CreationDate>
    <CurrentGroupSequenceIndex>13</CurrentGroupSequenceIndex>
    <Description>sample string 4</Description>
    <EndDate>2026-09-22T12:11:37.2859454+00:00</EndDate>
    <FarmId>3</FarmId>
    <FarmName>sample string 9</FarmName>
    <GroupBehavior>8</GroupBehavior>
    <GroupBehaviorName>sample string 12</GroupBehaviorName>
    <GroupId>1</GroupId>
    <GroupTemplateDescription>sample string 10</GroupTemplateDescription>
    <GroupTemplateId>2</GroupTemplateId>
    <Heads>7</Heads>
    <IntegratorId>14</IntegratorId>
    <Remarks>sample string 6</Remarks>
    <StartDate>2026-09-22T12:11:37.2859454+00:00</StartDate>
    <Status>5</Status>
    <StatusName>sample string 11</StatusName>
  </GroupsContract>
</ArrayOfGroupsContract>