POST api/list/pm/landlords

Returns a list of landlords in PM

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmLandlordListFilterDataContract
NameDescriptionTypeAdditional information
TeamGroupIds

Collection of integer

None.

BranchIds

Collection of integer

None.

HasBankAccount

boolean

None.

IdReceived

boolean

None.

IncludeArchived

boolean

None.

IncludeTenantFindTenanciesOnly

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:

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

application/json, text/json

Sample:
{
  "TeamGroupIds": [
    1,
    2
  ],
  "BranchIds": [
    1,
    2
  ],
  "HasBankAccount": true,
  "IdReceived": true,
  "IncludeArchived": true,
  "IncludeTenantFindTenanciesOnly": 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.LandlordListDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of Dezrez.Core.DataContracts.External.Api.Lists.Tenancy.LandlordListDataContract

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,
      "ActiveTenanciesCount": 11
    },
    {
      "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,
      "ActiveTenanciesCount": 11
    }
  ]
}