POST v3/ranches/{ranchGuid}/plantings.json

Creates a new planting.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ranchGuid

globally unique identifier

Required

Body Parameters

PlantingParamsExternal
NameDescriptionTypeAdditional information
DefaultCropTypeId

Default crop type ID. The ranch must first be associated with this default crop type in Ranch Settings before this ID can be used.

integer

Required

Name

Name of the planting

string

Required

WetDate

Planting wet date. WetDate must be earlier than HarvestDate. Example: "4-1-2022"

date

Required

HarvestDate

Planting harvest date. For perennial crops, this date may be the end of the season. HarvestDate must be later than WetDate. Example: "4-1-2022"

date

Required

LotId

ID of the planting area associated with the planting.

integer

Required

Coordinates

Planting coordinates. Example: "40.531876,-116.157271"

string

Required

Acres

Planting acres. Must be a number between 0 and 5000.

decimal number

Required

Range: inclusive between 0.001 and 10000

IrrigationSettings

Irrigation related configuration settings

PlantingIrrigationParams

Required

AdvancedSettings

(Optional) Advanced settings which specifies optional fields like soil obstruction depth, and PreviousCropDays

PlantingAdvancedSettings

None.

MacroTunnelSettings

(Optional) Macro tunnel settings, if macro tunnels are used.

PlantingMacroTunnelSettings

None.

StressSettings

(Optional) Stress settings for crops that are stressed near the tail end of harvest Only used for tree crops (almonds, walnuts, etc) and processing tomatoes

PlantingStresssSettings

None.

PerennialCropSettings

(Optional) Settings for perennial crops, like almonds, pears, walnuts, and alfalfa. Not used for caneberries.

PlantingPerennialSettings

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "DefaultCropTypeId": 1,
  "Name": "sample string 2",
  "WetDate": "2024-05-21T04:18:11.0222347-07:00",
  "HarvestDate": "2024-05-21T04:18:11.0222347-07:00",
  "LotId": 5,
  "Coordinates": "sample string 6",
  "Acres": 7.0,
  "IrrigationSettings": {
    "IrrigationMethods": [
      1,
      2
    ],
    "ApplicationRates": {
      "Drip": 1.0,
      "Sprinkler": 1.0,
      "MicroSprinkler": 1.0
    },
    "DistributionUniformities": {
      "Drip": 1.0,
      "Sprinkler": 1.0,
      "Flood": 1.0,
      "MicroSprinkler": 1.0,
      "GerminationSprinkler": 1.0
    },
    "LeechingFactor": 1.0
  },
  "AdvancedSettings": {
    "ObstructionDepth": 1.0,
    "PreviousCropDays": 1,
    "PreviousCropTypeId": 1
  },
  "MacroTunnelSettings": {
    "IsEnabled": true,
    "IsFullSeason": true,
    "StartDate": "2024-05-21T04:18:11.0222347-07:00",
    "EndDate": "2024-05-21T04:18:11.0222347-07:00"
  },
  "StressSettings": {
    "IsEnabled": true,
    "StartDate": "2024-05-21T04:18:11.0222347-07:00",
    "EndDate": "2024-05-21T04:18:11.0222347-07:00"
  },
  "PerennialCropSettings": {
    "CropAge": 1,
    "YieldTarget": 1.0,
    "YieldActual": 1.0,
    "IsHighVigor": true,
    "IsCoverCropEnabled": true,
    "LeafSenesceDate": "2024-05-21T04:18:11.0222347-07:00"
  }
}

application/xml, text/xml

