Skip to main content

RequestAccountIssuesHistory

The RequestAccountIssuesHistory API is designed to retrieve a paginated history of notifications associated with a specific account. It provides flexible filtering by date ranges, processing status, and specific categories, along with a full-text search capability.


Request Model: RequestAccountIssuesHistory

Description: This class serves as the Data Transfer Object (DTO) for requesting history data. It implements several interfaces to standardize pagination, time filtering, and searching.

Inheritance & Interfaces

  • RequestForNodesBase: Base request class for node-based routing.
  • IPager: Provides pagination properties (PageSize, PageNum).
  • ITimeIntervalFilter: Provides time range filtering (From, To).
  • ISearchFilter: Provides full-text search capability (Search).

Properties

PropertyTypeDescriptionDefault
LoginulongRequired. Unique account identifier (User ID or Account Number).0
SearchstringText string to filter results by titles, descriptions, or comments.null
IsProcessedbool?Filter by status: true (resolved), false (open), or null (all).null
FromDateTime?Start date for the history interval (inclusive).null
ToDateTime?End date for the history interval (inclusive).null
IssuesTypesICollection<string>List of specific issue categories to include (e.g., "Technical").[]
ActionsTypesICollection<string>List of specific action types to include (e.g., "Resolved").[]
PageSizeulongNumber of items per page.15
PageNumulongThe page number to retrieve (starts from 1).1

Response Model: ResponseAccountIssuesHistory

Description: The standard response returned by the API, containing the requested data subset and pagination metadata.

Response Wrapper Properties

PropertyTypeDescription
TotalCountulongTotal number of records matching the filters in the database.
NodesstringOne node is indicated on which the account is registered
PageNumulongCurrent page number (echoed from the request).
PageSizeulongNumber of items per page (echoed from the request).
TotalPagesulongTotal number of available pages (calculated).
ItemsCollectionA list of AccountIssueHistoryItem objects for the current page.

Item Model: AccountIssueHistoryItem

PropertyTypeDescription
IdstringUnique identifier of the specific history record.
LoginulongAccount ID associated with the record.
NodesstringOne node is indicated on which the account is registered
IssueTypestringThe category of the issue.
ActionTypestringThe specific action performed.
IsProcessedboolCurrent processing status of the issue.
CreatedAtDateTimeTimestamp when the record was created.
TitlestringShort summary or title of the issue.
DescriptionstringDetailed description or logs associated with the issue.

Usage Example

JSON Request

{
"Login": 123456,
"Search": "failure",
"IsProcessed": false,
"Nodes": [
"node1"
],
"From": "2023-09-01T00:00:00Z",
"To": "2023-09-30T23:59:59Z",
"IssuesTypes": ["TriggerScalpers"],
"PageSize": 10,
"PageNum": 1
}