POST api/list/pm/tenancy

Returns a list of Tenancies in PM

Request Information

URI Parameters

None.

Body Parameters

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

Name	Type	Additional 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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PmTenancyListFilterDataContract'.

application/json, text/json

Sample:

{
  "StartDateFrom": "2024-04-25T20:27:12.3775314Z",
  "StartDateTo": "2024-04-25T20:27:12.3775314Z",
  "EndDateFrom": "2024-04-25T20:27:12.3775314Z",
  "EndDateTo": "2024-04-25T20:27:12.3775314Z",
  "TeamGroupIds": [
    1,
    2
  ],
  "TenancyStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "TermTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "NoticeFromDate": "2024-04-25T20:27:12.3775314Z",
  "NoticeToDate": "2024-04-25T20:27:12.3775314Z",
  "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

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Tenancy.TenancySummaryListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of Dezrez.Core.DataContracts.External.Api.Lists.Tenancy.TenancySummaryListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "ServiceLevelName": "sample string 3",
      "Address": "sample string 4",
      "TenantPrimaryContactName": "sample string 5",
      "TenantGroupId": 6,
      "TenantPrimaryEmail": "sample string 7",
      "TenantPrimaryTelephone": "sample string 8",
      "LandlordPrimaryContactName": "sample string 9",
      "LandlordGroupId": 10,
      "LandlordPrimaryEmail": "sample string 11",
      "LandlordPrimaryTelephone": "sample string 12",
      "TenancyType": "sample string 13",
      "TenancyStatus": "sample string 14",
      "TenancyEndDate": "2024-04-25T20:27:12.3931549Z",
      "RentAmount": "sample string 15",
      "IssueNoticeDate": "2024-04-25T20:27:12.3931549Z"
    },
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "ServiceLevelName": "sample string 3",
      "Address": "sample string 4",
      "TenantPrimaryContactName": "sample string 5",
      "TenantGroupId": 6,
      "TenantPrimaryEmail": "sample string 7",
      "TenantPrimaryTelephone": "sample string 8",
      "LandlordPrimaryContactName": "sample string 9",
      "LandlordGroupId": 10,
      "LandlordPrimaryEmail": "sample string 11",
      "LandlordPrimaryTelephone": "sample string 12",
      "TenancyType": "sample string 13",
      "TenancyStatus": "sample string 14",
      "TenancyEndDate": "2024-04-25T20:27:12.3931549Z",
      "RentAmount": "sample string 15",
      "IssueNoticeDate": "2024-04-25T20:27:12.3931549Z"
    }
  ]
}