GET api/deposit/schemes/{id}/groupings?searchText={searchText}&searchType={searchType}&pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

searchText

string

None.

searchType

SearchType

None.

pageSize

integer

Default value is 25

pageNumber

integer

Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfDepositGroupingDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of DepositGroupingDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "DateProtected": "2018-11-16T09:53:10.546784Z",
      "Amount": 2.0,
      "PrimaryTenant": "sample string 3",
      "Address": "sample string 4",
      "NumberOfDepositsProtected": 5,
      "TenancyEndDate": "2018-11-16T09:53:10.546784Z",
      "TenantRoleId": 7,
      "TenantGroupId": 8,
      "Id": 9
    },
    {
      "DateProtected": "2018-11-16T09:53:10.546784Z",
      "Amount": 2.0,
      "PrimaryTenant": "sample string 3",
      "Address": "sample string 4",
      "NumberOfDepositsProtected": 5,
      "TenancyEndDate": "2018-11-16T09:53:10.546784Z",
      "TenantRoleId": 7,
      "TenantGroupId": 8,
      "Id": 9
    }
  ]
}