POST api/list/pm/properties

Used to return a list of properties in PM

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
ServiceLevels	Collection of string	None.
MissingCertificateAndLicencesTypes	Collection of string	None.
TeamGroupIds	Collection of integer	None.
BranchIds	Collection of integer	None.
Sort	PmPropertyListSort	None.
PageSize	integer	None.
PageNumber	integer	None.
Term	string	None.
OrderByDescending	boolean	None.
Name	string	None.

Request Formats

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
  ],
  "Sort": 0,
  "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

PagedCollectionDataContractOfPropertiesListDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of 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",
      "ActiveTenancies": 6,
      "EpcStatus": "sample string 7",
      "GasSafetyStatus": "sample string 8"
    },
    {
      "PropertyId": 1,
      "Address": "sample string 2",
      "ServiceLevel": "sample string 3",
      "LandlordGroupId": 4,
      "LandlordPrimaryContactName": "sample string 5",
      "ActiveTenancies": 6,
      "EpcStatus": "sample string 7",
      "GasSafetyStatus": "sample string 8"
    }
  ]
}