DocumentPurpose
objectRepresents the purposes of a document.
codestring
descriptionstring
Example
EnergyEfficiency
objectRepresents information about energy efficiency in the API.
arrow
One OfSmall arrow image which represents the efficiency class.
Imageobject
An image and its properties.
Show Child Parameters
arrow_alternative
One OfSmall alternative arrow image which represents the efficiency class.
Imageobject
An image and its properties.
Show Child Parameters
category_codestring
The category code of the energy efficiency category
classobjectrequired
Show Child Parameters
imageobject
An image and its properties.
Show Child Parameters
Example
EnergyEfficiencyClass
objecthex_colorstringDEPRECATED
The hexadecimal color code of the energy efficiency class to create your own arrows. This property is deprecated and is removed after version 7.
textstringrequired
Name of this facet.
Example
Facet
objectnamestringrequired
Name of this facet.
termsarray[object]required
List of terms.
Show Child Parameters
Example
FacetTerm
objectactiveboolean
Whether that facet has been used for the current response or not.
countintegerrequired
Amount of items with that facet.
namestring
Translated name.
slugstring
termstringrequired
Term identifier.
Example