ARGE specification for EED consumption data exchange

/wp-content/uploads/apis/arge-spec-consumption-data-1_2_1.yaml

English

General Information

As part of the EU Energy Efficiency Directive (EED), the ARGE HeiWaKo (www.arge-heiwako.de) publishes a web service with which monthly consumption data for residential units can be retrieved at billing unit level from a measuring service company (MSC).

This service is intended to enable the housing industry to provide users/residents with consumption information during the year in their own IT systems as part of the EED.

The service can be implemented by any interested party in its software.

The server side is covered by the MSC.

The service was developed according to the criteria of security and minimum implementation costs.

Change Log

Version 1.2.1:

• Count of available billing units with data services information

Version 1.2:

• Added information for consumption data services per billing unit
• remarklist on residentialunit

Version 1.1:

• Added benchmark
• Added flag for converted consumptions

Data Model

This API uses the following roles:

• MSC: The measuring service company providing the consumption data.
• PM: The property management as customer of the MSC respectively the software reading the consumption data.

Security

The service is protected with basicAuth authentication and data must be transmitted on a secure channel (HTTPS/SSL).

Deutsch

Allgemeine Informationen

Im Rahmen der Energieeffizienzrichtlinie der EU (EED) veröffentlicht die die ARGE HeiWaKo (www.arge-heiwako.de) eine Schnittstelle, mit der monatliche Verbrauchsdaten auf Nutzeinheitenebene vom Messdienstleistern (measuring service company, MSC) abgerufen werden können.

Diese Schnittstelle soll es der Wohnungswirtschaft ermöglichen, Nutzern/Bewohnern eine unterjährige Verbrauchsinformation im Rahmen der EED in eigenen IT-Systemen bereitzustellen.

Die Serverseite wird von den Messdienstleistern bereitgestellt.

Der Service wurde nach den Kriterien Sicherheit und minimalem Implementierungsaufwand entwickelt.

Änderungen

Version 1.2.1:

• Anzahl der verfügbaren Abrechnungseinheiten mit Information zur Service-Aktivierung

Version 1.2:

• Information zu Service-Aktivierung Verbrauchsdaten für Abrechnungseinheiten hinzugefügt
• Liste von Bemerkungen auf Nutzeinheits-Ebene

Version 1.1:

• Benchmark hinzugefügt
• Kennzeichen für umgerechnete Verbräuche hinzugefügt (converted)

Datenmodell

Diese API verwendet die folgenden Rollen:

• MSC: Der Messdienstleister, der die Verbrauchsdaten zur Verfügung stellt.
• PM: Die Hausverwaltung als Kunde des MSC bzw. die Software, die die Verbrauchsdaten ausliest.

Sicherheit

Die Schnittstelle ist mit basicAuth-Verfahren gesichert. Die Datenübertragung muss über einen sicheren Kanal erfolgen (HTTPS/SSL).

History

• 2022-01-28: Added comment regarding interpretation of the unitofmeasure when converted flag is set.
• 2022-06-09: Added service configuration request