Doel

Gegevens voor een melding centrale stooktoestellen aanleveren

Locatie

(test secure) https://energie-ti-secure.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen

(test publiek) https://energie-ti.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen

Inhoudsopgave

Security van de webservices

...

Overzicht van de invoervelden

Veldnaam	Omschrijving	Toegelaten waarden
externeReferte	Unieke ID uit eigen software
ondernemingsnummer	KBO nummer of ondernemingsnummer van de HVAC onderneming melder
activiteitType	Uitgevoerde ativiteit die wordt gemeld	Keuze: Keuring voor eerste ingebruikname Onderhoud
datumActiviteit	Datum waarop de activiteit keuring of onderhoud werd uitgevoerd door de erkende technicus
erkenningsnummer	Erkenningsnummer van de technicus die de activiteit keuring of onderhoud heeft uitgevoerd
verwarmingType		Keuze: individueel collectief onbekend
adresId	AdresID uit het adresregister van de Vlaamse overheid
gebouwId	GebouwID uit het gebouwregister van de Vlaamse overheid
gebouwIdNietGekend	True indien de gebruiker via de toepassing heeft aangegeven na nazicht op de kaart dat het gebouwID onbekend is in het basisregister	Keuze True False
gebouweenheidId	GebouwEenheidID uit het gebouwregister van de Vlaamse overheid
gebouweenheidIdNietGekend	True indien de gebruiker via de toepassing heeft aangegeven na nazicht op de kaart dat het gebouweenheidID onbekend is in het basisregister	Keuze: True False
fabricatienummer	Fabricatienummer van het stooktoestel
fabricatienummerNietGekend	True indien de technicus het Fabricatienummer niet heeft aangeleverd	Keuze: True False
nominaalVermogen	Nominaal vermogen van het stooktoestel (in kW)	double
brandstof		Keuze: Aardgas Stookolie Houtpellets LPG Houtblokken Gas – type onbekend Vloeibaar – type onbekend Vast – type onbekend
branderTechnologie		Keuze: •Premix (GI) •Niet premix (GI) •Gasketel met ventillatorbrander (GI)
merk	Merk van het stooktoestel
merkNietGekend	True indien de technicus het merk van het stooktoestel niet heeft aangeleverd	Keuze: True False
type	Type of model van het stooktoestel
typeNietGekend		Keuze: True False
werking		Keuze Condenserend Niet – condenserend Onbekend
bouwjaar	Bouwjaar van het stooktoestel	numeriek
bouwjaarNietGekend	True indien de technicus het bouwjaar van het stooktoestel niet heeft aangeleverd	Keuze: True False
stooktoestelConform		Keuze: OK Niet OK
rookgasafvoerkanaalConform		Keuze: OK Niet OK
stookplaatsConform		Keuze: OK Niet OK
verbrandingscontrole		Keuze: OK Niet OK
toestelWerkingGoed		Keuze: Goed Niet goed
toestelWerkingVeilig		Keuze: Veilig Niet veilig

Zie ook bijlage: MeldingCentraleStooktoestellen - velden API.xlsx

View file

name	MeldingCentraleStooktoestellen - velden API.xlsx

...

Formaat van request

...

Codeblok

{
  "externeReferte": "0-1234-ABCD",
  "ondernemingsnummer": "1234567890",
  "gegevensActiviteit": {
    "activiteitType": "Keuring voor eerste ingebruikname",
    "datumActiviteit": "2023-02-14",
    "verwarmingType": "Individueel",
    "adresId": "12345",
    "gebouwId": "9400001",
    "gebouwIdNietGekend": false,
    "gebouweenheidId": "9400075"
    "gebouweenheidIdNietGekend": false
  },
  "kenmerkenToestel": {
    "bouwjaar": 2023,
		  "bouwjaarNietGekend": false,
    "fabricatienummer": "A12345678",
    "fabricatienummerNietGekend": false,
    "nominaalVermogen": 21,
    "brandstof": "Aardgas",
    "branderTechnologie": "Premix (GI)",
    "merk": "Merknaam",
    "merkNietGekend": false,
    "type": "type toestel",
    "typeNietGekend": false, 
    "werking": "Condenserende ketel"
  },
  "eindbeoordeling": {
    "erkenningsnummer": "TV12345",
    "stooktoestelConform": "OK",
    "rookgasafvoerkanaalConform": "NOK",
    "stookplaatsConform": "OK",
    "verbrandingscontrole": "NOK",
    "toestelWerkingGoed": "Goed",
    "toestelWerkingVeilig": "Veilig"
  }
}

Formaat van response

Succesvolle melding

HTTP Code: 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 melding

HTTP Code: 400
Response: Lijst van fouten gevonden in de melding

Codeblok

{
  "timestamp": "2023-02-14T15:24:08.664+01:00",
  "status": 400,
  "error": "Bad Request",
  "externeReferte": "0-1234-ABCD",
  "errors": [
    {
      "message": "De meegegeven waarde is niet toegestaan: Goedkeuring. Mogelijke waarden zijn: Keuring voor eerste ingebruikname, Onderhoud",
      "field": "activiteitType",
      "rejectedValue": "Goedkeuring"
    },
    {
      "message": "Datum van de melding mag niet in de toekomst."
    },
    {
      "message": "Het erkenningsnummer wordt niet herkend."
    }
}

Testomgeving

VEKA voorziet een test-versie van de API om de implementatie door de softwareleverancier te faciliteren. Er zijn twee versies beschikbaar: één beveiligde API en één publiek toegankelijke. Beide APIs bevatten dezelfde logica.

Test API	Beveiligde versie
Authenticatie	Test certificaat CN={ondernemingsnummer}-test.softwareleverancier.veka.vlaanderen.be
Locatie	https://energie-ti-secure.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen

Test API	Publieke versie
Authenticatie	Geen
Locatie	https://energie-ti.api.vlaanderen.be/meldingen-api-a2a/v1/extern/meldingCentraleStooktoestellen

Versies vergeleken

Oude versie 2

Nieuwe versie 3

Sleutel

Security van de webservices

Overzicht van de invoervelden

Formaat van request

Formaat van response

Testomgeving

Pagina-vergelijking

Versies vergeleken

Oude versie 2

Nieuwe versie 3

Sleutel

Security van de webservices

Overzicht van de invoervelden

Formaat van request

Formaat van response

Testomgeving