Skip to main content

ResponseWrapperNotificationTemplateListDto

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 [
  • idinteger<int64>

    Unique identifier for the notification template

    Example: 42
    codestring

    Unique code identifier for the notification template

    Example: ACCOUNT_CREATION
    titleTemplatestring

    Title template with placeholders for variables

    Example: Welcome to _BANK_NAME_ - Your account has been created
    messageTemplatestring

    Message body template with placeholders for variables

    Example: Dear _CUSTOMER_NAME_, Your _ACCOUNT_TYPE_ account has been successfully created with account number _ACCOUNT_NUMBER_. You can now access your account through our mobile app or website. Thank you for choosing _BANK_NAME_.
    channelstring

    Communication channel for this notification template

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

    Example: EMAIL
    statusstring

    The status of the notification template. Possible values: ACTIVE, INACTIVE

    Possible values: [ACTIVE, INACTIVE, ACTIVE, INACTIVE]

    Example: ACTIVE
    languagestring

    Language code for the template (ISO 639-1)

    Example: en
    requiredVariablesstring

    Comma-separated list of required variables for this template

    Example: _BANK_NAME_,_CUSTOMER_NAME_,_ACCOUNT_TYPE_,_ACCOUNT_NUMBER_
    bankCodestring

    Bank code associated with this template

    Example: ADR001
    createdBystring

    Username of the user who created this template

    Example: john.doe
    updatedBystring

    Username of the user who last updated this template

    Example: jane.smith
    createdAtstring<date-time>

    Timestamp when the template was created

    updatedAtstring<date-time>

    Timestamp when the template was last updated

  • ]
  • 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

    ResponseWrapperNotificationTemplateListDto
    {
    "status": "ERROR/SUCCESS",
    "message": "Request failed/Request successful",
    "codeMessage": "ERR-001/SUC-001",
    "data": {
    "content": [
    {
    "id": 42,
    "code": "ACCOUNT_CREATION",
    "titleTemplate": "Welcome to _BANK_NAME_ - Your account has been created",
    "messageTemplate": "Dear _CUSTOMER_NAME_,\n\nYour _ACCOUNT_TYPE_ account has been successfully created with account number _ACCOUNT_NUMBER_. You can now access your account through our mobile app or website.\n\nThank you for choosing _BANK_NAME_.",
    "channel": "EMAIL",
    "status": "ACTIVE",
    "language": "en",
    "requiredVariables": "_BANK_NAME_,_CUSTOMER_NAME_,_ACCOUNT_TYPE_,_ACCOUNT_NUMBER_",
    "bankCode": "ADR001",
    "createdBy": "john.doe",
    "updatedBy": "jane.smith",
    "createdAt": "2024-07-29T15:51:28.071Z",
    "updatedAt": "2024-07-29T15:51:28.071Z"
    }
    ],
    "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"
    }