POST api/list/pm/tenants

Returns a list of Tenants in PM

Request Information

URI Parameters

None.

Body Parameters

PmTenantListFilterDataContract
NameDescriptionTypeAdditional information
TeamGroupIds

Collection of integer

None.

BranchIds

Collection of integer

None.

IdReceived

boolean

None.

RightToRentStatus

Collection of string

None.

RightToRentExpiryFrom

date

None.

RightToRentExpiryTo

date

None.

IncludeArchived

boolean

None.

PageSize

integer

None.

PageNumber

integer

None.

Term

string

None.

OrderByDescending

boolean

None.

Name

string

None.

Request Formats

application/json, text/json

Sample:
{
  "TeamGroupIds": [
    1,
    2
  ],
  "BranchIds": [
    1,
    2
  ],
  "IdReceived": true,
  "RightToRentStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "RightToRentExpiryFrom": "2020-08-11T01:36:52.3179765Z",
  "RightToRentExpiryTo": "2020-08-11T01:36:52.3179765Z",
  "IncludeArchived": true,
  "PageSize": 1,
  "PageNumber": 1,
  "Term": "sample string 2",
  "OrderByDescending": true,
  "Name": "sample string 3"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PagedCollectionDataContractOfTenantListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of 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",
      "Telephone": "sample string 5",
      "Address": "sample string 6",
      "GroupMembers": 7,
      "IdReceived": 8,
      "RightToRentReceived": 9
    },
    {
      "GroupId": 1,
      "GroupName": "sample string 2",
      "PrimaryContactName": "sample string 3",
      "Email": "sample string 4",
      "Telephone": "sample string 5",
      "Address": "sample string 6",
      "GroupMembers": 7,
      "IdReceived": 8,
      "RightToRentReceived": 9
    }
  ]
}