WEii-API (3.0.0)

Download OpenAPI specification:Download

Deze API berekent de WEii van een gebouw op basis van het werkelijke, gemeten energiegebruik en het gebruiksoppervlakte van het gebouw.

Om de API te gebruiken heeft u een API-key nodig. Deze kunt u hier aanvragen.

Voor documentatie van de API versie 1.0.0 klik hier.

/building

Authorizations:

bearerAuth

Request Body schema: application/json

year required	integer >= 2017 Year of measurement of all meters.
required	object The building for which the WEii should be calculated.

Responses

Request samples

Payload

Content type

application/json

{"year": 2017,
"building": {"buildingName": "string",
"companyName": "string",
"address": {"postalCode": "1234AB",
"houseNumber": 1,
"houseNumberSuffix": "B",
"street": "string",
"city": "string"
},
"surfaces": [{"buildingType": "Restaurant",
"usableSurface": 1
}
],
"apartmentSurfaces": [1
],
"mainMeters": {"input": [{"energyType": "Elektriciteit",
"volume": 1
}
],
"output": [{"energyType": "Elektriciteit",
"volume": 1
}
]
},
"excludedEnergy": [{"energyType": "Elektriciteit",
"volume": 1
}
],
"climateCorrection": {"heatingEnergy": [{"energyType": "Elektriciteit",
"volume": 0
}
],
"solarEnergy": [0
]
}
}
}

Response samples

Content type

application/json

{"building": {"buildingName": "string",
"companyName": "string",
"address": {"postalCode": "1234AB",
"houseNumber": 1,
"houseNumberSuffix": "B",
"street": "string",
"city": "string",
"closestWeatherStation": "CABAUW",
"BAGData": {"addressableObjectIndentificationId": "string",
"surface": 0
},
"externalAPICallSuccess": {"geoLocationCallSuccess": true,
"BAGCallSuccess": true
}
},
"surfaces": [{"buildingType": "Restaurant",
"usableSurface": 1
}
]
},
"WEii": {"WEii": 0,
"class": "WENG",
"weightedClassLimits": {"weng": 0,
"parisProof": 0,
"veryEfficient": 0,
"efficient": 0,
"average": 0,
"inEfficient": 0
},
"energyIn": 0,
"energyOut": 0,
"energyExcluded": 0,
"energyClimateCorrection": 0,
"energyTotal": 0,
"usableSurfaceTotal": 0
},
"other": {"year": 0,
"WEiiGross": 0,
"WEiiGas": 0,
"WEiiCO2": 0,
"WEiiCoverage": 0,
"WEiiUtilization": 0,
"CO2Emission": 0,
"WEiiAverageReference": 0
},
"notifications": ["string"
]
}