API Explorer 1884 endpoints

Get growing_season List

GET /obp/v7.0.0/banks/ogcr/dynamic-entities/growing_season

OBPv7.0.0-dynamicEntity_getgrowing_seasonList_ogcr Roles: CanGetDynamicEntityRecord_growing_season(per bank) _Growing_season(ogcr)Dynamic-EntityDynamic

Get growing_season List.

Records one growing season of a specific crop on a specific parcel. Because a single parcel can host multiple crops across seasons (rotation) or simultaneously (intercropping), this entity is separate from the parcel and linked to it via parcel_id. Each record captures what was grown, when, on how much area, and how much was harvested. This Dynamic Entity is part of OGCR.

Property List:

  • growing_season_id: Unique internal identifier automatically assigned to each crop season record.
  • parcel_id: The identifier of the parcel on which this crop was grown. Links this crop season to the parcel's geometry, ownership, and dNFT records.
  • crop_id: Reference to the crop type entry in the Crop reference table. Determines commodity category and emission factor for Scope 3 calculations.
  • start_date: The date the crop was sown or planted on this parcel. Used to define the growing season window for MRV alignment and corporate reporting period matching.
  • end_date: The date the crop was harvested or the growing season ended. Together with season_start_date, this defines the period covered by any yield and dMRV observations for this crop instance.
  • year: The calendar year in which the majority of this growing season falls. Used as a simple label for annual reporting and filtering, especially when a season spans two calendar years.
  • is_cover_crop: Indicates whether this crop is grown primarily to protect or enrich the soil between main cash crop seasons, rather than for commercial harvest. Cover crops are a key carbon farming practice that can affect SOC baselines and additionality assessments.
  • crop_area_ha: The area of the parcel actually planted with this crop, in hectares. This may be less than the total parcel area if part of the parcel is left as buffer strips, tracks, or planted with a different crop. Required for dMRV spatial weighting (SOC and biomass estimates are per hectare and must be scaled to area) and for Scope 3 supply shed area aggregation.
  • yield_kg_per_ha: The harvested yield of this crop expressed in kilograms per hectare. This is the core denominator for emission intensity calculations under the GHG Protocol FLAG approach (e.g., kg CO2e per tonne of wheat), which agrifood companies use for Scope 3 reporting.
  • yield_total_kg: Total harvested yield for this crop season on this parcel, in kilograms. Can be entered directly by the farmer or derived from yield_kg_ha × crop_area_ha. Used to report sourcing volumes in lease contracts.
  • yield_source: Indicates how the yield figure was obtained, affecting the assurance level buyers can claim in CSRD or SBTi reports. Controlled vocabulary: farmer_reported, dMRV_estimated, third_party_verified.
  • farming_practice: The farming management approach applied during this growing season. This is what distinguishes a carbon farming activity from a conventional baseline and drives additionality. Controlled vocabulary: conventional, no_till, reduced_till, organic, regenerative, agroforestry.
  • fertiliser_use_kg_per_ha: Total nitrogen fertiliser applied during this season, in kilograms per hectare. Used to estimate N2O emissions (a potent greenhouse gas from agricultural soils), which must be subtracted from the net carbon benefit under CRCF accounting rules.
  • residue_management: How crop residues (straw, stems, leaves) are handled after harvest. This directly affects soil organic carbon dynamics. Controlled vocabulary: incorporated (ploughed back in), removed (baled and sold), burned.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"growing_season"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

User Authentication is Required. The User must be logged in. The Application must also be authenticated.

Filtering, sorting and pagination on the list endpoint:

Queryable (declared indexed) fields: crop_id, growing_season_id, parcel_id.

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop joins (EXISTS / NOT EXISTS) — filter this entity by a condition on a related entity linked through a declared reference: field:

  • ?obp_exists[RelatedEntity] — keep rows that have at least one related RelatedEntity.
  • ?obp_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...that have at least one matching the predicate.
  • ?obp_not_exists[RelatedEntity] — keep rows with NO related RelatedEntity at all.
  • ?obp_not_exists[RelatedEntity]=filter[FIELD]=eq:VALUE — ...with no related RelatedEntity matching the predicate (this includes rows that have no related RelatedEntity).
  • If two entities are linked by more than one reference, disambiguate the edge with via:, e.g. ?obp_exists[RelatedEntity]=via:buyer_ref;filter[status]=eq:signed.

The nested filter[...] reuses the operator grammar above. Mind the distinction: obp_not_exists[X]=filter[flag]=eq:true (no related X with flag=true — includes rows with no X) is not the same as obp_exists[X]=filter[flag]=ne:true (has a related X with flag≠true — excludes rows with no X).

Only a field typed reference:<Entity> and declared indexed: true forms a join edge; a plain string field holding ids is not joinable.

This entity's reference fields (each usable as a one-hop join edge to its target entity): crop_id → crop, parcel_id → parcel.

Joins require the SQL projection backend (dynamic_entity.indexing.backend=auto on Postgres or SQL Server) with the involved fields indexed and ready. On an in-memory deployment a join query returns 400 (OBP-09022); while an index is still building it returns 409. The plain filter / sort / paginate / is_null / not_set features above do not need the projection backend.

Example success response
{
  "bank_id": "ogcr",
  "growing_season_list": [
    {
      "growing_season": {
        "growing_season_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
        "parcel_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
        "crop_id": "3dece208-c95c-11f0-9041-54e1adfac5b1",
        "start_date": "2026-10-15",
        "end_date": "2027-07-20",
        "year": 2027,
        "is_cover_crop": true,
        "crop_area_ha": 7.4,
        "yield_kg_per_ha": 6200,
        "yield_total_kg": 45880,
        "yield_source": "farmer_reported",
        "farming_practice": "no_till",
        "fertiliser_use_kg_per_ha": 120,
        "residue_management": "incorporated"
      },
      "metadata": {
        "created": {
          "at": "2026-09-30T10:12:00Z",
          "user_id": "a9f2c7e1-3d4b-4a5c-8e6f-7a8b9c0d1e2f",
          "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
        },
        "updated": {
          "at": "2026-09-30T11:40:00Z",
          "user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
          "on_behalf_of_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1"
        }
      }
    }
  ]
}
Possible errors (3)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-50000: Unknown Error.
Implemented by OBPv7.0.0 dynamicEntity_getgrowing_seasonList_ogcr Originally /banks/ogcr/dynamic-entities/growing_season