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) |
| Inhoudsopgave |
|---|
Implementatie
API call | resultaat van de call POST /meldingen-api-a2a/extern/v1/meldingCentraleStooktoestellen |
|---|---|
Beschrijving | API call voor het opzoeken van detailinformatie van een energieattest |
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:
...
Overzicht van de antwoordvelden
Veldnaam | Omschrijving |
Mogelijke waarden (indien van toepassing) |
id |
energieAttestNummer |
energieAttestStatus |
String
straat
Straatnaam
String
huisnummer
Huisnummer
String
busnummer
Busnummer
String
postcode
datumIngediend |
| |
datumGeldigheid |
|
isEnergieAttestLaatstGeldige |
energieAttestType |
hoofdBestemming |
geldig
Indictie of al dan niet enkel nog geldige energieattesten opgezocht mogen worden
Keuze:
True
False
Boolean
reden
bestemming |
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
bouwvorm | ||
bouwjaar | ||
beschermdVolume | ||
brutoVloerOppervlakte |
| |
verliesOppervlakte | ||
totaleOppervlakteVenstersNaarBuitenomgevingEnAor | ||
thermischeMassa | ||
infiltratiedebiet | ||
isNieuwbouwNaSloop | ||
isOpenHaardInStukhoutAanwezig | ||
voldoetAanEisen | ||
energieAttestTijdigIngediend | ||
Formaat van request
| Codeblok | ||
|---|---|---|
| ||
Formaat van response
Succesvolle opzoeking (zie ref naar pagina beschrijving detail energieattest )
HTTP Code: 2xx (vb. 201)
Response: Bevestiging en uniek VEKA meldingsnummer
| Codeblok | ||
|---|---|---|
| ||
{
"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
...