POST api/list/pm/tenancy

Returns a list of Tenancies in PM

Request Information

URI Parameters

None.

Body Parameters

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

PmTenancyListSort

None.

ServiceLevels

Collection of string

None.

PageSize

integer

None.

PageNumber

integer

None.

Term

string

None.

OrderByDescending

boolean

None.

Name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "StartDateFrom": "2020-12-02T12:48:02.8459682Z",
  "StartDateTo": "2020-12-02T12:48:02.8459682Z",
  "EndDateFrom": "2020-12-02T12:48:02.8459682Z",
  "EndDateTo": "2020-12-02T12:48:02.8459682Z",
  "TeamGroupIds": [
    1,
    2
  ],
  "TenancyStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "TermTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "BranchIds": [
    1,
    2
  ],
  "NoticeFromDate": "2020-12-02T12:48:02.8615819Z",
  "NoticeToDate": "2020-12-02T12:48:02.8615819Z",
  "Sort": 0,
  "ServiceLevels": [
    "sample string 1",
    "sample string 2"
  ],
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 1",
  "OrderByDescending": true,
  "Name": "sample string 2"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedCollectionDataContractOfTenancySummaryListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of TenancySummaryListDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "Address": "sample string 3",
      "TenantPrimaryContactName": "sample string 4",
      "TenantGroupId": 5,
      "TenantPrimaryEmail": "sample string 6",
      "TenantPrimaryTelephone": "sample string 7",
      "LandlordPrimaryContactName": "sample string 8",
      "LandlordGroupId": 9,
      "LandlordPrimaryEmail": "sample string 10",
      "LandlordPrimaryTelephone": "sample string 11",
      "TenancyType": "sample string 12",
      "TenancyStatus": "sample string 13",
      "TenancyEndDate": "2020-12-02T12:48:02.8928374Z",
      "RentAmount": "sample string 14",
      "IssueNoticeDate": "2020-12-02T12:48:02.8928374Z"
    },
    {
      "Id": 1,
      "PropertyLettingRoleId": 2,
      "Address": "sample string 3",
      "TenantPrimaryContactName": "sample string 4",
      "TenantGroupId": 5,
      "TenantPrimaryEmail": "sample string 6",
      "TenantPrimaryTelephone": "sample string 7",
      "LandlordPrimaryContactName": "sample string 8",
      "LandlordGroupId": 9,
      "LandlordPrimaryEmail": "sample string 10",
      "LandlordPrimaryTelephone": "sample string 11",
      "TenancyType": "sample string 12",
      "TenancyStatus": "sample string 13",
      "TenancyEndDate": "2020-12-02T12:48:02.8928374Z",
      "RentAmount": "sample string 14",
      "IssueNoticeDate": "2020-12-02T12:48:02.8928374Z"
    }
  ]
}