Type Alias GetPunishmentHistoryParams

Parameters for the get punishment history API

type GetPunishmentHistoryParams = {
    page_no?: number;
    page_size?: number;
    punishment_status: PunishmentStatus;
}

Properties

page_no?: number

Specifies the page number of data to return in the current call. Starting from 1. Default is 1.

page_size?: number

Maximum number of entries to return in a single "page" of data. The limit is between 1 and 100. Default is 10.

punishment_status: PunishmentStatus

The status of punishment to retrieve. 1: Ongoing punishments 2: Ended punishments