Create new retirement_event_on_chain
POST /obp/dynamic-entity/banks/dylan-bank/retirement_event_on_chain
OBPv4.0.0-dynamicEntity_createretirement_event_on_chain_dylan-bank Roles: CanCreateDynamicEntityRecord_retirement_event_on_chain(per bank) _Retirement_event_on_chain(dylan-bank)Dynamic-EntityDynamic
Create new retirement_event_on_chain.
Parsed entity retirement_event_on_chain. This Dynamic Entity is part of OGCR.
Property List:
- minted_at: On-chain block timestamp (mintedAt) from projectData, unix seconds.
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_on_chain"
}
{
"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": "string",
"token_id": "string",
"unit_type": "string",
"carbon_credit_batch_id": "string",
"amount": 1,
"owner_address": "string",
"beneficiary_name": "string",
"end_use": "string",
"retirement_reason": "string",
"retirement_date": "2020-01-01",
"minted_at": 1,
"token_uri": "string",
"contract_address": "string",
"chain_id": 1,
"tx_hash": "string",
"block_number": 1
}Example success response
{
"bank_id": "dylan-bank",
"retirement_event_on_chain": {
"retirement_event_on_chain_id": "d8839721-ad8f-45dd-9f78-2080414b93f9",
"retirement_event_id": "string",
"token_id": "string",
"unit_type": "string",
"carbon_credit_batch_id": "string",
"amount": 1,
"owner_address": "string",
"beneficiary_name": "string",
"end_use": "string",
"retirement_reason": "string",
"retirement_date": "2020-01-01",
"minted_at": 1,
"token_uri": "string",
"contract_address": "string",
"chain_id": 1,
"tx_hash": "string",
"block_number": 1
}
}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.