GET Api/Brms/Awards?currentPageNumber={currentPageNumber}&pageSize={pageSize}&beginDate={beginDate}&endDate={endDate}
This method is used to GET BRMS Award Records from CACTAS Optional beginDate and/or endDate can be passed in the URL to filter by DateLastUpdated. This method implements paging. Current Page Number and Page Size must be supplied.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| currentPageNumber |
Current Page Number. |
integer |
Default value is 1 |
| pageSize |
Max pageSize 1000. |
integer |
Default value is 1000 |
| beginDate |
Optional. Date format mm/dd/yyyy |
date |
None. |
| endDate |
Optional. Date format mm/dd/yyyy |
date |
None. |
Body Parameters
None.
Response Information
Resource Description
PagingResponseModelOfIListOfBrmsAwardModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalRecords | integer |
None. |
|
| CurrentPageNumber | integer |
None. |
|
| PageSize | integer |
None. |
|
| TotalPages | integer |
None. |
|
| HasNextPage | boolean |
None. |
|
| HasPreviousPage | boolean |
None. |
|
| Data | Collection of BrmsAwardModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"totalRecords": 1,
"currentPageNumber": 2,
"pageSize": 3,
"totalPages": 4,
"hasNextPage": true,
"hasPreviousPage": true,
"data": [
{
"id": 1,
"awardeeName": "sample string 2",
"awardeeTaxId": "sample string 3",
"awardDate": "2026-05-13T13:50:08.0961043-05:00",
"contractNumber": "sample string 4",
"certificateNumber": "sample string 5",
"enterpriseStatus": "sample string 6",
"firstTaxYear": 1,
"isRefundable": true,
"isSsn": true,
"issueDate": "2026-05-13T13:50:08.0961043-05:00",
"lastTaxYear": 1,
"program": "sample string 9",
"taxCreditAmount": 10,
"taxCreditCode": 11,
"taxCreditType": "sample string 12",
"taxType": "sample string 13",
"dateLastUpdated": "2026-05-13T13:50:08.0961043-05:00"
},
{
"id": 1,
"awardeeName": "sample string 2",
"awardeeTaxId": "sample string 3",
"awardDate": "2026-05-13T13:50:08.0961043-05:00",
"contractNumber": "sample string 4",
"certificateNumber": "sample string 5",
"enterpriseStatus": "sample string 6",
"firstTaxYear": 1,
"isRefundable": true,
"isSsn": true,
"issueDate": "2026-05-13T13:50:08.0961043-05:00",
"lastTaxYear": 1,
"program": "sample string 9",
"taxCreditAmount": 10,
"taxCreditCode": 11,
"taxCreditType": "sample string 12",
"taxType": "sample string 13",
"dateLastUpdated": "2026-05-13T13:50:08.0961043-05:00"
}
]
}