Allowed values for installation profile

Installation properties

The POST /v2/profile/attributes allows end-users to provide information about the demographics and layout of the property and energy installation of the end user.

The available attributes and the allowed values that are relevant for each attribute are described in the table below:

ParameterValueCode
Property types (PropertyType)DetachedPT.01
Semi-detachedPT.02
BungalowPT.03
TerracedPT.04
End-terracePT.05
FlatPT.06
Property sizes (PropertySize)1 bedroomPS.01
2 bedroomPS.02
3 bedroomPS.03
4+bedroomPS.04
Property ages (PropertyAge)pre-1919PA.01
1920-1975PA.02
1976-1999PA.03
post-2000PA.04
Property ownership (Ownership)OwnedOWN.01
RentedOWN.02
Number of occupants (Occupants)1OCC.01
2OCC.02
3OCC.03
4OCC.04
5+OCC.05
Occupant types (OccupantType)StudentsOT.01
Working adultsOT.02
At home adultsOT.03
Young familyOT.04
Older familyOT.05
RetireesOT.06
Space heating types (SpaceHeating)Gas boilerSH.01
Electric storageSH.02
Electric radiatorsSH.03
Full Electric Heat pumpSH.04
Oil boilerSH.05
SolarSH.06
OtherSH.07
Hybrid Heat Pump & Gas BoilerSH.08
District heatingSH.09
Wood pelletSH.10
Water heating types (WaterHeating)Gas boilerWH.01
ElectricWH.02
Oil boilerWH.03
Sun BoilerWH.04
OtherWH.05
Stove heating types (StoveHeating)No stoveSTH.00
GasSTH.01
ElectricSTH.02
OilSTH.03
OtherSTH.04
Grill heating types (GrillHeating)No grillGH.00
GasGH.01
ElectricGH.02
OilGH.03
OtherGH.04
Oven heating types (OvenHeating)No ovenOH.00
GasOH.01
ElectricOH.02
OilOH.03
OtherOH.04
Space heating exchanger types (SpaceHeatingExchangerType)RadiatorsSHET.00
FloorSHET.01
Photovoltaic solar power (Photovoltaic)YesSOL.01
NoSOL.02

Retrieve supported installation profile attributes

CE-API provides the ability for the app developers to retrieve the currently supported profile attributes via the Get profile properties endpoint with a call that would look like:

GET /v2/profile/properties
Authorization: Bearer <access_token>

that will return a response like the one described below. This response contains both the allowed attribute codes that are applicable for every property attribute and also the list of allowed appliances that can be defined by an end-user.

{
  "PropertyType": [
    "PT.01",
    "PT.02",
    "PT.03",
    "PT.04",
    "PT.05",
    "PT.06"
  ],
  "PropertySize": [
    "PS.01",
    "PS.02",
    "PS.03",
    "PS.04"
  ],
  "PropertyAge": [
    "PA.01",
    "PA.02",
    "PA.03",
    "PA.04"
  ],
  "Ownership": [
    "OWN.01",
    "OWN.02"
  ],
  "Occupants": [
    "OCC.01",
    "OCC.02",
    "OCC.03",
    "OCC.04",
    "OCC.05"
  ],
  "OccupantType": [
    "OT.01",
    "OT.02",
    "OT.03",
    "OT.04",
    "OT.05",
    "OT.06"
  ],
  "SpaceHeating": [
    "SH.01",
    "SH.02",
    "SH.03",
    "SH.04",
    "SH.05",
    "SH.06",
    "SH.07",
    "SH.08",
    "SH.09",
    "SH.10"
  ],
  "WaterHeating": [
    "WH.01",
    "WH.02",
    "WH.03",
    "WH.04",
    "WH.05",
    "WH.06",
    "WH.07"
  ],
  "StoveHeating": [
    "STH.00",
    "STH.01",
    "STH.02",
    "STH.04"
  ],
  "GrillHeating": [
    "GH.00",
    "GH.01",
    "GH.02",
    "GH.04"
  ],
  "OvenHeating": [
    "OH.00",
    "OH.01",
    "OH.02",
    "OH.04"
  ],
  "Photovoltaic": [
    "SOL.01",
    "SOL.02"
  ],
  "Appliances": [
    "A.01",
    "A.02",
    "A.03",
    "A.04",
    "A.05",
    "A.06",
    "A.07",
    "A.08",
    "A.09",
    "A.10",
    "A.11",
    "A.12",
    "A.13",
    "A.14",
    "A.15",
    "A.16",
    "A.17",
    "A.18",
    "A.19",
    "A.20",
    "A.21",
    "A.22",
    "A.23",
    "A.24",
    "A.25",
    "A.26",
    "A.27",
    "A.28",
    "A.29",
    "A.30"
  ]
}

