Skip to main content

RemotePatrimonyIndicatorsFilters

allAssetsboolean

This parameter is part of authorization mechanism. Should not be filled.

Example: true
authorizedAssetCodesstring[]

This parameter is part of authorization mechanism. Should not be filled.

Example: ["ABC","DEF"]
buildingGroupCodesstring[]

Filter to keep assets BUILDING that belong to buildings groups.

Example: ["ABC","DEF"]
certificateCodesinteger<int64>

Filter to keep assets that have expiration date which is at most n years in the past of requested date.

Example: 3
holderTypeCodesstring[]

List of types concerned by indicators.

Example: ["BUILDING","RENTED_UNIT"]
minimumEffectiveDatestring

Filter to keep assets that have effective date after this date (strictly after).

Example: 2023-10-28
missingPropertiesstring[]

Filter to keep assets that DO not have data on properties OR have data but none valid at requestedDate.

Example: ["DPE","OPEX"]
organizationCodestring

Code of client. Will be filled with parameter.

Example: STONAL
properties object

Filter to keep assets that have these properties which have at least one value in List valid at requestedDate.

property name* string[]
  • Array [
    • string
  • ]
    • requestedDatestring

    Filter objects that are valid for this date (included). Filled with parameter.

    Example: 2023-10-25
    RemotePatrimonyIndicatorsFilters
    {
      "allAssets": true,
      "authorizedAssetCodes": [
        "ABC",
        "DEF"
      ],
      "buildingGroupCodes": [
        "ABC",
        "DEF"
      ],
      "certificateCodes": 3,
      "holderTypeCodes": [
        "BUILDING",
        "RENTED_UNIT"
      ],
      "minimumEffectiveDate": "2023-10-28",
      "missingProperties": [
        "DPE",
        "OPEX"
      ],
      "organizationCode": "STONAL",
      "properties": [
        "DPE",
        "OPEX"
      ],
      "requestedDate": "2023-10-25"
    }