API Explorer 111 endpoints

Partially update customer_cars

PATCH /obp/dynamic-entity/customer_cars/CUSTOMER_CARS_ID

OBPv4.0.0-dynamicEntity_patchcustomer_cars_ Roles: CanUpdateDynamicEntityRecord_customer_cars(per bank) _Customer_carsDynamic-EntityDynamic

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

The car the customer arrived in

Property List:

  • customer_identifier: description of customer_identifier field, can be markdown text.
  • manufacturer: description of manufacturer field, can be markdown text.

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"customer_cars"
    }
    {
        "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
{
  "customer_identifier": "bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
  "manufacturer": "BMW"
}
Example success response
{
  "customer_cars": {
    "customer_cars_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
    "customer_identifier": "bc37e0fb-b75b-48d3-8fe9-c94ff064aa9a",
    "manufacturer": "BMW"
  }
}
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_patchcustomer_cars_ Originally /customer_cars/CUSTOMER_CARS_ID