POST api/list/pm/properties

Used to return a list of properties in PM

Request Information

URI Parameters

None.

Body Parameters

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

Name	Type	Additional information
ServiceLevels	Collection of string	None.
MissingCertificateAndLicencesTypes	Collection of string	None.
TeamGroupIds	Collection of integer	None.
BranchIds	Collection of integer	None.
IncludeActiveTenancies	boolean	None.
Sort	Dezrez.Core.DataContracts.External.Api.Lists.PmLists.PmPropertyListSort	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:

{
  "ServiceLevels": [
    "sample string 1",
    "sample string 2"
  ],
  "MissingCertificateAndLicencesTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "TeamGroupIds": [
    1,
    2
  ],
  "BranchIds": [
    1,
    2
  ],
  "IncludeActiveTenancies": true,
  "Sort": 0,
  "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.PropertiesListDataContract

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

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "PropertyId": 1,
      "Address": "sample string 2",
      "ServiceLevel": "sample string 3",
      "LandlordGroupId": 4,
      "LandlordPrimaryContactName": "sample string 5",
      "ActiveTenanciesCount": 6,
      "EpcStatus": "sample string 7",
      "LegionellaStatus": "sample string 8",
      "ElectricalSafetyStatus": "sample string 9",
      "GasSafetyStatus": "sample string 10"
    },
    {
      "PropertyId": 1,
      "Address": "sample string 2",
      "ServiceLevel": "sample string 3",
      "LandlordGroupId": 4,
      "LandlordPrimaryContactName": "sample string 5",
      "ActiveTenanciesCount": 6,
      "EpcStatus": "sample string 7",
      "LegionellaStatus": "sample string 8",
      "ElectricalSafetyStatus": "sample string 9",
      "GasSafetyStatus": "sample string 10"
    }
  ]
}