API | VEKA Meldingen API (OpenAPI specificaties) |
|---|---|
Doel | Gegevens over een (historisch) ingediend energieprestatieattest opzoeken |
Locatie | Testomgeving: Details |
Toegang | Voor overheden, lokale besturen, … op basis van een vooraf afgesloten protocol (aanvraag: https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2294874204) |
Implementatie
API call | 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 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.
Door het toepassen van de verplichte en optionele zoekcriteria wordt de response beperkt en krijg je als afnemer enkel de energieprestatiecertificaten terug die voldoen aan alle opgegeven zoekcriteria.
Wanneer geen enkel certificaat voldoet aan je zoekcriteria, krijg je als afnemer een leeg resultaat terug.
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 energieattestnummer | String | |
gebouwId | GebouwID 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) | ? |
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 | ||
bestemming | ||
gebouwId | ||
gebouweenheidId | ||
adressen: … |
Voorbeeld van request
Voorbeeld van response
Succesvolle opzoeking (zie ref naar pagina beschrijving detail energieattest )
HTTP Code: 2xx (vb. 201)
Response: Bevestiging en uniek VEKA meldingsnummer
{
"externeReferte": "0-1234-ABCD",
"meldingsnummer": "2023-CV-K-1",
"message": "Melding 2023-CV-K-1 correct opgeladen."
}
Foutieve opzoeking
HTTP Code: 4xx (vb. 400, 404)
Response: Lijst van fouten gevonden in de melding
{
"timestamp": "2023-07-03T10:45:31.508+02:00",
"status": 500,
"error": "Internal Server Error",
"path": "/epcnr-api/energie-attesten"
}