Skip to content

Current crop

GET /modules/{id}/crop
  • Scope agronomy:read
  • API key x-api-key
  • Base URL https://api.hub.akuasense.com/v1

Path parameters

  • id integer required

Query parameters

  • lang string

    Language of the label fields, and of a probe’s default name (name: “Probe 3”, “Sonde 3”). The code values never vary. A crop with no translation falls back to its French name.

    Values: enfr
    Default: en

Response

200

Active crop, or null if nothing is declared

  • id integer always present

    Identifier of the declaration.

  • module_id integer always present
  • crop_id integer nullable always present

    Crop: code from GET /reference/crops. null in manual mode.

  • planting_date string date-time nullable always present

    Planting or sowing date: a day, returned at midnight UTC. null in manual mode.

  • manual_zr_cm number nullable always present

    Root depth entered by hand, in cm. null in crop mode.

  • is_manual boolean always present

    true: manual mode, with no crop.

  • zr_cap_cm number nullable always present

    Root 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_start string date-time always present

    Date of the declaration.

  • notes string nullable always present
  • crop_name string nullable always present

    Name of the crop in the requested language (lang). null in manual mode.

  • name_scientific string nullable always present

    Scientific name. null in manual mode, or if not filled in.

  • zr_min_cm number nullable always present

    Root depth used by the hub, in cm: the crop’s lower FAO-56 bound (root_depth_min_cm in the reference data), or the manual depth.

  • zr_max_cm number nullable always present

    The 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