GET v2/ranches/{ranchGuid}/plantings.{ext}?active={active}&commodityTypeId={commodityTypeId}

Returns a list of plantings from a specific ranch. The list can be filtered to only return active plantings or plantings associated with a specific commodity type.

Request Information

URI Parameters

Name	Description	Type	Additional information
ranchGuid	Ranch Guid	globally unique identifier	Required
active	if active is not specified, or is set to true, return active plantings only. Otherwise, return all plantings	boolean	Default value is True
commodityTypeId	(optional) commodity type Id	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PlantingsViewModel

Name	Type	Additional information
Id	integer	None.
Name	string	None.
ActiveEvents	string	None.
CommodityTypeId	integer	None.
CommodityTypeName	string	None.
HarvestDate	date	None.
WetDate	date	None.
HasSoilMoistureFileName	boolean	None.
HasFlowMeterFileName	boolean	None.
RanchLot	RanchLotBasic	None.
IsNDependent	boolean	None.

Response Formats

application/json, text/json, text/html

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "ActiveEvents": "sample string 3",
    "CommodityTypeId": 4,
    "CommodityTypeName": "sample string 5",
    "HarvestDate": "2024-09-12T22:03:52.0304889-07:00",
    "WetDate": "2024-09-12T22:03:52.0304889-07:00",
    "HasSoilMoistureFileName": true,
    "HasFlowMeterFileName": true,
    "RanchLot": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "IsNDependent": true
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "ActiveEvents": "sample string 3",
    "CommodityTypeId": 4,
    "CommodityTypeName": "sample string 5",
    "HarvestDate": "2024-09-12T22:03:52.0304889-07:00",
    "WetDate": "2024-09-12T22:03:52.0304889-07:00",
    "HasSoilMoistureFileName": true,
    "HasFlowMeterFileName": true,
    "RanchLot": {
      "Id": 1,
      "Name": "sample string 2"
    },
    "IsNDependent": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlantingsViewModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PlantingsViewModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ActiveEvents>sample string 3</ActiveEvents>
    <CommodityTypeId>4</CommodityTypeId>
    <CommodityTypeName>sample string 5</CommodityTypeName>
    <HarvestDate>2024-09-12T22:03:52.0304889-07:00</HarvestDate>
    <WetDate>2024-09-12T22:03:52.0304889-07:00</WetDate>
    <HasSoilMoistureFileName>true</HasSoilMoistureFileName>
    <HasFlowMeterFileName>true</HasFlowMeterFileName>
    <RanchLot>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </RanchLot>
    <IsNDependent>true</IsNDependent>
  </PlantingsViewModel>
  <PlantingsViewModel>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ActiveEvents>sample string 3</ActiveEvents>
    <CommodityTypeId>4</CommodityTypeId>
    <CommodityTypeName>sample string 5</CommodityTypeName>
    <HarvestDate>2024-09-12T22:03:52.0304889-07:00</HarvestDate>
    <WetDate>2024-09-12T22:03:52.0304889-07:00</WetDate>
    <HasSoilMoistureFileName>true</HasSoilMoistureFileName>
    <HasFlowMeterFileName>true</HasFlowMeterFileName>
    <RanchLot>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </RanchLot>
    <IsNDependent>true</IsNDependent>
  </PlantingsViewModel>
</ArrayOfPlantingsViewModel>