Versies vergeleken

Oude versie 8

changes.mady.by.user Johan De Clercq

Opgeslagen op

in vergelijking met

Nieuwe versie Huidige

changes.mady.by.user Johan De Clercq

Opgeslagen op

Sleutel

  • Deze regel is toegevoegd.
  • Deze regel is verwijderd.
  • Formattering is gewijzigd.

...

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)

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:

  • 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.

...

Inhoudsopgave

Overzicht van de antwoordvelden

In onderstaande lijst een overzicht alle antwoordvelden. Enkel de antwoordvelden waarvoor inhoudelijke informatie beschikbaar is worden meegegeven. Indien specifieke filtering voor een aansluiting toegepast werd, zullen ook uitgefilterde antwoordvelden niet zichtbaar zijn.

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

‘geldig’,

Vervangen

‘vervangen’,

Vervallen

‘vervallen’,

Geannuleerd?, Ingetrokken?, Actief? of Inactief?

‘geannuleerd’, 'ingetrokken'

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

‘EPC’ of

EPB

‘EPB’

hoofdBestemming

hoofdcategorie van de bestemming van de gebouweenheid

residentieel

‘residentieel’,

niet

‘niet-

residentieel

residentieel’,

gemeenschappelijk deel

‘gemeenschappelijk deel’ of

gemengd

‘gemengd’

bestemming

detaillijst van de bestemming van de gebouweenheid

hele lijst toevoegen?

‘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 buitenschoolse opvang’, ‘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’

publiekGebouw

indicatie of het een publiek gebouw betreft

‘true’ of ‘false’

overheidsGebouw

indicatie of het een overheidsgebouw betreft

‘true’ of ‘false’

bouwvorm

bouwvorm van de gebouweenheid

vrijstaand

‘vrijstaand’,

halfopen

‘halfopen’ of

gesloten

‘gesloten’

bouwjaar

bouwjaar van de gebouweenheid

beschermdVolume

beschermd volume van de gebouweenheid met vermelding van waarde en meeteenheid

brutoVloerOppervlakte

 bruto

bruto vloeroppervlakte van de gebouweenheid met vermelding van waarde en meeteenheid

verliesOppervlakte

totale verliesoppervlakte van de gebouweenheid met vermelding van waarde en meeteenheid

totaleOppervlakteVenstersNaarBuitenomgevingEnAor

totale verliesoppervlakte van de vensters met begrenzing buiten of aangrenzende onverwarmde ruimte met vermelding van waarde en meeteenheid

thermischeMassa

de thermische massa of zwaarte van de constructie

infiltratiedebiet

het lekdebiet per oppervlakte-eenheid van het gemeten bouwvolume bij een drukverschil van 50 Pa (v50-waarde)

isNieuwbouwNaSloop

True

‘true’ of

Flalse

‘false’

isOpenHaardInStukhoutAanwezig

True

‘true’ of

Flalse

‘false’

voldoetAanEisen

True

‘true’ of

Flalse

‘false’

energieAttestTijdigIngediend

True

‘true’ of

Flalse

‘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

‘adresId’,

gemeente

‘gemeente’,

straat

‘straat’,

huisnummer

‘huisnummer’, ('busnummer') en ‘postcode’

adresId

interne identificator van het adres

straat

straatnaam

huisnummer

huisnummer

busnummer

busnummer

gemeente

gemeente

postcode

postcode

energieIndicatoren

Lijst van beschikbare hoofd energieindicatoren:

energielabel

‘energielabel’,

e

‘e-

peil

peil’,

primairEnergieGerbruikPerVierkanteMeter

‘primairEnergieGerbruikPerVierkanteMeter’,

indicatorLangeTermijnDoelstelling

‘indicatorLangeTermijnDoelstelling’

referentie naar

energieIndicatoren

alleEnergieIndicatoren

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

schildelen

verwijzing naar detailgegevens van de diversie

opwerkkers

schildelen en constructiedelen

referentie naar installatiesVoorSanitairWarmWater

verwijzing naar detailgegevens van de diversie installaties voor sanitair warm water

referentie naar installatiesVoorRuimteverwarming

verwijzing naar detailgegevens van de diversie installaties voor ruimteverwarming

referentie naar

constructiedelen

installatiesVoorKoeling

verwijzing naar detailgegevens van de diversie

constructiedelen

installaties voor koeling

referentie naar

registratierol

installatiesVoorVentilatieEnBevochtiging

verwijzing naar detailgegevens van de

verantwoordelijke opsteller

diversie installaties voor ventilatie en bevochtiging

referentie naar

ventilatieruimtes

installatiesVoorVerlichting

