Pagina-vergelijking

...

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

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

...

language	json

Inhoudsopgave

Overzicht van de antwoordvelden

Veldnaam	Omschrijving	Mogelijke waarden (indien van toepassing)
Meetperiode
startMeetPeriode	startdatum van de meetperiode
eindeMeetPeriode	einddatum van de meetperiode
duurMeetPeriode meeteenheid waarde	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)
documenten	verwijzing naar gekoppelde documenten gekoppeld aan de energiemeter met duiding van ‘id’ (zie Documenten)
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

breakoutMode	wide
language	json

https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/energie-metingen

Formaat van response

Succesvolle opzoeking

HTTP Code: 200
Response: Bevestiging en uniek VEKA meldingsnummer

Codeblok

breakoutMode	wide
language	json

{
    "meetPeriode": {
        "startMeetPeriode": "08/2023",
        "eindeMeetPeriode": "08/2024",
        "duurMeetPeriode": {
            "meeteenheid": "aantal jaren",
            "waarde": 1
        }
    },
    "energieMeters": [
        {
            "soortEnergieMeter": "warmtemeter",
            "typeEnergieMeter": "digitaal",
            "nummerEnergieMeter": "qdfqdfqdf",
            "locatieEnergieMeter": "dfdqfqdf",
            "beschrijvingEnergieMeter": "qfdf",
            "energiestroom": {
                "id": "38f28edd-c14a-4b68-b5f3-19607f7da85b",
                "soortEnergiestroom": "lokaal geproduceerde energiestroom",
                "naamEnergiestroom": "Warmtepomp",
                "typeEnergiestroom": "afgegeven warmte",
                "opwekker": {
                    "id": "44822c15-87f7-4eca-beac-8fa0d8d900a4",
                    "soortOpwekker": "warmtepomp",
                    "naamOpwekker": "Warmtepomp",
                    "detail": {
                        "id": "44822c15-87f7-4eca-beac-8fa0d8d900a4",
                        "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/opwekker/44822c15-87f7-4eca-beac-8fa0d8d900a4"
                    }
                },
                "typeEnergie": "warmte"
            },
            "meterstanden": [
                {
                    "startMeterstand": {
                        "meetwaarde": 0,
                        "meeteenheid": "kWh"
                    },
                    "eindMeterstand": {
                        "meetwaarde": 523,
                        "meeteenheid": "kWh"
                    },
                    "saldoMeterstand": {
                        "meetwaarde": 523,
                        "meeteenheid": "kWh"
                    },
                    "isGebruik": true
                }
            ],
            "documenten": {
                "id": "228693f6-5e92-4000-8b2b-091f4d8cff87",
                "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/dbabf3c0228693f6-1b315e92-40dc-9392-b7251776f99a/energie-metingen

Formaat van response

Succesvolle opzoeking

HTTP Code: 200
Response: Bevestiging en uniek VEKA meldingsnummer

Codeblok

language	json

{4000-8b2b-091f4d8cff87/energie-meters/4fc3c983-58aa-4fcd-b816-43abf15f6f26/documenten"
    "meetPeriode": {       }
 "startMeetPeriode": "01/2022",         "eindeMeetPeriode": "01/2023"},
        "duurMeetPeriode": {
            "meeteenheidsoortEnergieMeter": "aantal jarenelektriciteitsmeter",
            "waardetypeEnergieMeter": 1"digitaal",
        }     }"nummerEnergieMeter": "dqgggq",
    "energieMeters": [         {"locatieEnergieMeter": "dgdgd",
            "soortEnergieMeterbeschrijvingEnergieMeter": "elektriciteitsmeterfqdfqdfqg",
            "typeEnergieMeterenergiestroom": "digitaal", {
                "nummerEnergieMeterid": " dfqdfqdf38f28edd-c14a-4b68-b5f3-19607f7da85b",
                "locatieEnergieMetersoortEnergiestroom": "test",lokaal geproduceerde energiestroom",
                "beschrijvingEnergieMeternaamEnergiestroom": "testWarmtepomp",
                "energiestroomtypeEnergiestroom": {"opgenomen elektriciteit",
                "idopwekker": "48111c53-5b9d-4835-9245-f7aeaf6b007d",{
                    "soortEnergiestroomid": "lokaal geproduceerde energiestroom","44822c15-87f7-4eca-beac-8fa0d8d900a4",
                    "naamEnergiestroomsoortOpwekker": "PV-panelenwarmtepomp",
                    "typeEnergiestroomnaamOpwekker": "opgewekte elektriciteit"Warmtepomp",
                    "opwekkerdetail": {
                        "id": "79c633e344822c15-115687f7-48fc4eca-b5f7beac-2889526f337e8fa0d8d900a4",
                          "soortOpwekker": "pv-panelen",  "url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/opwekker/44822c15-87f7-4eca-beac-8fa0d8d900a4"
                    "naamOpwekker": "PV-panelen"
}
                },
                "typeEnergie": "elektriciteitwarmte"
            },
            "meterstanden": [
                {
                    "startMeterstand": {
                        "meetwaarde": 560,
                        "meeteenheid": "kWh"
                    },
                    "eindMeterstand": {
                        "meetwaarde": 56454540,
                        "meeteenheid": "kWh"
                    },
                    "saldoMeterstand": {
                        "meetwaarde": 56398540,
                        "meeteenheid": "kWh"
                    },
                    "isGebruik": true
                }
            ]
,
       },         {
        "documenten": {
   "soortEnergieMeter": "elektriciteitsmeter",             "typeEnergieMeterid": "analoog, tweevoudig",228693f6-5e92-4000-8b2b-091f4d8cff87",
                "nummerEnergieMeterurl": "1236446","https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/energie-meters/717bdde4-99ee-4c32-8855-9ae5359d2f39/documenten"
            "nutsbedrijf": "fluvius",}
             "locatieEnergieMeter": "teqt"},
        {
   "beschrijvingEnergieMeter": "tst",             "energiestroomsoortEnergieMeter": {
      "elektriciteitsmeter",
         "id": "9f895ac7-b8f1-4656-84e9-f62958fffb13",     "typeEnergieMeter": "analoog",
            "soortEnergiestroomnummerEnergieMeter": "inkomende stroomdfqdfq",
                "naamEnergiestroomlocatieEnergieMeter": "Elektriciteitsnetdfqdf",
  
             "typeEnergiestroombeschrijvingEnergieMeter": "elektriciteitsnetdfqdf",
            },"energiestroom": {
                "meterstandenid": ["9136a3e3-3baf-43bd-a9d5-dc87ab267283",
                {
   "soortEnergiestroom": "inkomende stroom",
                "startMeterstandnaamEnergiestroom": {"Elektriciteitsnet",
                        "meetwaarde": 50,"typeEnergiestroom": "elektriciteitsnet"
            },
            "meeteenheidmeterstanden": "kWh"[
                {
   },
                    "eindMeterstandstartMeterstand": {
                        "meetwaarde": 5646540,
                        "meeteenheid": "kWh"
                    },
                    "saldoMeterstandeindMeterstand": {
                        "meetwaarde": 56460464352,
                        "meeteenheid": "kWh"
                    },": "kWh"
                    "isGebruik": true},
                    "isDagsaldoMeterstand": true{
                },            "meetwaarde": 64352,
    {                     "startMeterstandmeeteenheid": {"kWh"
                    },
   "meetwaarde": 10,                "isGebruik": true
       "meeteenheid": "kWh"        }
            }],
            "documenten": {
         "eindMeterstand": {      "id": "228693f6-5e92-4000-8b2b-091f4d8cff87",
                "url": "meetwaarde": 5646666,"https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/energie-meters/1bb9c2a3-4431-4e67-8ec7-c629983ccb2b/documenten"
            }
        },
   "meeteenheid": "kWh"    {
                }"soortEnergieMeter": "brandstofmeter",
                    "saldoMeterstand": {"typeEnergieMeter": "analoog",
            "nummerEnergieMeter": "dsfqdfqf",
            "meetwaardenutsbedrijf": 5646656,
     "fluvius",
                  "meeteenheid"locatieEnergieMeter": "kWhqgdqg",
            "beschrijvingEnergieMeter": "ggq",
      },      "energiestroom": {
                "isGebruikid": true,
"ac3727be-b0f1-423b-8fc3-eb51cd2385cf",
                   "isNachtsoortEnergiestroom": true"inkomende stroom",
               } "naamEnergiestroom": "Gasnet",
          ],             "eancodetypeEnergiestroom": "541111111111111111gasnet"
            },
         {   "meterstanden": [
         "soortEnergieMeter": "brandstofmeter",      {
      "typeEnergieMeter": "digitaal",             "nummerEnergieMeterstartMeterstand": "136614",{
            "locatieEnergieMeter": "tst",             "beschrijvingEnergieMetermeetwaarde": "test"500,
            "energiestroom": {                 "idmeeteenheid": "bf34782a-d2f4-4c12-992c-a1f86deb4c1d",m³"
                 "soortEnergiestroom": "lokaal geproduceerde energiestroom"},
                    "naamEnergiestroomeindMeterstand": "Condenserende ketel - Pellets", {
                        "typeEnergiestroommeetwaarde": "brandstof"604,
                 "opwekker       "meeteenheid": {"m³"
                    "id": "7edb8bab-6340-4457-bce3-e54db041c13d"},
                    "soortOpwekker": "condenserende ketel",saldoMeterstand": {
                        "naamOpwekkermeetwaarde": "Condenserende ketel - Pellets"104,
                      },  "meeteenheid": "m³"
             "typeEnergie": "warmte"      },
      },              "meterstandenisGebruik": [true
                {}
            ],
       "startMeterstand": {    "documenten": {
                   "meetwaardeid": 0,
   "228693f6-5e92-4000-8b2b-091f4d8cff87",
                    "meeteenheidurl": "kWh"
     https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/energie-meters/84f306ac-547e-48b8-990c-e1f7546efaab/documenten"
              },
            "eancode": "541233333331111112"
      "eindMeterstand": { },
        {
              "meetwaardesoortEnergieMeter": 544564,
  "elektriciteitsmeter",
                     "meeteenheid"typeEnergieMeter": "kWhdigitaal",
                    }"nummerEnergieMeter": "dfqfqf",
                    "saldoMeterstand": {"locatieEnergieMeter": "test",
            "beschrijvingEnergieMeter": "test",
            "meetwaardeenergiestroom": 544564,{
                        "meeteenheid"id": "kWh"ce83c5da-3015-448a-9893-a9f084c0948d",
                "soortEnergiestroom": "lokaal geproduceerde  }energiestroom",
                    "isGebruiknaamEnergiestroom": true"PV-panelen",
                }
    "typeEnergiestroom": "opgewekte elektriciteit",
       ]         },
"opwekker": {
       {             "soortEnergieMeterid": "brandstofmeter",3cd1acdb-af78-4890-9eb2-4eb8d51fd842",
                    "typeEnergieMetersoortOpwekker": "digitaalpv-panelen",
             "nummerEnergieMeter       "naamOpwekker": "1PV-panelen",
                    "nutsbedrijfdetail": "fluvius",
{
           "locatieEnergieMeter": "Gang",             "beschrijvingEnergieMeterid": "Gasmeter3cd1acdb-af78-4890-9eb2-4eb8d51fd842",
            "energiestroom": {                 "idurl": "b1a6d029-a2f7-41e6-94fb-80efe3c8ccbc",https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/opwekker/3cd1acdb-af78-4890-9eb2-4eb8d51fd842"
                 "soortEnergiestroom": "inkomende stroom", }
               "naamEnergiestroom": "Gasnet" },
                "typeEnergiestroomtypeEnergie": "gasnetelektriciteit"
            },
            "meterstanden": [
                {
                    "startMeterstand": {
                        "meetwaarde": 0300,
                        "meeteenheid": "kWh"
                    },
                    "eindMeterstand": {
                        "meetwaarde": 40000600,
                        "meeteenheid": "kWh"
                    },
                    "saldoMeterstand": {
                        "meetwaarde": 40000300,
                        "meeteenheid": "kWh"
                    },
                    "isGebruik": true
                }
            ],
            "eancodedocumenten": {
                "id": "541111111111111111"228693f6-5e92-4000-8b2b-091f4d8cff87",
        }        ]
}

Foutieve opzoeking

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

Codeblok

language	json

{"url": "https://energie-ti-secure.api.vlaanderen.be/energie-attesten-api/v1/energie-attesten/228693f6-5e92-4000-8b2b-091f4d8cff87/energie-meters/60afb338-66b7-45c6-800d-4f3387166d73/documenten"
     "timestamp": "2023-07-03T10:45:31.508+02:00",     "status": 500, }
    "error": "Internal Server Error", }
   "path": "/epcnr-api/energie-attesten" ]
}

Versies vergeleken

Oude versie 2

Nieuwe versie 3

Sleutel

Overzicht van de antwoordvelden

Formaat van request

Overzicht van de antwoordvelden

Formaat van request

Formaat van response

Succesvolle opzoeking

Formaat van response

Succesvolle opzoeking

Foutieve opzoeking