API Explorer 896 endpoints

Partially update land_manager

PATCH /obp/dynamic-entity/land_manager/LAND_MANAGER_ID

OBPv4.0.0-dynamicEntity_patchland_manager_ Roles: CanUpdateDynamicEntityRecord_land_manager(per bank) _Land_managerDynamic-EntityDynamic

Partially update land_manager: 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.

Has the right to carry out activities - we may want this to have its own wallet address. This Dynamic Entity is part of OGCR.

Property List:

  • land_manager_id: Internal identifier for the land manager entity
  • legal_name: Name of the land manager
  • email: Land manager email address
  • phone: Land manager phone number
  • ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"land_manager"
    }
    {
        "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
{
  "land_manager_id": "lm_03PVAF03760",
  "legal_name": "Bob Smith",
  "email": "example.email@email.com",
  "phone": "+49 987 654 321",
  "ogcr_wallet_address": "string"
}
Example success response
{
  "land_manager": {
    "land_manager_id": "lm_03PVAF03760",
    "legal_name": "Bob Smith",
    "email": "example.email@email.com",
    "phone": "+49 987 654 321",
    "ogcr_wallet_address": "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_patchland_manager_ Originally /land_manager/LAND_MANAGER_ID