API Explorer 891 endpoints

Get Public retirement_event List

GET /obp/dynamic-entity/banks/ogcr/public/retirement_event

OBPv4.0.0-dynamicEntity_getPublicretirement_eventList_ogcr No role required _Retirement_event(ogcr)Dynamic-EntityDynamic

Get Public retirement_event List.

Parsed entity retirement_event. This Dynamic Entity is part of OGCR.

Property List:

  • retirement_event_id: Internal identifier for the retirement event
  • carbon_credit_batch_id: Batch the retired credits are drawn from
  • unit_type: Unit category being retired, must match the batch
  • amount: Quantity of CO2e tonnes to retire
  • owner_address: Wallet/TBA the credits are retired from
  • beneficiary_name: The "entity that uses the certified units" (Annex III(h))
  • end_use: Declared end-use of the unit (Recital 42)
  • retirement_reason: Free-text claim statement
  • status_code: in_progress, failed
  • status_message: further explanation of status code
  • retirement_date: Date retirement was requested
  • certificate_of_compliance_id: Traces the unit back to its certificate

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>

Authentication is Optional

Filtering, sorting and pagination on the list endpoint:

Queryable (declared indexed) fields: carbon_credit_batch_id, certificate_of_compliance_id, retirement_event_id, status_code.

  • Filter: ?obp_filter[FIELD]=OP:VALUE. Operators: eq, ne, in, lt, gt, le, ge, between, like, is_null, not_set. in / between take comma-separated values; is_null / not_set take no value. Repeat the same key to AND several constraints on one field. e.g. ?obp_filter[status]=eq:active&obp_filter[amount]=between:10,100 or ?obp_filter[closed_date]=not_set
  • Legacy filter (still supported): bare field parameters, e.g. ?name=James%20Brown&number=123.456&number=11.11 filters by name == "James Brown" && (number == 123.456 || number == 11.11).
  • Sort: ?obp_sort_by=FIELD[,FIELD2]&obp_sort_direction=ASC|DESC.
  • Paginate: ?obp_limit=20&obp_offset=40.

Filtering, sorting, pagination and is_null / not_set work on every deployment (no special backend required).

One-hop join queries (obp_exists / obp_not_exists) are not available on this endpoint.

User Authentication is Optional. The User need not be logged in.

Example success response
{
  "bank_id": "ogcr",
  "retirement_event_list": [
    {
      "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 (1)
  • OBP-50000: Unknown Error.
Implemented by OBPv4.0.0 dynamicEntity_getPublicretirement_eventList_ogcr Originally /banks/ogcr/public/retirement_event