Implementatie

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

Formaat van request

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