API | VEKA |
|---|
EnergieAttesten API |
Doel | Gegevens over een (historisch) ingediend energieprestatieattest opzoeken |
|---|---|
Locatie | Testomgeving |
: https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten | |
Toegang | Voor overheden, lokale besturen, … op basis van een vooraf afgesloten protocol (aanvraag: |
|---|
locatie aanvraagformulier) en ontsloten via een PKI-certificaat | |
Technische informatie | (link naar github) |
|---|
| Inhoudsopgave |
|---|
Implementatie
...
...
POST /meldingen-api-a2a/extern/v1/meldingCentraleStooktoestellen
...
Beschrijving
...
API call voor het opzoeken van (historisch) ingediende energieattesten
Voor het ontvangen van specifieke gegevens van energieprestatieattesten (epb - aangifte, epc - bouw, epc - residentieel, epc - gemeendeel, epc - niet residentieel) moet kan men een opzoeking doen aan de hand van verplichte en optionele zoekcriteria.
Het zoekcriterium “Reden” is steeds verplicht en stemt overeen met het doeleinde van het gebruik van de API.
Daarnaast is ook minstens één van onderstaande hoofdzoekcriteria vereist:
energieAttestNummer
Adres (minimaal gemeente, straat en huisnummer)
Attestnummer
GebouwID
GebouweenheidID
Naast deze vereiste zoekcriteria, kunnen andere optionele zoekcriteria toegevoegd worden. Op basis van het vastgelegde protocol met het VEKA kan het zijn dat bepaalde optionele zoekcriteria toch verplicht worden. Bij configuratie van de aansluiting zal dit duidelijk meegedeeld worden.
...
Overzicht van de zoekcriteria
Veldnaam | Omschrijving | Toegelaten waarden | Veldtype |
gemeente | Gemeentenaam | String | |
straat | Straatnaam | String | |
huisnummer | Huisnummer | String | |
busnummer | Busnummer |
| String |
postcode | Postcode |
| ? |
energieAttestNummer |
Uniek energie attestnummer | String | |
gebouwId | GebouwID uit het gebouwregister van de Vlaamse overheid |
? | ||
gebouweenheidId | GebouwEenheidID uit het gebouwregister van de Vlaamse overheid |
https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2321580033/Locatie+van+een+stooktoestel#API-endpoints (pagina generiek maken)
? | |||
datumIngediendVanaf | De vroegste indiendatum waarvoor een energieattest gezocht wordt | ||
geldig | Indictie of al dan niet enkel nog geldige energieattesten opgezocht mogen worden | Keuze:
| Boolean |
reden | |||
|
Overzicht van de antwoordvelden
Veldnaam | Omschrijving | Mogelijke waarden (indien van toepassing) |
id | unieke interne technische identificator van het energieattest | |
energieAttestNummer | unieke energieattestnummer zoals vermeld op het energieprestatiecertificaat of de aangifte | |
energieAttestStatus | status van het energieattest | ‘geldig’, ‘vervangen’, ‘vervallen’, Geannuleerd?, Ingetrokken?, Actief? of Inactief? |
datumIngediend | datum van indienen van het energieattest |
|
datumGeldigheid | datum tot wanneer het energieattest geldig is |
|
isEnergieAttestLaatstGeldige | indicatie of het betreffende energieattest het laatst geldende is overkoepelend alle subdomeinen | ‘true’ of ‘false’ |
energieAttestType | indicatie of het energieattest werd opgesteld in kader van bestaande bouw (EPC) of nieuwbouw/renovatie (EPC) | ‘EPC’ of ‘EPB’ |
hoofdBestemming | ‘residentieel’, ‘niet-residentieel’, ‘gemeenschappelijk deel’ of ‘gemengd’ | |
bestemming |
‘kantoor’, ‘handelszaak’, ‘hotel, b&b, …’, ‘restaurant, café, cafetaria’, ‘kleuter- of lager onderwijs’, ‘secundair onderwijs’, ‘hoger onderwijs’, ‘sporthal’, ‘zwembad’, ‘sport en recreatie - overige’, ‘ziekenhuis’, ‘woonzorgcentrum', ‘medische (groeps)praktijk’, ‘gezondheidszorg- en welzijnszorginstelling - overige’, ‘kinderdagverblijf of buitenlandse schoolopvang’, ‘wijkhuis/buurtcentrum’, ‘jeugdbeweging’, maatschappelijke dienstverlening - overige’, ‘bibliotheek’, ‘evenementenhal’, ‘museum’, ‘cinema’, ‘gebouw voor podiumkunsten’, ‘cultuur- of bijeenkomstgebouw - overige’, ‘luchthaven’, ‘postkantoor’, ‘gemeentehuis', ‘stationsgebouw’, ‘politiekantoor’, ‘brandweerkazerne’, ‘gerechtshof’, ‘gevangenis of instelling’, ‘openbare diensten - overige’, ‘andere’ | ||
gebouwId | ||
gebouweenheidId | ||
adressen: |
adresId straat huisnummer gemeente postcode | Lijst van adressen gekoppeld aan het energieprestatiecertificaat, met per adres duiding van ‘adresId’, ‘gemeente’, ‘straat’, ‘huisnummer’, ('busnummer') en ‘postcode’ |
Voorbeelden van een request
...
| Codeblok | ||
|---|---|---|
| ||
[
{
"id": "dbabf3c0-1b31-40dc-9392-b7251776f99a",
"energieAttestNummer": "20230607-0010115737-NR-3",
"energieAttestStatus": "geldig",
"datumIngediend": "2023-06-07",
"datumGeldigheid": "2028-06-07",
"energieAttestType": "EPC",
"hoofdBestemming": "niet-residentieel",
"bestemming": "lager onderwijs",
"adressen": [
{
"straat": "Zandstraat",
"huisnummer": "99",
"gemeente": "Zoersel",
"postcode": "2980",
"adresId": "11667839"
}
],
"gebouweenheidId": "101157379",
"gebouwId": "101148109",
"detail": {
"id": "dbabf3c0-1b31-40dc-9392-b7251776f99a",
"url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c0-1b31-40dc-9392-b7251776f99a"
}
}
] |
Foutieve opzoeking
HTTP Code: 4xx (vb. 400, 404)
Response: Lijst van fouten gevonden in de melding
| Codeblok | ||
|---|---|---|
| ||
{
"timestamp": "2023-07-03T10:45:31.508+02:00",
"status": 500,
"error": "Internal Server Error",
"path": "/epcnr-api/energie-attesten"
} |