GET api/checks/search/file?startDate={startDate}&endDate={endDate}&pageNumber={pageNumber}&pageSize={pageSize}&sortField={sortField}&desc={desc}

Search checks files based on query parameters

Request Information

URI Parameters

NameDescriptionTypeAdditional information
startDate

date

Required

endDate

date

Required

pageNumber

integer

Required

pageSize

integer

Required

sortField

string

Required

desc

boolean

Required

Body Parameters

None.

Response Information

Resource Description

CheckInquiryFileResultViewModel

CheckInquiryFileResultViewModel
NameDescriptionTypeAdditional information
CheckFileDetail

Collection of CheckInquiryFileDetailResultViewModel

None.

Total

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "checkFileDetail": [
    {
      "fileName": "sample string 1",
      "created": "2024-10-13T16:24:35.2909067-04:00",
      "fileSize": 3
    },
    {
      "fileName": "sample string 1",
      "created": "2024-10-13T16:24:35.2909067-04:00",
      "fileSize": 3
    }
  ],
  "total": 1
}

application/xml, text/xml

Sample:
<CheckInquiryFileResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels.Checks">
  <CheckFileDetail>
    <CheckInquiryFileDetailResultViewModel>
      <Created>2024-10-13T16:24:35.2909067-04:00</Created>
      <FileName>sample string 1</FileName>
      <FileSize>3</FileSize>
    </CheckInquiryFileDetailResultViewModel>
    <CheckInquiryFileDetailResultViewModel>
      <Created>2024-10-13T16:24:35.2909067-04:00</Created>
      <FileName>sample string 1</FileName>
      <FileSize>3</FileSize>
    </CheckInquiryFileDetailResultViewModel>
  </CheckFileDetail>
  <Total>1</Total>
</CheckInquiryFileResultViewModel>