Sample:
<PlantingParamsExternal xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 2</Name>
  <WetDate>2024-05-21T04:18:11.0222347-07:00</WetDate>
  <HarvestDate>2024-05-21T04:18:11.0222347-07:00</HarvestDate>
  <LotId>5</LotId>
  <Coordinates>sample string 6</Coordinates>
  <Acres>7</Acres>
  <IrrigationSettings>
    <IrrigationMethods>
      <int>1</int>
      <int>2</int>
    </IrrigationMethods>
    <ApplicationRates>
      <Drip>1</Drip>
      <Sprinkler>1</Sprinkler>
      <MicroSprinkler>1</MicroSprinkler>
    </ApplicationRates>
    <DistributionUniformities>
      <Drip>1</Drip>
      <Sprinkler>1</Sprinkler>
      <Flood>1</Flood>
      <MicroSprinkler>1</MicroSprinkler>
      <GerminationSprinkler>1</GerminationSprinkler>
    </DistributionUniformities>
    <LeechingFactor>1</LeechingFactor>
  </IrrigationSettings>
  <AdvancedSettings>
    <ObstructionDepth>1</ObstructionDepth>
    <PreviousCropDays>1</PreviousCropDays>
    <PreviousCropTypeId>1</PreviousCropTypeId>
  </AdvancedSettings>
  <MacroTunnelSettings>
    <IsEnabled>true</IsEnabled>
    <IsFullSeason>true</IsFullSeason>
    <StartDate>2024-05-21T04:18:11.0222347-07:00</StartDate>
    <EndDate>2024-05-21T04:18:11.0222347-07:00</EndDate>
  </MacroTunnelSettings>
  <StressSettings>
    <IsEnabled>true</IsEnabled>
    <StartDate>2024-05-21T04:18:11.0222347-07:00</StartDate>
    <EndDate>2024-05-21T04:18:11.0222347-07:00</EndDate>
  </StressSettings>
  <PerennialCropSettings>
    <CropAge>1</CropAge>
    <YieldTarget>1</YieldTarget>
    <YieldActual>1</YieldActual>
    <IsHighVigor>true</IsHighVigor>
    <IsCoverCropEnabled>true</IsCoverCropEnabled>
    <LeafSenesceDate>2024-05-21T04:18:11.0222347-07:00</LeafSenesceDate>
  </PerennialCropSettings>
  <DefaultCropTypeId>1</DefaultCropTypeId>
</PlantingParamsExternal>

Response Information

Resource Description

LotPlantingWithEvents
NameDescriptionTypeAdditional information
Events

Object

None.

HasSoilMoistureFileName

boolean

None.

HasFlowMeterFileName

boolean

None.

IsNDependent

boolean

None.

CommodityTypeCalculator

string

None.

CommodityTypeName

string

None.

ActiveEvents

string

None.

Favorite

boolean

None.

FavoriteId

integer

None.

Id

integer

None.

Name

string

None.

RanchLot

RanchLotBasic

None.

HarvestDate

date

None.

WetDate

date

None.

CropType

CropType

None.

CommodityTypeId

integer

None.

MicroSprinklerId

integer

None.

Response Formats

application/json, text/json, text/html

Sample:
{
  "Events": {},
  "HasSoilMoistureFileName": true,
  "HasFlowMeterFileName": true,
  "IsNDependent": true,
  "CommodityTypeCalculator": "sample string 4",
  "CommodityTypeName": "sample string 5",
  "ActiveEvents": "sample string 6",
  "Favorite": true,
  "FavoriteId": 1,
  "Id": 7,
  "Name": "sample string 8",
  "RanchLot": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "HarvestDate": "2024-05-21T04:18:11.0534929-07:00",
  "WetDate": "2024-05-21T04:18:11.0534929-07:00",
  "CropType": {
    "Id": 1,
    "Name": "sample string 2",
    "UptakeFactor": 3.0,
    "UptakeConstant": 4.0,
    "IsNDependent": true,
    "IsSelected": true,
    "PlantingsCount": 7
  },
  "CommodityTypeId": 11,
  "MicroSprinklerId": 1
}

application/xml, text/xml

Sample:
<LotPlantingWithEvents xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>7</Id>
  <Name>sample string 8</Name>
  <RanchLot>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </RanchLot>
  <HarvestDate>2024-05-21T04:18:11.0534929-07:00</HarvestDate>
  <WetDate>2024-05-21T04:18:11.0534929-07:00</WetDate>
  <CropType>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <UptakeFactor>3</UptakeFactor>
    <UptakeConstant>4</UptakeConstant>
    <IsNDependent>true</IsNDependent>
    <IsSelected>true</IsSelected>
    <PlantingsCount>7</PlantingsCount>
  </CropType>
  <CommodityTypeId>11</CommodityTypeId>
  <MicroSprinklerId>1</MicroSprinklerId>
  <Events />
  <HasSoilMoistureFileName>true</HasSoilMoistureFileName>
  <HasFlowMeterFileName>true</HasFlowMeterFileName>
  <IsNDependent>true</IsNDependent>
  <CommodityTypeCalculator>sample string 4</CommodityTypeCalculator>
  <CommodityTypeName>sample string 5</CommodityTypeName>
  <ActiveEvents>sample string 6</ActiveEvents>
  <Favorite>true</Favorite>
  <FavoriteId>1</FavoriteId>
</LotPlantingWithEvents>