Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Type

Required

Notes

“name”

String

yes

This is the name of the polygon in the UI

“type”

Enum

yes

One of “application”, “avoid”, or “ignore”.
”application”: Apply a certain depth of water to this area.
”avoid”: As soon as a sprinkler hits this zone, it’ll shut off - so bordering zones will be off. The priority is for the avoid zone.
”ignore”: This will prioritize the non-ignore area, as the sprinkler transitions into the ignore it will still pulse to ensure the neighbouring zones get the right depth.

“colour”

Hex string

yes

A string containing the hex code of the colour of the feature.

“application_depth”

Number

yes

The depth in millimeters of the irrigation. This is always provided, even when the plan is provided in percents. When the “type” is “avoid” or “ignore” this is always 0.

“application_percent”

Number

yes

The depth in percent of the maximum depth that the machine can irrigate. This is always provided, however when the plan is a “FullVRI” plan, it has a value of 0.

...