POST api/list/stats/tenancystats

Returns a list of values of the queries sent through

Request Information

URI Parameters

None.

Body Parameters

Collection of Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmTenancyListFilterDataContract
NameDescriptionTypeAdditional information
StartDateFrom

date

None.

StartDateTo

date

None.

EndDateFrom

date

None.

EndDateTo

date

None.

TeamGroupIds

Collection of integer

None.

TenancyStatuses

Collection of string

None.

TermTypes

Collection of string

None.

BranchIds

Collection of integer

None.

NoticeFromDate

date

None.

NoticeToDate

date

None.

Sort

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmTenancyListSort

None.

ServiceLevels

Collection of string

None.

RentDuePeriod

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.RentDueType

None.

TenancyRoleIds

Collection of integer

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:
[
  {
    "StartDateFrom": "2024-10-08T10:13:52.000836Z",
    "StartDateTo": "2024-10-08T10:13:52.000836Z",
    "EndDateFrom": "2024-10-08T10:13:52.000836Z",
    "EndDateTo": "2024-10-08T10:13:52.000836Z",
    "TeamGroupIds": [
      1,
      2
    ],
    "TenancyStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "TermTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "BranchIds": [
      1,
      2
    ],
    "NoticeFromDate": "2024-10-08T10:13:52.000836Z",
    "NoticeToDate": "2024-10-08T10:13:52.000836Z",
    "Sort": 0,
    "ServiceLevels": [
      "sample string 1",
      "sample string 2"
    ],
    "RentDuePeriod": 0,
    "TenancyRoleIds": [
      1,
      1
    ],
    "PageSize": 1,
    "PageNumber": 1,
    "Term": "sample string 1",
    "OrderByDescending": true,
    "Name": "sample string 2"
  },
  {
    "StartDateFrom": "2024-10-08T10:13:52.000836Z",
    "StartDateTo": "2024-10-08T10:13:52.000836Z",
    "EndDateFrom": "2024-10-08T10:13:52.000836Z",
    "EndDateTo": "2024-10-08T10:13:52.000836Z",
    "TeamGroupIds": [
      1,
      2
    ],
    "TenancyStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "TermTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "BranchIds": [
      1,
      2
    ],
    "NoticeFromDate": "2024-10-08T10:13:52.000836Z",
    "NoticeToDate": "2024-10-08T10:13:52.000836Z",
    "Sort": 0,
    "ServiceLevels": [
      "sample string 1",
      "sample string 2"
    ],
    "RentDuePeriod": 0,
    "TenancyRoleIds": [
      1,
      1
    ],
    "PageSize": 1,
    "PageNumber": 1,
    "Term": "sample string 1",
    "OrderByDescending": true,
    "Name": "sample string 2"
  }
]

Response Information

Resource Description

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Stats.ListStatsDataContract
NameDescriptionTypeAdditional 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
  }
]