API Explorer 993 endpoints

Get parcel List

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

OBPv7.0.0-dynamicEntity_getparcelList_ogcr Roles: CanGetDynamicEntityRecord_parcel(per bank) _Parcel(ogcr)Dynamic-EntityDynamic

Get parcel List.

Parcel' means a geospatially defined unit of land, identified by its boundary geometry. parcel holds the stable, rarely-changing identity of the land (geometry, CRS, official land-registry codes). This Dynamic Entity is part of OGCR.

Property List:

  • parcel_id: Internal identifier for the parcel.
  • multipolygon_coordinates: GeoJSON MultiPolygon boundary of the parcel.
  • coordinate_reference_system: Coordinate Reference System (CRS) identifier that defines how to interpret the geometry coordinates (e.g., EPSG:4326 for WGS84).
  • cadastral_reference: Member state national cadastral registry ID
  • iacs_codes: Array of identifiers referencing the parcel in the Member State’s IACS (Integrated Administration and Control System). Only if applicable.
  • lpis_codes: Identifiers from the Land Parcel Identification System (LPIS) that reference official “reference parcels”/land blocks. Only if applicable.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"parcel"
    }
    {
        "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: 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.

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",
  "parcel_list": [
    {
      "parcel": {
        "parcel_id": "parcel_03OGNWO397234DQ",
        "multipolygon_coordinates": {
          "type": "MultiPolygon",
          "coordinates": [
            [
              [
                [
                  13.405,
                  52.52
                ],
                [
                  13.406,
                  52.52
                ],
                [
                  13.406,
                  52.521
                ],
                [
                  13.405,
                  52.521
                ],
                [
                  13.405,
                  52.52
                ]
              ]
            ]
          ]
        },
        "coordinate_reference_system": "EPSG:4326",
        "cadastral_reference": "string",
        "iacs_codes": "DE-BB-IACS-2026-0012345678",
        "lpis_codes": "DE-BB-LPIS-REFPARCEL-0098765432"
      },
      "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_getparcelList_ogcr Originally /banks/ogcr/dynamic-entities/parcel