Crops

This object contains a mix of metadata about the crop, the parcel it's grown on, and specifics about the planting and harvesting timeline. Let's break down the elements of this response:

• family: An object that groups crops by their botanical family or another relevant classification. This is useful for planning rotations.

  • id: A unique identifier for the crop family.

  • name: The common name of the crop family.

  • observation: Notes or observations about the crop family, which could include general advice on rotation or specific considerations.

• name: The name of the specific crop being planted.

• campaign: This refer to the specific planting campaign or season. In agricultural terms, a campaign often refers to the period during which a particular crop is sown and harvested.

• area: The size of the area (likely in hectares or acres) where the crop is planted.

• variety: The specific variety of the crop being planted, which can be crucial for understanding yield, disease resistance, and other agronomic factors.

• harvested_qty: The quantity of crop harvested from this parcel, possibly in weight or volume units, which can be used for yield tracking and historical performance analysis.

• sowing: The date on which the crop was sown.

• closure: This could either refer to the harvest date or the end of the crop's growth cycle in the context of the API. It marks the completion of the crop's campaign.

• is_active: A boolean value indicating whether this crop rotation entry is currently active. An active entry might mean the crop is currently in the ground, while inactive refer to past rotations.

• parcel: An identifier for the specific parcel of land where the crop is grown, linking the crop data to a physical location on the farm.

This response format provides a comprehensive view of a single crop's lifecycle in the rotation plan, from planting to harvest, including specific details about the crop variety and performance metrics. It's a useful structure for an API serving users in agriculture, especially for precision farming applications where managing the details of each crop rotation is crucial for optimizing yield and soil health.

get

Path parameters

idstringRequired

Responses

get

HTTPcURLJavaScriptPython

GET /api/parcels/{id}/crops/ HTTP/1.1
Host: 
Accept: */*

200Success

[
  {
    "id": 1,
    "family": {
      "id": 1,
      "key": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "observation": "text"
    },
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "campaign": "text",
    "area": 1,
    "variety": "text",
    "harvested_qty": 1,
    "sowing": "2025-04-27",
    "closure": "2025-04-27",
    "is_active": true,
    "created": "2025-04-27T15:15:40.480Z",
    "modified": "2025-04-27T15:15:40.480Z",
    "parcel": 1
  }
]

post

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyRequired

keystring · uuidRead-onlyRequired

namestring | nullableOptional

campaignstring | nullableOptional

areanumber · double | nullableOptional

varietystring | nullableOptional

harvested_qtynumber · double | nullableOptional

sowingstring · date | nullableOptional

closurestring · date | nullableOptional

is_activebooleanOptional

createdstring · date-timeRead-onlyRequired

modifiedstring · date-timeRead-onlyRequired

parcelinteger | nullableOptional

Responses

post

HTTPcURLJavaScriptPython

POST /api/crops/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "family": {
    "id": 1,
    "name": "text",
    "observation": "text"
  },
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2025-04-27",
  "closure": "2025-04-27",
  "is_active": true,
  "parcel": 1
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

201Success

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2025-04-27",
  "closure": "2025-04-27",
  "is_active": true,
  "created": "2025-04-27T15:15:40.480Z",
  "modified": "2025-04-27T15:15:40.480Z",
  "parcel": 1
}

delete

Path parameters

idstringRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/crops/{id}/ HTTP/1.1
Host: 
Accept: */*

204

No response body

No content

patch

Path parameters

idstringRequired

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

idintegerRead-onlyOptional

keystring · uuidRead-onlyOptional

namestring | nullableOptional

campaignstring | nullableOptional

areanumber · double | nullableOptional

varietystring | nullableOptional

harvested_qtynumber · double | nullableOptional

sowingstring · date | nullableOptional

closurestring · date | nullableOptional

is_activebooleanOptional

createdstring · date-timeRead-onlyOptional

modifiedstring · date-timeRead-onlyOptional

parcelinteger | nullableOptional

Responses

patch

HTTPcURLJavaScriptPython

PATCH /api/crops/{id}/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 203

{
  "family": {
    "id": 1,
    "name": "text",
    "observation": "text"
  },
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2025-04-27",
  "closure": "2025-04-27",
  "is_active": true,
  "parcel": 1
}

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

200Success

{
  "id": 1,
  "family": {
    "id": 1,
    "key": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "observation": "text"
  },
  "key": "123e4567-e89b-12d3-a456-426614174000",
  "name": "text",
  "campaign": "text",
  "area": 1,
  "variety": "text",
  "harvested_qty": 1,
  "sowing": "2025-04-27",
  "closure": "2025-04-27",
  "is_active": true,
  "created": "2025-04-27T15:15:40.480Z",
  "modified": "2025-04-27T15:15:40.480Z",
  "parcel": 1
}