ResponseWrapperEventDto

Generic API response wrapper for Event

statusstring

Response status

Possible values: [SUCCESS, ERROR]

Example: SUCCESS

messagestring

Message describing the response

Example: Request successful

codeMessagestring

Code message describing the response

Example: SUC-001

data objectnullable

Event Data Transfer Object

idinteger<int64>required

Unique identifier of the event

Example: 1

moduleCodestringrequired

Module code (TF for Trade Finance, SCF for Supply Chain Finance)

Possible values: <= 10 characters

Example: TF

moduleNamestringrequired

Human-readable module name

Possible values: <= 100 characters

Example: Trade Finance

eventCodestringrequired

Unique event code within the module

Possible values: <= 50 characters

Example: ISS

eventNamestringrequired

Human-readable event name

Possible values: <= 200 characters

Example: Issuance

descriptionstringnullable

Detailed description of the event

Possible values: <= 500 characters

Example: Event for initiating a new transaction

createdAtstring<date-time>

Timestamp when the event was created

Example: 2025-01-15T09:36:22.500Z

updatedAtstring<date-time>

Timestamp when the event was last updated

Example: 2025-01-15T09:36:22.500Z

error objectnullable

Details of any error that occurred

codestring

Error code

Example: ERR_GENERAL_0004

messagestring

Human-readable error message

Example: The requested resource was not found

details object[]

List of error details

Array [

codestring

Specific error code

Example: ER4001

messagestring

What went wrong

Example: Invalid input

targetstring

Field that caused the issue

Example: productCode

]

suggestionsstring[]

Suggested actions to resolve the error

Example: ["Check the resource ID","Ensure the resource exists"]

metaData object

Additional metadata about the error

property name*string

timestampstring<date-time>

Timestamp of when the response was generated

Example: 2025-01-15T09:36:22.500Z

ResponseWrapperEventDto
{
  "status": "SUCCESS",
  "message": "Request successful",
  "codeMessage": "SUC-001",
  "data": {
    "id": 1,
    "moduleCode": "TF",
    "moduleName": "Trade Finance",
    "eventCode": "ISS",
    "eventName": "Issuance",
    "description": "Event for initiating a new transaction",
    "createdAt": "2025-01-15T09:36:22.500Z",
    "updatedAt": "2025-01-15T09:36:22.500Z"
  },
  "error": {
    "code": "ERR_GENERAL_0004",
    "message": "The requested resource was not found",
    "details": [
      {
        "code": "ER4001",
        "message": "Invalid input",
        "target": "productCode"
      }
    ],
    "suggestions": [
      "Check the resource ID",
      "Ensure the resource exists"
    ],
    "metaData": {}
  },
  "timestamp": "2025-01-15T09:36:22.500Z"
}

#ResponseWrapperEventDto

ResponseWrapperEventDto