Appliances

The list of supported appliances that can be specified by an end-user when Managing installation profile information are specified in the table below. Each one of the listed appliances is mapped with a Disaggregation Activity which is described in the Disaggregation Categories Report.

The list of supported appliances can be also retrieved from the GET /v2/profile/properties CE-API endpoint as described in the Retrieve supported installation profile attributes.
The definition of each code along with their supported metadata can be retrieved from the GET /v2/appliances/definitions endpoint that is described in detail in the Retrieve definition information for appliance metadata section.

CodeAppliance identifierDescription
A.01refrigeratorFridge
A.02freezerFreezer
A.03fridgeComboCombi fridge / freezer
A.04ovenOven
A.05grillGrill
A.06hobHob
A.07microwaveMicrowave
A.08kettleKettle
A.09toasterToaster
A.10dishWasherDishwasher
A.11washingMachineWashing Machine
A.12tumbleDryerTumble Dryer
A.13ironIron
A.14TVTV
A.15dvdDVD or Bluray
A.16cableBoxDigital TV Box
A.17gameConsoleGames Console
A.18computerComputer
A.19tabletTablet
A.20electricShowerElectric Shower
A.21electricVehicleEV Charger
A.22poolPumpSwimming Pool
A.23saunaSauna
A.24immersionHeaterImmersion Heater
A.25airConditionAir Conditioning
A.26infraredPanelsInfrared panels
A.27closeInBoilerClose-in boiler
A.28instantBoilingWaterTapInstant boiling water tap
A.29batteryEnergyStorageSystemBattery Energy Storage System (BESS)
A.30heatPumpHeat Pump

Metadata of appliances

As already mentioned the POST /v2/profile/attributes allows end-users to provide additional metadata which helps to identify the appliance in their environment.

The metadata information that is supported differs per type of appliance. CE-API provides an endpoint to parse the possible metadata fields that are applicable per appliance as described in the section below.

Retrieve definition information for appliance metadata

The GET /v2/appliances/definitions endpoint returns a list with the possible metadata fields per appliance and can be used to generate a form
that end-users can use to provide information about their appliances. Calling this endpoint might look like this:

GET /v2/appliances/definitions
Authorization: Bearer <access_token>

The response will look something as shown below:

