POST api/list/stats/tenantstats
Returns a list of totals for tenants with missing information
Request Information
URI Parameters
None.
Body Parameters
Collection of PmTenantListFilterDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TeamGroupIds | Collection of integer |
None. |
|
| BranchIds | Collection of integer |
None. |
|
| IdReceived | boolean |
None. |
|
| RightToRentStatus | Collection of string |
None. |
|
| ProofOfIdStatus | Collection of string |
None. |
|
| TenantReferenceStatus | Collection of string |
None. |
|
| RightToRentExpiryFrom | date |
None. |
|
| RightToRentExpiryTo | date |
None. |
|
| IncludeArchived | boolean |
None. |
|
| IncludeActiveTenancies | boolean |
None. |
|
| Sort | PMGroupSort |
None. |
|
| PageSize | integer |
None. |
|
| PageNumber | integer |
None. |
|
| Term | string |
None. |
|
| OrderByDescending | boolean |
None. |
|
| Name | string |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
[
{
"TeamGroupIds": [
1,
2
],
"BranchIds": [
1,
2
],
"IdReceived": true,
"RightToRentStatus": [
"sample string 1",
"sample string 2"
],
"ProofOfIdStatus": [
"sample string 1",
"sample string 2"
],
"TenantReferenceStatus": [
"sample string 1",
"sample string 2"
],
"RightToRentExpiryFrom": "2025-11-17T13:00:51.0639822Z",
"RightToRentExpiryTo": "2025-11-17T13:00:51.0639822Z",
"IncludeArchived": true,
"IncludeActiveTenancies": true,
"Sort": 0,
"PageSize": 1,
"PageNumber": 1,
"Term": "sample string 2",
"OrderByDescending": true,
"Name": "sample string 3"
},
{
"TeamGroupIds": [
1,
2
],
"BranchIds": [
1,
2
],
"IdReceived": true,
"RightToRentStatus": [
"sample string 1",
"sample string 2"
],
"ProofOfIdStatus": [
"sample string 1",
"sample string 2"
],
"TenantReferenceStatus": [
"sample string 1",
"sample string 2"
],
"RightToRentExpiryFrom": "2025-11-17T13:00:51.0639822Z",
"RightToRentExpiryTo": "2025-11-17T13:00:51.0639822Z",
"IncludeArchived": true,
"IncludeActiveTenancies": true,
"Sort": 0,
"PageSize": 1,
"PageNumber": 1,
"Term": "sample string 2",
"OrderByDescending": true,
"Name": "sample string 3"
}
]
Response Information
Resource Description
Collection of ListStatsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | string |
None. |
|
| Value | integer |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Name": "sample string 1",
"Value": 2
},
{
"Name": "sample string 1",
"Value": 2
}
]