API	VEKA Meldingen API (OpenAPI specificaties)
Doel	Gegevens over een (historisch) ingediend energieprestatieattest opzoeken
Locatie	Testomgeving: Details Productie: Nog niet beschikbaar
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	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:

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 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	hoofdcategorie van de bestemming van de gebouweenheid	‘residentieel’, ‘niet-residentieel’, ‘gemeenschappelijk deel’ of ‘gemengd’
bestemming	detaillijst van de bestemming van de gebouweenheid	hele lijst toevoegen?
bouwvorm	bouwvorm van de gebouweenheid	‘vrijstaand’, ‘halfopen’ of ‘gesloten’
bouwjaar	bouwjaar van de gebouweenheid
beschermdVolume	beschermd volume van de gebouweenheid
brutoVloerOppervlakte	bruto vloeroppervlakte van de gebouweenheid
verliesOppervlakte	totale verliesoppervlakte van de gebouweenheid
totaleOppervlakteVenstersNaarBuitenomgevingEnAor	totale verliesoppervlakte van de vensters met begrenzing buiten of aangrenzende onverwarmde ruimte
thermischeMassa
infiltratiedebiet
isNieuwbouwNaSloop		‘true’ of ‘false’
isOpenHaardInStukhoutAanwezig		‘true’ of ‘false’
voldoetAanEisen		‘true’ of ‘false’
energieAttestTijdigIngediend		‘true’ of ‘false’
gebouwId	GebouwID uit het gebouwregister van de Vlaamse overheid
gebouweenheidId	GebouwEenheidID uit het gebouwregister van de Vlaamse overheid
adressen	Lijst van adressen gekoppeld aan het energieprestatiecertificaat, met per adres duiding van ‘adresId’, ‘gemeente’, ‘straat’, ‘huisnummer’, ('busnummer') en ‘postcode’
energieIndicatoren	Lijst van beschikbare hoofd energieindicatoren: ‘energielabel’, ‘e-peil’, ‘primairEnergieGerbruikPerVierkanteMeter’, ‘indicatorLangeTermijnDoelstelling’
referentie naar energieIndicatoren	verwijzing naar detailgegevens van de diversie energieIndicatoren
referentie naar energieMetingen	verwijzing naar detailgegevens van de diversie energieMetingen
referentie naar adviezen	verwijzing naar detailgegevens van de diversie adviezen
referentie naar opwekkers	verwijzing naar detailgegevens van de diversie opwerkkers
referentie naar installaties	verwijzing naar detailgegevens van de diversie installaties
referentie naar constructiedelen	verwijzing naar detailgegevens van de diversie constructiedelen
referentie naar registratierol	verwijzing naar detailgegevens van de verantwoordelijke opsteller
referentie naar ventilatieruimtes	verwijzing naar detailgegevens van de diversie ventilatieruimtes

Formaat van request

https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c0-1b31-40dc-9392-b7251776f99a

Formaat van response

Succesvolle opzoeking

HTTP Code: 200
Response: Bevestiging en uniek VEKA meldingsnummer

{
    "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",
    "energieIndicatoren": [
        {
            "soort": "energieLabel",
            "doelstelling": "A",
            "waarde": "E"
        },
        {
            "soort": "indicatorLangeTermijnDoelstelling",
            "doelstelling": 100,
            "waarde": 9,
            "meeteenheid": "%"
        },
        {
            "soort": "primairEnergieGebruikPerVierkanteMeter",
            "waarde": 586.87,
            "meeteenheid": "kWh/(m² jaar)"
        }
    ],
    "bouwvorm": "halfopen",
    "brutoVloerOpperVlakte": {
        "waarde": 2000.0,
        "meeteenheid": "m²"
    },
    "thermischeMassa": "half zwaar/matig zwaar",
    "adviezen": {
        "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/adviezen"
    },
    "energieMetingen": {
        "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/energie-metingen"
    }
}

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"
}

Detail EnergieAttesten API (in ontwerp)