Skip to main content

​
GridRequestParams

The GridRequestParams model is used for querying grid data with filtering and pagination capabilities.

​
Query Parameters

​
TypeFilter
integer
required
Filter type for date-based queries. Valid values:
  • 1 - PreviousDay: Previous day
  • 2 - PreviousMonth: Previous month
  • 3 - CurrentMonth: Current month
  • 4 - LastYear: Previous year
  • 5 - FullMonthByYear: Specific month and year (requires Month and Year parameters)
  • 6 - Custom: Custom date range
  • 7 - AllRecords: All records without date filtering
​
Month
integer
Specific month to search. Valid range: 1-12. Required when TypeFilter is set to 5 (FullMonthByYear).
​
Year
integer
Specific year to search. Valid values from previous year onwards. Required when TypeFilter is set to 5 (FullMonthByYear).
​
Page
integer
default:"1"
Page number for pagination. Starts at 1.
​
PagSize
integer
Number of records to retrieve per page. Controls the page size for pagination.

​
Example Request

GET /api/endpoint?TypeFilter=5&Month=3&Year=2026&Page=1&PagSize=10

​
Example Query Parameters

{
  "TypeFilter": 5,
  "Month": 3,
  "Year": 2026,
  "Page": 1,
  "PagSize": 10
}

​
Usage Examples

​
Get current month data

GET /api/endpoint?TypeFilter=3&Page=1&PagSize=20

​
Get specific month and year

GET /api/endpoint?TypeFilter=5&Month=12&Year=2025&Page=1&PagSize=50

​
Get previous day data

GET /api/endpoint?TypeFilter=1&Page=1&PagSize=100

Build docs developers (and LLMs) love

Get started for freeTalk to us