EHPA API
Documentation
Quality Label
EHPA API
Quality Label
Endpoint
Any call to the module needs to use the base URL https://api.dev.ehpa.org/ql.
/distributor/details
Retrieves details on a given distributor.
Arguments:
distributor: int
The internal distributor ID. See /distributor/list.
Required
Returns JSON data:
id: int
The internal distributor ID.
title: string
The distributor's name.
street: string
The distributor's street address.
zip: string
The distributor's zip code.
place: string
The distributor's place.
country: string
The distributor's country code as defined by ISO 3166-1 alpha-2.
labelCount: int
The amount of valid quality labels the distributor holds.
/distributor/list
Retrieves a list of distributors. The scope is limited to those holding valid labels.
No arguments.
Returns JSON data:
id: int
The internal distributor ID.
title: string
The distributor's name.
/heatPumpType/list
Retrieves heat pump types.
No arguments.
Returns JSON data:
id: int
The internal heat pump type ID.
title: string
The heat pump type as human-readable string.
/label/details
Retrieves details on a given quality label.
Arguments:
label: int
The internal label ID. See /label/list.
Required
Returns JSON data:
id: int
The internal label ID.
title: string
The label title which corresponds to the official label ID formatted as XX-HP-YYYYY.
issueDate: int
The label's issue date formatted as UNIX timestamp.
expirationDate: int
The label's expiration date formatted as UNIX timestamp.
distributor: int
The internal distributor ID. See /distributor/list.
nationalCommission: int
The internal national commission ID. See /nationalCommission/list.
id: int
The internal heat pump type ID. See /heatPumpType/list.
/label/list
Retrieves a list of quality labels. The scope is limited to valid labels.
Arguments:
distributor: int
The distributor ID of the labels to be retrieved. See /distributor/list.
Optional
heatPumpType: int
The heat pump type ID of the labels to be retrieved. See /heatPumpType/list.
Optional
nationalCommission: int
The national commission ID of the labels to be retrieved. See /nationalCommission/list.
Optional
searchTerm: string
The search term which is matched against the distributors' title, the labels' titles and the models' titles.
Optional
Returns JSON data:
id: int
The internal label ID.
title: string
The label title which corresponds to the official label ID formatted as XX-HP-YYYYY.
distributor: int
The internal distributor ID. See /distributor/list.
nationalCommission: int
The internal national commission ID. See /nationalCommission/list.
id: int
The internal heat pump type ID. See /heatPumpType/list.
issueDate: int
The label's issue date formatted as UNIX timestamp.
expirationDate: int
The label's expiration date formatted as UNIX timestamp.
/label/pdf
Retrieves the quality label PDF file.
Arguments:
label: int
The internal label ID. See /label/list.
Required
Returns a PDF file.
/model/details
Retrieves details on a given model.
Arguments:
model: int
The internal model ID. See /model/list.
Required
Returns JSON data:
id: int
The internal label ID.
title: string
The model title.
label: int
The internal ID of the label the model is assigned to. See /label/list.
distributor: int
The internal ID of the distributor the model is assigned to. See /distributor/list.
nationalCommission: int
The internal ID of the national commission the label is assigned to. See /nationalCommission/list.
heatPumpType: int
The internal heat pump type ID. See /heatPumpType/list.
/model/list
Retrieves a list of models. The scope is limited to models assigned to valid labels.
Arguments:
distributor: int
The distributor ID of the labels to be retrieved. See /distributor/list.
Optional
heatPumpType: int
The heat pump type ID of the labels to be retrieved. See /heatPumpType/list.
Optional
nationalCommission: int
The national commission ID of the labels to be retrieved. See /nationalCommission/list.
Optional
searchTerm: string
The search term which is matched against the distributors' title, the labels' titles and the models' titles.
Optional
Returns JSON data:
id: int
The internal label ID.
title: string
The model title.
label: int
The internal ID of the label the model is assigned to. See /label/list.
distributor: int
The internal ID of the distributor the label is assigned to. See /distributor/list.
nationalCommission: int
The internal ID of the national commission the label is assigned to. See /nationalCommission/list.
id: int
The internal heat pump type ID. See /heatPumpType/list.
/nationalCommission/details
Retrieves details on a given national commission.
Arguments:
nationalCommission: int
The internal national commission ID. See /nationalCommission/list.
Required
Returns JSON data:
id: int
The internal national commission ID.
title: string
The national commission's name.
street: string
The national commission's street address.
zip: string
The national commission's zip code.
place: string
The national commission's place.
country: string
The national commission's country code as defined by ISO 3166-1 alpha-2.
labelCount: int
The amount of valid quality labels the national commission has issued.
/nationalCommission/list
Retrieves a list of national commission. The scope is limited to those having issued currently valid labels.
No arguments.
Returns JSON data:
id: int
The internal national commission ID.
title: string
The national commission's name.
Loading…
Loading the web debug toolbar…
Attempt #
Cancel