API Explorer 5 endpoints

Partially update operator

PATCH /obp/dynamic-entity/operator/OPERATOR_ID

OBPv4.0.0-dynamicEntity_patchoperator_ Roles: CanUpdateDynamicEntityRecord_operator(per bank) _OperatorDynamic-EntityDynamic

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

‘operator’ means any natural or legal person or public entity that operates or controls an activity, or to whom or to which decisive economic power over the technical functioning of the activity has been delegated;. This Dynamic Entity is part of OGCR.

Property List:

  • operator_id: Internal identifier for the operator entity
  • legal_name: Legal name of the Operator.
  • email: Operator email address.
  • phone: Operator contact phone in international format.
  • address_line_1: Operator primary street address (street name, building number, P.O. Box if applicable)
  • address_line_2: Operator secondary, optional details like apartment, suite, unit, floor, or building name
  • postcode: Operator postcode
  • country_code: ISO 3166-1 alpha-2 country code for operator address.
  • ogcr_wallet_address: Wallet address to send NFTs and carbon credits to after evaluation period

Write-restricted fields (set only via PATCH by a holder of the field's write role): phone

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"operator"
    }
    {
        "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
{
  "operator_id": "op_01JS0347FKH",
  "legal_name": "Agreena",
  "email": "contact@example.com",
  "phone": "+49 123 456 789",
  "address_line_1": "Green Street, 20",
  "address_line_2": "Suite 400",
  "postcode": "10115\" or \"W1K 3JP",
  "country_code": "DE",
  "ogcr_wallet_address": "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"
}
Example success response
{
  "operator": {
    "operator_id": "op_01JS0347FKH",
    "legal_name": "Agreena",
    "email": "contact@example.com",
    "phone": "+49 123 456 789",
    "address_line_1": "Green Street, 20",
    "address_line_2": "Suite 400",
    "postcode": "10115\" or \"W1K 3JP",
    "country_code": "DE",
    "ogcr_wallet_address": "0xAb5801a7D398351b8bE11C439e05C5B3259aeC9B"
  }
}
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_patchoperator_ Originally /operator/OPERATOR_ID