Spring naar het einde van metadata
Ga nar het begin van metadata

Je bekijkt een oude versie van deze pagina. Bekijk de huidige versie.

Vergelijk met huidige Toon pagina geschiedenis

« Vorige Versie 7 Huidig »

API Call

API call

POST /meldingen-api-a2a/v1/extern/historischeMeldingCentraleStooktoestellen

Beschrijving

API call voor het melden van een keuring of onderhoud van een centraal stooktoestel uitgevoerd tussen 1/1/2023 en 31/8/2023

De belangrijkste voorwaarden om de gegevens voor een melding te aanvaarden zijn:

  • De HVAC onderneming melder is geregistreerd en actief op het moment van opladen

  • De activiteit keuring of onderhoud werd nog niet gemeld aan het VEKA (op basis van eigen externe refertenummer)

  • De datum van de activiteit keuring of onderhoud ligt niet in de toekomst

  • De technicus is gekend bij de Vlaamse Overheid en mag de keuring en onderhoud van centrale stooktoestellen uitvoeren op datum van de activiteit

  • Het correcte identificatienummer voor adres, gebouw en gebouweenheid werd meegeleverd zoals opgenomen in het adres- en gebouwregister van de Vlaamse Overheid

    • Bij voorkeur door doorgave van het gebouw(eenheid)ID.

    • In eerste fase is minstens het adresID verplicht

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

https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2321580033/Locatie+van+een+stooktoestel#API-endpoints

(waarschuwing) Optioneel. Indien ‘adresId’ gespecifieerd werd, worden velden ‘straatnaam’, ‘gemeente’, ‘postcode’, ‘huisnummer’ en ‘busnummer’ genegeerd

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

(waarschuwing) Optioneel

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

 https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2321580033/Locatie+van+een+stooktoestel#API-endpoints

(waarschuwing) Optioneel. Indien ‘gebouweenheidId’ gespecifieerd werd, worden velden ‘straatnaam’, ‘gemeente’, ‘postcode’, ‘huisnummer’ en ‘busnummer’ genegeerd

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

straatnaam

Straatnaam van het adres

huisnummer

Huisnummer van het adres

busnummer

Busnummer van het adres

postcode

Postcode van het adres

gemeente

Gemeente van het adres

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

  • Condenserende ketel

  • Niet-condenserende ketel

  • 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

Formaat van request

{
  "externeReferte": "1234-ABCD-0001",
  "ondernemingsnummer": "0000.000.000",
  "gegevensActiviteit": {
    "activiteitType": "Keuring voor eerste ingebruikname",
    "datumActiviteit": "2023-02-02",
    "erkenningsnummer": "ERK/TGB/103157",
    "verwarmingType": "Individueel",
    "adresId": "000000",
    "gebouwId": "0000000",
    "gebouwIdNietGekend": false,
    "gebouweenheidId": "0000000",
    "gebouweenheidIdNietGekend": false,
    "straatnaam": "test straat",
    "huisnummer": "1",
    "busnummer": "A",
    "postcode": "0000",
    "gemeente": "test gemeente"
  },
  "kenmerkenToestel": {
    "bouwjaar": 2023,
    "bouwjaarNietGekend": false,
    "branderTechnologie": "Premix (GI)",
    "brandstof": "Aardgas",
    "fabricatienummer": "ID3VN1234444433",
    "fabricatienummerNietGekend": false,
    "merk": "Vaillant",
    "merkNietGekend": "false",
    "nominaalVermogen": 20,
    "type": "vc206",
    "typeNietGekend": false,
    "werking": "Condenserende ketel"
  },
  "eindbeoordeling": {
    "rookgasafvoerkanaalConform": "OK",
    "stookplaatsConform": "OK",
    "stooktoestelConform": "OK",
    "toestelWerkingGoed": "Goed",
    "toestelWerkingVeilig": "Veilig",
    "verbrandingscontrole": "OK"
  }
}

Formaat van response

Succesvolle melding

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 melding

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

{
  "timestamp": "2023-02-14T15:24:08.664+01:00",
  "status": 4xx,
  "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."
    }
}

  • Geen labels