{
  "status": "ok",
  "data": {
    "A.01": {
      "description": "Fridge",
      "identifier": "refrigerator"
    },
    "A.02": {
      "description": "Freezer",
      "identifier": "freezer"
    },
    "A.03": {
      "description": "Combi fridge / freezer",
      "identifier": "fridgeCombo"
    },
    "A.04": {
      "description": "Oven",
      "identifier": "oven"
    },
    "A.05": {
      "description": "Grill",
      "identifier": "grill"
    },
    "A.06": {
      "description": "Hob",
      "identifier": "hob"
    },
    "A.07": {
      "description": "Microwave",
      "identifier": "microwave"
    },
    "A.08": {
      "description": "Kettle",
      "identifier": "kettle"
    },
    "A.09": {
      "description": "Toaster",
      "identifier": "toaster"
    },
    "A.10": {
      "description": "Dishwasher",
      "identifier": "dishwasher",
      "attributes": [
        {
          "attributeName": "applianceAge",
          "allowedValues": {
            "AA.01": "new",
            "AA.02": "not-so-new",
            "AA.03": "old"
          }
        },
        {
          "attributeName": "applianceType",
          "allowedValues": {
            "DT.01": "full-width",
            "DT.02": "half-width",
            "DT.03": "over-the-counter"
          }
        },
        {
          "attributeName": "applianceVolume",
          "allowedValues": {
            "AV.01": "small",
            "AV.02": "medium",
            "AV.03": "large"
          }
        },
        {
          "attributeName": "brand"
        },
        {
          "attributeName": "description"
        }
      ]
    },
    "A.11": {
      "description": "Washing Machine",
      "identifier": "washingMachine",
      "attributes": [
        {
          "attributeName": "applianceAge",
          "allowedValues": {
            "AA.01": "new",
            "AA.02": "not-so-new",
            "AA.03": "old"
          }
        },
        {
          "attributeName": "applianceType",
          "allowedValues": {
            "WT.01": "front-load",
            "WT.02": "top-load"
          }
        },
        {
          "attributeName": "applianceVolume",
          "allowedValues": {
            "AV.01": "small",
            "AV.02": "medium",
            "AV.03": "large"
          }
        },
        {
          "attributeName": "brand"
        },
        {
          "attributeName": "description"
        }
      ]
    },
    "A.12": {
      "description": "Tumble Dryer",
      "identifier": "tumbleDryer"
    },
    "A.13": {
      "description": "Iron",
      "identifier": "iron"
    },
    "A.14": {
      "description": "TV",
      "identifier": "TV"
    },
    "A.15": {
      "description": "DVD or Bluray",
      "identifier": "dvd"
    },
    "A.16": {
      "description": "Digital TV Box",
      "identifier": "cableBox"
    },
    "A.17": {
      "description": "Games Console",
      "identifier": "gameConsole"
    },
    "A.18": {
      "description": "Computer",
      "identifier": "computer"
    },
    "A.19": {
      "description": "Tablet",
      "identifier": "tablet"
    },
    "A.20": {
      "description": "Electric Shower",
      "identifier": "electricShower"
    },
    "A.21": {
      "description": "EV Home Charger",
      "identifier": "electricVehicle"
    },
    "A.22": {
      "description": "Swimming Pool",
      "identifier": "poolPump"
    },
    "A.23": {
      "description": "Sauna",
      "identifier": "sauna"
    },
    "A.24": {
      "description": "Immersion Heater",
      "identifier": "immersionHeater"
    },
    "A.25": {
      "description": "Air Conditioning",
      "identifier": "airCondition"
    },
    "A.26": {
      "description": "Infrared panels",
      "identifier": "infraredPanels"
    },
    "A.27": {
      "description": "Close-in boiler",
      "identifier": "closeInBoiler"
    },
    "A.28": {
      "description": "Instant boiling water tap",
      "identifier": "instantBoilingWaterTap"
    },
    "A.29": {
      "description": "Battery Energy Storage System",
      "identifier": "batteryEnergyStorageSystem",
      "attributes": [
        {
          "attributeName": "batterySize"
        }
      ]
    },
    "A.30": {
      "description": "Heat Pump",
      "identifier": "heatPump",
      "attributes": [
        {
          "attributeName": "applianceSetup",
          "allowedValues": {
            "full-electric": "full-electric",
            "hybrid": "hybrid"
          }
        },
        {
          "attributeName": "applianceType",
          "allowedValues": {
            "air-to-air": "air-to-air",
            "air-to-water": "air-to-water",
            "water-to-water": "water-to-water",
            "ground-to-water": "ground-to-water",
            "exhaust-air": "exhaust-air"
          }
        }
      ]
    }
  }
}

As usual the status parameter indicates that the request was executed successfully. The data parameter contains a property for each appliance type and per appliance type an appliance definition object. The appliance definition consists of the following fields:

ParameterTypeDescription
descriptionStringA description of the appliance.
identifierStringA short string value identifying the appliance.
attributesListA list of appliance attribute objects describing additional fields that can be specified to describe the appliance.

The table below described the appliance attribute object.

πŸ“˜

Each attribute is either a free text field or a set of predefined values. If the attribute only accepts one of the predefined values the appliance attribute definition object contains an option allowedValues parameter describing the values that can be used for this field.

ParameterTypeDescription
attributeNameStringThe name of the attribute (for example description meaning the appliance has a metadata field containing an addition description).
allowedValuesObject (optional)An object containing the set of allowed values for this metadata field. The object contains key/ value attributes, where the key identifies the code and the value contains a short description ofthe allowed value.