List notification

GET 
/v2/config/digital-wallet/openid/notifications

This endpoint is used for listing notification.

Request

Query Parameters

offset integerrequired

Requested index for start of resources to be provided in response requested by client

limit integerrequired

Default value: 10

Number of items returned per page. Requested number of resources to be provided in response requested by client.

status string

Possible values: [read, unread]

Filtering notification by status

notificationType string

Possible values: [credential_acked, credential_revoked, credential_expired]

Filtering notification by notification type

Responses

200

Response Headers

application/json

Schema

Schema

notification object[]
Array [
id stringrequired
Identifier for the notification
notificationType stringrequired
Possible values: [credential_acked, credential_revoked, credential_expired]
Define the type of the notification
notificationTypeRelatedId stringrequired
Define the type related id of the notification
notificationContent object
Define the content of the notification
status string
Possible values: [read, unread]
Define the status of the notification
createdAt numberrequired
Timestamp when the record was created.
updatedAt numberrequired
Timestamp when the record was updated.
]
pagination object

currentPage integer

Current page number

totalItems integer

Total number of items available

totalPages integer

Total number of pages based on limit

limit integer

Number of items per page

hasPrevious boolean

Indicates if there's a previous page

hasNext boolean

Indicates if there's a next page

Example (from schema)

{
  "notification": [
    {
      "id": "string",
      "notificationType": "credential_acked",
      "notificationTypeRelatedId": "string",
      "notificationContent": {},
      "status": "read",
      "createdAt": 0,
      "updatedAt": 0
    }
  ],
  "pagination": {
    "currentPage": 0,
    "totalItems": 0,
    "totalPages": 0,
    "limit": 0,
    "hasPrevious": true,
    "hasNext": true
  }
}

Loading...