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

Request Information

URI Parameters

Name	Type	Additional information
id	integer	Required
pageSize	integer	Default value is 25
pageNumber	integer	Default value is 1

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfDepositGroupingDataContract

Name	Type	Additional 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": "2025-10-25T01:04:58.2068858Z",
      "Amount": 2.0,
      "PrimaryTenant": "sample string 3",
      "Address": "sample string 4",
      "NumberOfDepositsProtected": 5,
      "TenancyEndDate": "2025-10-25T01:04:58.2068858Z",
      "TenantRoleId": 7,
      "TenantGroupId": 8,
      "LettingRoleId": 9,
      "Id": 10
    },
    {
      "DateProtected": "2025-10-25T01:04:58.2068858Z",
      "Amount": 2.0,
      "PrimaryTenant": "sample string 3",
      "Address": "sample string 4",
      "NumberOfDepositsProtected": 5,
      "TenancyEndDate": "2025-10-25T01:04:58.2068858Z",
      "TenantRoleId": 7,
      "TenantGroupId": 8,
      "LettingRoleId": 9,
      "Id": 10
    }
  ]
}