Reported Data

Reported Data#

POST /v1/reported-data#

Submit data reports manually from the user side.

Payload#

{
    "field_id": "4685b79a-c2ae-429a-8a7e-a4b412ca0779",
    "data": {
        "tillage": {
            "result": "no-til",
            "start_date": "2022-01-01",
            "end_date": "2022-03-01"
        },
        "crop_type": {
            "result": "canola",
            "start_date": "2022-01-01",
            "end_date": "2022-03-01"
        },
        "cover_crop": {
            "result": true,
            "start_date": "2022-01-01",
            "end_date": "2022-03-01"
        },
        "deforestation": {
            "result": true,
            "start_date": "2022-01-01",
            "end_date": "2022-03-01"
        },
        "soil_moisture": {
            "result": 0.1,
            "start_date": "2022-01-01",
            "end_date": "2022-03-01"
        }
    }
}

  • field_id: UUID of the Field for which the data is being reported.

  • data: Object containing the submitted data, grouped into capabilities. Capabilites can be:

    • tillage

    • crop_type

    • cover_crop

    • deforestation

    • soil_moisture

    Each capability section does have 3 fields:

    • result: The result value for the capability analysis. Can be of different types, depending on the capability.

    • start_date: Starting date to be taken into account for the analysis.

    • end_date: Ending date to be taken into account for the analysis.

Response#

{
    "id": "b290fe0a-edc6-4287-b80d-b87dac804be3",
    "field_id": "fd0ab153-3a5f-4054-93e0-db955c51bf6e",
    "start_date": "2022-08-04",
    "end_date": "2022-09-03",
    "created_at": "2022-08-04T15:12:49.408585+01:00",
    "updated_at": null
}

  • id: UUID of the data report.

  • field_id: UUID of the field the data was reported for.

  • start_date: Starting date to be taken into account for the analysis.

  • end_date: End date to be taken into account for the analysis.

  • created_at: Timestamp of the Reported Data object creation.

  • updated_at: Timestamp of the Reported Data object last update, in case it has been updated. Otherwise is null.

Contents