API | VEKA Meldingen API (OpenAPI specificaties) |
|---|---|
Doel | Gegevens over een (historisch) ingediend energieprestatieattest opzoeken |
Locatie | Testomgeving: Details |
Toegang | Voor overheden, lokale besturen, … op basis van een vooraf afgesloten protocol (aanvraag: https://vo-veka.atlassian.net/wiki/spaces/TDV/pages/2294874204) |
| Inhoudsopgave |
|---|
Overzicht van de antwoordvelden
Veldnaam | Omschrijving | Mogelijke waarden (indien van toepassing) |
Meetperiode | ||
startMeetPeriode | startdatum van de meetperiode | |
eindeMeetPeriode | einddatum van de meetperiode | |
duurMeetPeriode | de lengte van de meetperiode met afzonderlijke duiding van de waarde en de meeteenheid | |
Per meter | ||
soortEnergieMeter | indicatie van het soort meter | ‘aardgasmeter’, ‘brandstofmeter’, ‘elektriciteitsmeter' of 'warmtemeter’ |
typeEnergieMeter | indicatie over het type meter | ‘analoog’ of ‘digitaal’ |
nummerEnergieMeter | meternummer van de meter | |
eancode | EAN-code van de meter | |
nutsbedrijf | naam van het nutsbedrijf waardoor de meter geplaatst werd | 'Elia' of ‘Fluvius’ |
locatieEnergieMeter | indicatie van de locatie van de meter | |
beschrijvingEnergieMeter | beschrijving van de meter | |
energiestroom | informatie over de energiestroom waaraan de meter is gekoppeld | |
id | identificator van de energiestroom | |
soortEnergiestroom | indicatie over het soort energiestroom | ‘inkomende stroom’, ‘geëxporteerde stroom’, ‘energiegebruik buiten de eenheid’, ‘lokaal geproduceerde energiestroom’ of ‘combinatie inkomende en geëxporteerde stroom’ |
naamEnergiestroom | naam van de energiestroom | ‘externe warmtelevering’, ‘elektriciteitsnet’, ‘gasnet’, ‘warmte’, ‘elektriciteit’, ‘opgewekte elektrictiteit’, ‘afgegeven warmte’, ‘opgenomen elektriciteit’ of 'omgevingswarmte' |
typeEnergiestroom | indicatie van het type energiestroom | |
typeEnergie | indicatie van het type energie | ‘elektriciteit’ of ‘warmte’ |
opwekker | verwijzing naar de gekoppelde opwekker met duiding van de ‘id’, ‘soort opwekker’ en ‘naam opwekker’ (zie Opwekkers) | |
Per meting van de meter | ||
meterstanden | ||
startMeterstand | startwaarde van de meterstand en zijn meeteenheid | |
eindmeterstand | eindwaarde van de meterstand en zijn meeteenheid | |
saldoMeterstand | verschil tussen de startwaarde en de eindwaarde van de meterstand en zijn meeteenheid | |
isGebruik | indicatie of het over gebruik gaat | 'true' |
isInjectie | indicatie of bet over injectie gaat | ‘true’ |
isDag | indicatie of het over dagmeting gaat | ‘true’ |
isNacht | indicatie of het over nachtmeting gaat | ‘true’ |
Formaat van request
| Codeblok | ||
|---|---|---|
| ||
https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c0-1b31-40dc-9392-b7251776f99a/energie-metingen |
Formaat van response
Succesvolle opzoeking
HTTP Code: 200
Response: Bevestiging en uniek VEKA meldingsnummer
| Codeblok | ||
|---|---|---|
| ||
{
"meetPeriode": {
"startMeetPeriode": "01/2022",
"eindeMeetPeriode": "01/2023",
"duurMeetPeriode": {
"meeteenheid": "aantal jaren",
"waarde": 1
}
},
"energieMeters": [
{
"soortEnergieMeter": "elektriciteitsmeter",
"typeEnergieMeter": "digitaal",
"nummerEnergieMeter": " dfqdfqdf",
"locatieEnergieMeter": "test",
"beschrijvingEnergieMeter": "test",
"energiestroom": {
"id": "48111c53-5b9d-4835-9245-f7aeaf6b007d",
"soortEnergiestroom": "lokaal geproduceerde energiestroom",
"naamEnergiestroom": "PV-panelen",
"typeEnergiestroom": "opgewekte elektriciteit",
"opwekker": {
"id": "79c633e3-1156-48fc-b5f7-2889526f337e",
"soortOpwekker": "pv-panelen",
"naamOpwekker": "PV-panelen"
},
"typeEnergie": "elektriciteit"
},
"meterstanden": [
{
"startMeterstand": {
"meetwaarde": 56,
"meeteenheid": "kWh"
},
"eindMeterstand": {
"meetwaarde": 56454,
"meeteenheid": "kWh"
},
"saldoMeterstand": {
"meetwaarde": 56398,
"meeteenheid": "kWh"
},
"isGebruik": true
}
]
},
{
"soortEnergieMeter": "elektriciteitsmeter",
"typeEnergieMeter": "analoog, tweevoudig",
"nummerEnergieMeter": "1236446",
"nutsbedrijf": "fluvius",
"locatieEnergieMeter": "teqt",
"beschrijvingEnergieMeter": "tst",
"energiestroom": {
"id": "9f895ac7-b8f1-4656-84e9-f62958fffb13",
"soortEnergiestroom": "inkomende stroom",
"naamEnergiestroom": "Elektriciteitsnet",
"typeEnergiestroom": "elektriciteitsnet"
},
"meterstanden": [
{
"startMeterstand": {
"meetwaarde": 50,
"meeteenheid": "kWh"
},
"eindMeterstand": {
"meetwaarde": 564654,
"meeteenheid": "kWh"
},
"saldoMeterstand": {
"meetwaarde": 564604,
"meeteenheid": "kWh"
},
"isGebruik": true,
"isDag": true
},
{
"startMeterstand": {
"meetwaarde": 10,
"meeteenheid": "kWh"
},
"eindMeterstand": {
"meetwaarde": 5646666,
"meeteenheid": "kWh"
},
"saldoMeterstand": {
"meetwaarde": 5646656,
"meeteenheid": "kWh"
},
"isGebruik": true,
"isNacht": true
}
],
"eancode": "541111111111111111"
},
{
"soortEnergieMeter": "brandstofmeter",
"typeEnergieMeter": "digitaal",
"nummerEnergieMeter": "136614",
"locatieEnergieMeter": "tst",
"beschrijvingEnergieMeter": "test",
"energiestroom": {
"id": "bf34782a-d2f4-4c12-992c-a1f86deb4c1d",
"soortEnergiestroom": "lokaal geproduceerde energiestroom",
"naamEnergiestroom": "Condenserende ketel - Pellets",
"typeEnergiestroom": "brandstof",
"opwekker": {
"id": "7edb8bab-6340-4457-bce3-e54db041c13d",
"soortOpwekker": "condenserende ketel",
"naamOpwekker": "Condenserende ketel - Pellets"
},
"typeEnergie": "warmte"
},
"meterstanden": [
{
"startMeterstand": {
"meetwaarde": 0,
"meeteenheid": "kWh"
},
"eindMeterstand": {
"meetwaarde": 544564,
"meeteenheid": "kWh"
},
"saldoMeterstand": {
"meetwaarde": 544564,
"meeteenheid": "kWh"
},
"isGebruik": true
}
]
},
{
"soortEnergieMeter": "brandstofmeter",
"typeEnergieMeter": "digitaal",
"nummerEnergieMeter": "1",
"nutsbedrijf": "fluvius",
"locatieEnergieMeter": "Gang",
"beschrijvingEnergieMeter": "Gasmeter",
"energiestroom": {
"id": "b1a6d029-a2f7-41e6-94fb-80efe3c8ccbc",
"soortEnergiestroom": "inkomende stroom",
"naamEnergiestroom": "Gasnet",
"typeEnergiestroom": "gasnet"
},
"meterstanden": [
{
"startMeterstand": {
"meetwaarde": 0,
"meeteenheid": "kWh"
},
"eindMeterstand": {
"meetwaarde": 40000,
"meeteenheid": "kWh"
},
"saldoMeterstand": {
"meetwaarde": 40000,
"meeteenheid": "kWh"
},
"isGebruik": true
}
],
"eancode": "541111111111111111"
}
]
} |
Foutieve opzoeking
HTTP Code: 4xx (vb. 400, 404)
Response: Lijst van fouten gevonden in de melding
...