Current crop
/modules/{id}/crop Path parameters
-
idinteger required
Query parameters
-
langstringLanguage of the
labelfields, and of a probe’s default name (name: “Probe 3”, “Sonde 3”). Thecodevalues never vary. A crop with no translation falls back to its French name.
Response
Active crop, or null if nothing is declared
-
idinteger always presentIdentifier of the declaration.
-
module_idinteger always present -
crop_idinteger nullable always presentCrop:
codefromGET /reference/crops.nullin manual mode. -
planting_datestring date-time nullable always presentPlanting or sowing date: a day, returned at midnight UTC.
nullin manual mode. -
manual_zr_cmnumber nullable always presentRoot depth entered by hand, in cm.
nullin crop mode. -
is_manualboolean always presenttrue: manual mode, with no crop. -
zr_cap_cmnumber nullable always presentRoot depth cap specific to the module, in cm (crop mode): the depth used becomes min(
zr_min_cm,zr_cap_cm).null: no cap. -
timestamp_startstring date-time always presentDate of the declaration.
-
notesstring nullable always present -
crop_namestring nullable always presentName of the crop in the requested language (
lang).nullin manual mode. -
name_scientificstring nullable always presentScientific name.
nullin manual mode, or if not filled in. -
zr_min_cmnumber nullable always presentRoot depth used by the hub, in cm: the crop’s lower FAO-56 bound (
root_depth_min_cmin the reference data), or the manual depth. -
zr_max_cmnumber nullable always presentThe crop’s upper FAO-56 bound, in cm. In manual mode, the manual depth.
Errors
- 400
Invalid parameter
invalid_id - 401
Not authenticated
- 403
Insufficient scope, or resource outside your company