verwijzing naar detailgegevens van de diversie

ventilatieruimtes

installaties voor verlichting

referentie naar erkenning

verwijzing naar detailgegevens van de verantwoordelijke opsteller

referentie naar documenten

verwijzing naar de fysieke bestanden (pdf, foto, …)

Formaat van request

Codeblok
breakoutModewide
languagejson
https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a299af097d853

Formaat van response

Succesvolle opzoeking

HTTP Code: 200
Response: Bevestiging en uniek VEKA meldingsnummer

...

Codeblok
breakoutModewide
languagejson
{
    "id": "dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a299af097d853",
    "energieAttestNummer": "2023060720230925-00101157370014371258-NR-31",
    "energieAttestStatus": "geldig",
    "datumIngediend": "2023-0609-0725",
    "datumGeldigheid": "2028-0609-0725",
    "energieAttestType": "EPC",
    "hoofdBestemming": "niet-residentieel",
    "bestemming": "kantoor",
    "gebouwId": "14371258",
    "lager onderwijs""publiekGebouw": false,
    "overheidsgebouw": false,
    "adressenenergieIndicatoren": [
        {
            "straatsoort": "ZandstraatenergieLabel",
            "huisnummerdoelstelling": "99A",
            "gemeentewaarde": "Zoersel",X"
        },
        {
            "postcodesoort": "primairEnergieGebruikPerVierkanteMeter",
            "2980waarde": 352.46,
            "adresIdmeeteenheid": "11667839kWh/(m² jaar)"
        }
    ],
    "gebouweenheidIdbouwvorm": "101157379vrijstaand",
    "gebouwIdbrutoVloerOpperVlakte": "101148109", {
        "energieIndicatorenwaarde": [3298.0,
        {
"meeteenheid": "m²"
      },
    "soortthermischeMassa": "energieLabelhalf zwaar/matig zwaar",
    "adviezen": {
        "doelstellingid": "A74c37439-f43c-4baa-9ac3-299af097d853",
   
        "waardeurl": "Ehttps://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/adviezen"
    },
   }, "energieMetingen": {
      {    "id": "74c37439-f43c-4baa-9ac3-299af097d853",
        "soorturl": "indicatorLangeTermijnDoelstelling",https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/energie-metingen"
       },
    "doelstellingalleEnergieIndicatoren": 100,
   {
        "waardeid": 9,
   "74c37439-f43c-4baa-9ac3-299af097d853",
        "meeteenheidurl": "%https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/indicatoren"
    },
   }, "schildelen": {
      {    "id": "74c37439-f43c-4baa-9ac3-299af097d853",
        "soorturl": "primairEnergieGebruikPerVierkanteMeter",
   https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/schildelen"
    },
    "installatiesVoorSanitairWarmWater": {
        "waardeid": 586.87,
   "74c37439-f43c-4baa-9ac3-299af097d853",
        "meeteenheidurl": "kWh/(m² jaar)"https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/installaties-voor-sanitair-warm-water"
    },
    }"installatiesVoorRuimteverwarming": {
   ],     "bouwvormid": "halfopen74c37439-f43c-4baa-9ac3-299af097d853",
        "url"brutoVloerOpperVlakte: "https: {//energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/installaties-voor-ruimteverwarming"
    },
    "waardeinstallatiesVoorVentilatieEnBevochtiging": 2000.0,{
        "meeteenheidid": "m²"
74c37439-f43c-4baa-9ac3-299af097d853",
   },     "thermischeMassaurl": "half zwaar/matig zwaar""https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/installaties-voor-ventilatie-en-bevochtiging"
    },
    "adviezeninstallatiesVoorVerlichting": {
        "id": "dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a299af097d853",
        "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a/adviezen299af097d853/installaties-voor-verlichting"
    },
    "energieMetingeninstallatiesVoorKoeling": {
        "id": "dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a299af097d853",
        "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c074c37439-1b31f43c-40dc4baa-93929ac3-b7251776f99a299af097d853/energieinstallaties-voor-metingenkoeling"
    }
}

Foutieve opzoeking

HTTP Code: 4xx (vb. 400, 404)
Response: Lijst van fouten gevonden in de melding

Codeblok
languagejson
{,
    "documenten": {
        "timestampid": "2023-07-03T10:45:31.508+02:00"74c37439-f43c-4baa-9ac3-299af097d853",
        "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/documenten"
    },
    "statuserkenning": {
   500,     "errorid": "Internal Server Error","74c37439-f43c-4baa-9ac3-299af097d853",
        "pathurl": "/epcnr-apihttps://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/74c37439-f43c-4baa-9ac3-299af097d853/erkenning"
    }
}