Skip to main content

ResponseWrapperNotificationHistoryListDto

statusstring

Status of the response

Possible values: [SUCCESS, ERROR]

Example: ERROR/SUCCESS
messagestring

Message describing the response

Example: Request failed/Request successful
codeMessagestring

Code message describing the response

Example: ERR-001/SUC-001
data object

Represents paginated results.

content object[]

The list of items in the current page.

  • Array [
  • bankCodestring

    Bank code identifier

    Example: BNK001
    requestIdentifierstring

    Unique request identifier

    Example: REQ-2024-001
    eventIdstring

    Event identifier

    Example: EVT-12345
    notificationCodestring

    Notification code

    Example: NOTIF_001
    titlestring

    Notification title

    Example: Transaction completed
    messagestring

    Notification message content

    Example: Your transaction has been completed successfully
    attachmentNamestring

    Name of the attached file

    Example: invoice_12345.pdf
    channelstring

    Notification channel used

    Possible values: [SMS, EMAIL, PUSH, VOCAL]

    Example: EMAIL
    languagestring

    Notification language

    Example: en
    emailsstring

    Comma-separated list of recipient emails

    Example: user1@example.com,user2@example.com
    phoneNumbersstring

    Comma-separated list of recipient phone numbers

    Example: +212612345678,+212698765432
    uuidsstring

    Comma-separated list of recipient UUIDs

    Example: uuid1,uuid2,uuid3
    createdOnstring

    Creation date and time

    Example: 2024-01-15T10:30:00Z
  • ]
  • totalElementsinteger<int64>

    The total number of elements across all pages.

    Example: 100
    totalPagesinteger<int32>

    The total number of pages available.

    Example: 10
    numberinteger<int32>

    The current page number (zero-based).

    Example: 0
    sizeinteger<int32>

    The number of items per page.

    Example: 10
    error object

    Detailed information about the error response

    codestring

    Error code

    Example: ERR-142
    messagestring

    Error message

    Example: Resource not found / Internal server error
    details object[]

    List of error details

  • Array [
  • codestring

    Error code

    Example: ER4001
    messagestring

    Detailed error message

    Example: Invalid input
    targetstring

    Target of the error

    Example: username
  • ]
  • suggestionsstring[]

    List of suggestions for resolving the error

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

    Additional metadata about the error, that could help in debugging

    property name*string

    Additional metadata about the error, that could help in debugging

    Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}
    timestampstring<date-time>

    Timestamp of when the response was generated

    ResponseWrapperNotificationHistoryListDto
    {
    "status": "ERROR/SUCCESS",
    "message": "Request failed/Request successful",
    "codeMessage": "ERR-001/SUC-001",
    "data": {
    "content": [
    {
    "bankCode": "BNK001",
    "requestIdentifier": "REQ-2024-001",
    "eventId": "EVT-12345",
    "notificationCode": "NOTIF_001",
    "title": "Transaction completed",
    "message": "Your transaction has been completed successfully",
    "attachmentName": "invoice_12345.pdf",
    "channel": "EMAIL",
    "language": "en",
    "emails": "user1@example.com,user2@example.com",
    "phoneNumbers": "+212612345678,+212698765432",
    "uuids": "uuid1,uuid2,uuid3",
    "createdOn": "2024-01-15T10:30:00Z"
    }
    ],
    "totalElements": 100,
    "totalPages": 10,
    "number": 0,
    "size": 10
    },
    "error": {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "username"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {
    "requestId": "3c5e4cebf39cbc5b",
    "operationId": "66fd4d2ae6b6"
    }
    },
    "timestamp": "2024-07-29T15:51:28.071Z"
    }