POST v2/irrigation-recommendation.{ext}

Single call Web API endpoint for irrigation recommendations. This Web API call can be used to request irrigation recommendations from CropManage, without having to first set up ranches or plantings.

Request Information

URI Parameters

None.

Body Parameters

SingleCallIrrigationRecommendationModel
NameDescriptionTypeAdditional information
EventDate

Target event date

date

None.

DistributionUniformity

Distribution uniformity. We recommend that you specify this value. It will fallback to a default value for drip irrigation (85) if not specified. The value for this field should be between 0 and 100.

decimal number

None.

CropTypeId

Crop type ID. WARNING: ID between production and development environments can be different.

integer

None.

WetDate

Planting wet date

date

None.

HarvestDate

Planting harvest date

date

None.

WeatherStationId

Weather station ID. For now, only one weather station is allowed. WARNING: ID between production and development environments can be different.

integer

None.

IrrigationEvents

A list of past irrigation events. Future irrigation events will not impact recommendations. Past irrigation events will be used to calculate recommendations. The applied amounts specified in the past irrigation events will be used to calculate soil evaporation

Collection of SingleCallIrrigationEventModel

None.

SoilProperties

Soil data, used to calculate soil evaporation.

SingleCallSoilTypeModel

None.

CutEvents

a List of dates for cut events (optional), which is used for alfalfa

Collection of date

None.

LeechingRequirement

Leeching requirement. It will fallback to a default value (0) if not specified. The value should be between 0 and 100.

decimal number

None.

AgeOfCrop

Age of crop for perennial crop types (optional), like almonds and alfafa, specified in years, ranging between 0 and 14.

integer

None.

CropSensitivity

Defaults to 1, or 100%. The value can be reduced to lower irrigation recommendation. The value should be between 0 and 1.

decimal number

None.

MacroTunnelStart

Macro tunnel start date (optional) If a macro tunnel feature is available for a crop, this date will be used to specify the date when macro tunnel is applied. On dates when macro tunnel is active, rainfall is ignored, and ET is reduced.

date

None.

MacroTunnelEnd

Macro tunnel end date (optional) If a macro tunnel feature is available for a crop, this date will be used to specify the date when macro tunnel is removed.

date

None.

Stress

Stress properties (optional), used by tree crops and processing tomato

SingleCallStress

None.

Latitude

Only used for the seasonal ET calculator. When set, soil data is automatically detected

decimal number

None.

Longitude

Only used for the seasonal ET calculator.

decimal number

None.

Request Formats

application/json, text/json, text/html

Sample:
{
  "EventDate": "2024-06-24T16:59:03.3777391-07:00",
  "DistributionUniformity": 1.0,
  "CropTypeId": 2,
  "WetDate": "2024-06-24T16:59:03.3777391-07:00",
  "HarvestDate": "2024-06-24T16:59:03.3777391-07:00",
  "WeatherStationId": 5,
  "IrrigationEvents": [
    {
      "EventDate": "2024-06-24T16:59:03.3777391-07:00",
      "MethodId": 2,
      "Applied": 3.0
    },
    {
      "EventDate": "2024-06-24T16:59:03.3777391-07:00",
      "MethodId": 2,
      "Applied": 3.0
    }
  ],
  "SoilProperties": {
    "Sand": 1.0,
    "Silt": 2.0
  },
  "CutEvents": [
    "2024-06-24T16:59:03.3777391-07:00",
    "2024-06-24T16:59:03.3777391-07:00"
  ],
  "LeechingRequirement": 1.0,
  "AgeOfCrop": 1,
  "CropSensitivity": 1.0,
  "MacroTunnelStart": "2024-06-24T16:59:03.3777391-07:00",
  "MacroTunnelEnd": "2024-06-24T16:59:03.3777391-07:00",
  "Stress": {
    "StartLevel": 1,
    "EndLevel": 2,
    "StartDate": "2024-06-24T16:59:03.3777391-07:00",
    "EndDate": "2024-06-24T16:59:03.3777391-07:00"
  },
  "Latitude": 1.0,
  "Longitude": 1.0
}

application/xml, text/xml

Sample:
<SingleCallIrrigationRecommendationModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CropTypeId>2</CropTypeId>
  <WetDate>2024-06-24T16:59:03.3777391-07:00</WetDate>
  <HarvestDate>2024-06-24T16:59:03.3777391-07:00</HarvestDate>
  <WeatherStationId>5</WeatherStationId>
  <IrrigationEvents>
    <SingleCallIrrigationEventModel>
      <EventDate>2024-06-24T16:59:03.3777391-07:00</EventDate>
      <MethodId>2</MethodId>
      <Applied>3</Applied>
    </SingleCallIrrigationEventModel>
    <SingleCallIrrigationEventModel>
      <EventDate>2024-06-24T16:59:03.3777391-07:00</EventDate>
      <MethodId>2</MethodId>
      <Applied>3</Applied>
    </SingleCallIrrigationEventModel>
  </IrrigationEvents>
  <SoilProperties>
    <Sand>1</Sand>
    <Silt>2</Silt>
  </SoilProperties>
  <CutEvents>
    <dateTime>2024-06-24T16:59:03.3777391-07:00</dateTime>
    <dateTime>2024-06-24T16:59:03.3777391-07:00</dateTime>
  </CutEvents>
  <LeechingRequirement>1</LeechingRequirement>
  <AgeOfCrop>1</AgeOfCrop>
  <CropSensitivity>1</CropSensitivity>
  <MacroTunnelStart>2024-06-24T16:59:03.3777391-07:00</MacroTunnelStart>
  <MacroTunnelEnd>2024-06-24T16:59:03.3777391-07:00</MacroTunnelEnd>
  <Stress>
    <StartLevel>1</StartLevel>
    <EndLevel>2</EndLevel>
    <StartDate>2024-06-24T16:59:03.3777391-07:00</StartDate>
    <EndDate>2024-06-24T16:59:03.3777391-07:00</EndDate>
  </Stress>
  <Latitude>1</Latitude>
  <Longitude>1</Longitude>
  <EventDate>2024-06-24T16:59:03.3777391-07:00</EventDate>
  <DistributionUniformity>1</DistributionUniformity>
</SingleCallIrrigationRecommendationModel>

Response Information

Resource Description

IrrigationRecommendationSimpleModel
NameDescriptionTypeAdditional information
EventDate

date

None.

RecommendedIrrigationAmount

decimal number

None.

AvailableWater

decimal number

None.

AverageCropET

decimal number

None.

AverageRainfall

decimal number

None.

SumET

decimal number

None.

CropCoefficientSum

decimal number

None.

LeechingFactor

decimal number

None.

Distribution

decimal number

None.

TotalPrecipitation

decimal number

None.

CIMISRainfall

string

None.

DaysSinceLastIrrigation

decimal number

None.

BaseIrrigationAmount

decimal number

None.

AverageCropCoefficient

decimal number

None.

LastIrrigationEventDate

date

None.

CropSensitivity

decimal number

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.