API Explorer 896 endpoints

Partially update parcel_owner

PATCH /obp/dynamic-entity/banks/ogcr/parcel_owner/PARCEL_OWNER_ID

OBPv4.0.0-dynamicEntity_patchparcel_owner_ogcr Roles: CanUpdateDynamicEntityRecord_parcel_owner(per bank) _Parcel_owner(ogcr)Dynamic-EntityDynamic

Partially update parcel_owner: only the fields supplied in the body are changed; others are preserved.

This is also the write path for field-level write-restricted fields (those declared with write_role_required or an explicit write_role). Authorisation is per field present in the body: a write-restricted field requires that field's write role, and an unrestricted field requires the entity update role. You may change a field if (and only if) you hold the role that governs it; the request is rejected with 403 (missing role) listing the roles you lack. There is no blanket entity-update precondition — holding only a field's write role is sufficient to PATCH that field alone.

Parsed entity parcel_owner. This Dynamic Entity is part of OGCR.

Property List:

  • parcel_owner_id: Internal identifier
  • parcel_id: Parcel the claim is about
  • legal_name: Owner as declared by the operator
  • owner_type: natural_person, legal_person or public_entity
  • country_id: Country of the owner's address
  • supporting_document_id: Deed or cadastre extract upoaded by operator

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_owner"
    }
    {
        "key":"url",
        "value":"http://mydomain.com/xxx"
    }
  ]
}

</details>

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

Example request body
{
  "parcel_owner_id": "string",
  "parcel_id": "string",
  "legal_name": "string",
  "owner_type": "string",
  "country_id": "string",
  "supporting_document_id": "string"
}
Example success response
{
  "bank_id": "ogcr",
  "parcel_owner": {
    "parcel_owner_id": "string",
    "parcel_id": "string",
    "legal_name": "string",
    "owner_type": "string",
    "country_id": "string",
    "supporting_document_id": "string"
  }
}
Possible errors (4)
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-20006: User is missing one or more roles:
  • OBP-10001: Incorrect json format.
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_patchparcel_owner_ogcr Originally /banks/ogcr/parcel_owner/PARCEL_OWNER_ID