POST api/list/pm/tenants

Returns a list of Tenants in PM

Request Information

URI Parameters

None.

Body Parameters

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

Name	Type	Additional information
TeamGroupIds	Collection of integer	None.
BranchIds	Collection of integer	None.
IdReceived	boolean	None.
RightToRentStatus	Collection of string	None.
TenantReferenceStatus	Collection of string	None.
RightToRentExpiryFrom	date	None.
RightToRentExpiryTo	date	None.
IncludeArchived	boolean	None.
IncludeActiveTenancies	boolean	None.
Sort	Dezrez.Core.DataContracts.External.Api.Lists.PmLists.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"
  ],
  "TenantReferenceStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "RightToRentExpiryFrom": "2024-11-21T09:32:21.7344914Z",
  "RightToRentExpiryTo": "2024-11-21T09:32:21.7344914Z",
  "IncludeArchived": true,
  "IncludeActiveTenancies": true,
  "Sort": 0,
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 2",
  "OrderByDescending": true,
  "Name": "sample string 3"
}

Response Information

Resource Description

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

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.TenantListDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "PrimaryContactName": "sample string 3",
      "Email": "sample string 4",
      "EmailMarketingStatus": "sample string 5",
      "Telephone": "sample string 6",
      "TelephoneMarketingStatus": "sample string 7",
      "Address": "sample string 8",
      "GroupMembers": 9,
      "IdReceived": 10,
      "RightToRentReceived": 11,
      "TenantReferences": 12,
      "TenantReferenceStatus": "sample string 13",
      "ActiveTenanciesCount": 14,
      "RightToRentStatus": 15
    },
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "PrimaryContactName": "sample string 3",
      "Email": "sample string 4",
      "EmailMarketingStatus": "sample string 5",
      "Telephone": "sample string 6",
      "TelephoneMarketingStatus": "sample string 7",
      "Address": "sample string 8",
      "GroupMembers": 9,
      "IdReceived": 10,
      "RightToRentReceived": 11,
      "TenantReferences": 12,
      "TenantReferenceStatus": "sample string 13",
      "ActiveTenanciesCount": 14,
      "RightToRentStatus": 15
    }
  ]
}