API Explorer 896 endpoints

Delete retirement_event by id

DELETE /obp/dynamic-entity/banks/dylan-bank/retirement_event/RETIREMENT_EVENT_ID

OBPv4.0.0-dynamicEntity_deleteretirement_event_dylan-bank Roles: CanDeleteDynamicEntityRecord_retirement_event(per bank) _Retirement_event(dylan-bank)Dynamic-EntityDynamic

Delete retirement_event by id

MethodRouting settings example:

<details>

{
  "is_bank_id_exact_match":false,
  "method_name":"dynamicEntityProcess",
  "connector_name":"rest_vMar2019",
  "bank_id_pattern":".*",
  "parameters":[
    {
        "key":"entityName",
        "value":"retirement_event"
    }
    {
        "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
{
  "retirement_event_id": "ret_01JS0347FKH",
  "carbon_credit_batch_id": "batch_03OGNWO397234DQ",
  "unit_type": "string",
  "amount": 1,
  "owner_address": "string",
  "beneficiary_name": "string",
  "end_use": "string",
  "retirement_reason": "string",
  "status_code": "string",
  "status_message": "string",
  "retirement_date": "2020-01-01",
  "certificate_of_compliance_id": "string"
}
Example success response
{
  "bank_id": "dylan-bank",
  "retirement_event": {
    "retirement_event_id": "ret_01JS0347FKH",
    "carbon_credit_batch_id": "batch_03OGNWO397234DQ",
    "unit_type": "string",
    "amount": 1,
    "owner_address": "string",
    "beneficiary_name": "string",
    "end_use": "string",
    "retirement_reason": "string",
    "status_code": "string",
    "status_message": "string",
    "retirement_date": "2020-01-01",
    "certificate_of_compliance_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_deleteretirement_event_dylan-bank Originally /banks/dylan-bank/retirement_event/RETIREMENT_EVENT_ID