GET api/irs1098/searchprintedfiles?year={year}&entityId={entityId}&buildingId={buildingId}&unitId={unitId}&residentId={residentId}&batchNumber={batchNumber}&batchSize={batchSize}
Search for residents 1098 printed files
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| year |
Year. Required |
integer |
Required |
| entityId |
Entity Id. Optional |
integer |
None. |
| buildingId |
Building Id. Optional |
integer |
None. |
| unitId |
Unit Id. Optional |
integer |
None. |
| residentId |
Resident Id. Optional |
integer |
None. |
| batchNumber |
Batch Number. Optional. Default to 1. Determines what subset of the record to return. Batch number 1 = records 1-1000. Batch number 2 = records 1001-2000. |
integer |
Default value is 1 |
| batchSize |
Batch Size. Optional. Default to 1000. Amount of records return. |
integer |
Default value is 1000 |
Body Parameters
None.
Response Information
Resource Description
ListWrapperOfIrs1098ResidentDocumentViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Total |
|
integer |
None. |
| Elements |
|
Collection of Irs1098ResidentDocumentViewModel |
None. |
Response Formats
application/json, text/json
Sample not available.