Reading backend interfaces
Read energy quantities from the billing context
Read energy quantities from the billing context
GET
https://mock.macoapp.de
/getEnergyAmount
Reading the energy quantities from the billing context via a location ID (Parameter1) and location type (Parameter2) within a range (Parameter3/Parameter4) and an OBIS code number (Parameter5 optional)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | Location ID · Example: 74018657187 · Default: 74018657187 | string |
parameter2* | Location type · Example: MALO · Default: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Date (valid from) or key date if parameter4 is not set · Example: 2024-06-28T12:18:00Z · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter4* | Date (Valid until) · Example: 2024-06-28T12:18:00Z · Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter5 | OBIS key figure · Example: 123456789 | string |
command | Corresponds to the operationId of this interface. This operation ID corresponds to the command in the Camunda connector process. If the backend provides a generic endpoint, this command can be used to define which operation is to be executed. | string |
Read energy quantities from the billing context › Responses
Successful reading of the energy quantity | Successful reading of the energy quantity
Array of: Energy quantity — the response is a list of these objects, not a single object. Every entry has this structure:
| Structure (BO4E) | Description | Format |
|---|---|---|
boTyp* | Type of the BO | stringANSPRECHPARTNER, AVIS, ENERGIEMENGE GESCHAEFTSOBJEKT, GESCHAEFTSPARTNER, MARKTLOKATION, MARKTTEILNEHMER, MESSLOKATION, ZAEHLER, KOSTEN, TARIF, PREISBLATT, PREISBLATTNETZNUTZUNG, PREISBLATTMESSUNG, PREISBLATTUMLAGEN, PREISBLATTDIENSTLEISTUNG, PREISBLATTKONZESSIONSABGABE, ZEITREIHE, LASTGANG, HANDELSUNSTIMMIGKEIT, ANFRAGE, AUFTRAG, STATUSMITTEILUNG, BERECHNUNGSFORMEL, RECHNUNG, BILANZIERUNG, NETZNUTZUNGSVERTRAG, MESSSTELLENBETRIEBSVERTRAG, ENERGIELIEFERVERTRAG, SPERRAUFTRAG, ANGEBOT, TRANCHE, KOMMUNIKATIONSDATEN, ZAEHLZEITDEFINITION, SCHALTZEITDEFINITION, LEISTUNGSKURVENDEFINITION, NETZLOKATION, STEUERBARE_RESSOURCE, TECHNISCHE_RESSOURCE, AD_HOC_STEUERKANAL, LOKATIONSBUENDEL, WERTE_NACH_TYP2, REKLAMATION, STATUSBERICHT, VERTRAG, BILANZKREIS, VERWENDUNGSZEITRAUM, TARIFINFO, SUMMENZEITREIHE |
versionStruktur* | versionStruktur | string |
lokationsId | Identification for which the data applies LOC 172 PI 13017 13019 13016 13015 13028 13002 13009 13018 13025 13008 13003 13023 13020 13022 13021 13007 13013 13014 13027 13006 | string |
lokationsTyp | Indicates whether this is a market location or a metering location. | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
fertigstellungsdatum | unique version number - completion date/time DTM 293 PI 13010 13011 13012 13003 13023 13005 13026 13020 13022 13021 13007 13013 | string (date-time) |
startdatum | Start point in time of the transmission period DTM 163 PI 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13012 13003 13023 13005 13026 13020 13022 13021 13007 13014 13027 | string (date-time) |
enddatum | End point in time of the transmission period DTM 164 PI 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13012 13003 13023 13005 13026 13020 13022 13021 13007 13014 13027 | string (date-time) |
bilanzierungsdatum | Balancing month DTM 492 PI 13003 13023 13020 13013 | string (date-time) |
beginndatum | Validity, start date of the profile set DTM 157 PI 13011 | string (date-time) |
referenzStammdatenmeldungMsb | Reference to the previous master data notification of the MSB RFF Z30 PI 13002 | string |
konfiguration | Configuration ID RFF AGK PI 13017 13019 | string |
| energieverbrauch[ ] | Specifies the consumption in a unit of time. | object[] |
startdatum | Start of metering period DTM 163 PI 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13012 13003 13023 13005 13026 13020 13022 13021 13007 13014 13027 | string (date-time) |
enddatum | End of measurement period DTM 164 PI 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13012 13003 13023 13005 13026 13020 13022 13021 13007 13014 13027 | string (date-time) |
wertermittlungsverfahren | Meter reading value or forecast value - refers to the status information | stringPROGNOSE, MESSUNG |
messwertstatus | Status details PI 13017 13019 13016 13015 13002 13009 13018 13025 13008 13003 13022 13021 13007 13027 13010 13011 13012 13003 13023 13005 13026 13020 13013 13014 13028 | stringABGELESEN, ERSATZWERT, VORSCHLAGSWERT NICHT_VERWENDBAR, PROGNOSEWERT, ENERGIEMENGESUMMIERT, VOLAEUFIGERWERT, FEHLT, ANGABE_FUER_LIEFERSCHEIN, GRUNDLAGE_POG_ERMITTLUNG |
obiskennzahl | Product identification using the OBIS identifier PIA 5 SRW OBIS code PI 13017 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13011 13012 13003 13005 13007 13027 Z02 BDEW OBIS-like code PI 13016 13011 13013 13014 Z08 Medium PI 13023 13026 13020 13022 13021 | string |
wert | Energy quantity, quantity specification MSCONS QTY 136 Quantity reached in the time interval PI 21045 | number (float) |
einheit | Unit of measurement PI 13021 13023 13026 13020 13022 | stringW, WH, KW KWH, KVARH, MW, MWH, STUECK, KUBIKMETER, STUNDE, TAG, MONAT, JAHR, PROZENT, ANZAHL, VAR, KVAR, VARH, KWHK, Z16, KWT, WATT_PRO_QUADRATMETER, METER_PRO_SEKUNDE |
type | not in use | stringARBEITLEISTUNGTAGESPARAMETERABHMALO, VERANSCHLAGTEJAHRESMENGE, TUMKUNDENWERT |
tarifstufe | not in use | stringTARIFSTUFE_0, TARIFSTUFE_1, TARIFSTUFE_2 TARIFSTUFE_3, TARIFSTUFE_4, TARIFSTUFE_5, TARIFSTUFE_6, TARIFSTUFE_7, TARIFSTUFE_8, TARIFSTUFE_9 |
nutzungszeitpunkt | Time of use - unique meter reading assignment DTM 7 PI 13017 13002 13027 | string (date-time) |
ausfuehrungszeitpunkt | Execution / change point in time - design change date DTM 60 PI 13017 13002 | string (date-time) |
position | Line item data - indicates the start of a line item section, incrementing LIN 1 PI 13017 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13011 13012 13003 13023 13005 13026 13020 13022 13021 13007 13013 13014 13027 | integer |
ablesedatum | Meter reading date DTM 9 PI 13017 13002 | string (date-time) |
leistungsperiode | Power period DTM 306 PI 13016 13015 13013 | string |
| statuszusatzinformationen[ ] | . | object[] |
art | Z33 plausibility note STS Z33 | stringPLAUSIBILISIERUNGSHINWEIS, ERSATZWERTBILDUNGSVERFAHREN, KORREKTURGRUND GRUND_ERSATZWERTBILDUNGSVERFAHREN, GASQUALITAET, MESSKLASSIFIZIERUNG |
status | Status reason STS Z34 PI 13017 13019 13016 13002 13009 13018 13025 13008 13002 13007 | stringKUNDENSELBSTABLESUNG, LEERSTAND, REALER_ZAEHLERUEBERLAUF_GEPRUEFT PLAUSIBEL_WG_KONTROLLABLESUNG, PLAUSIBEL_WG_KUNDENHINWEIS, AUSTAUSCH_DES_ERSATZWERTES, RECHENWERT, BASIS_MME, VERGLEICHSMESSUNG_GEEICHT, VERGLEICHSMESSUNG_NICHT_GEEICHT, MESSWERTNACHBILDUNG_AUS_GEEICHTEN_WERTEN, MESSWERTNACHBILDUNG_AUS_NICHT_GEEICHTEN_WERTEN, INTERPOLATION, HALTEWERT, BILANZIERUNG_NETZABSCHNITT, HISTORISCHE_MESSWERTE, STATISTISCHE_METHODE, AUFTEILUNG, VERWENDUNG_VON_WERTEN_DES_STOERMENGENZAEHLWERKS, UMGANGS_UND_KORREKTURMENGEN, ANGABEN_MESSLOKATION, KEIN_ZUGANG, KOMMUNIKATIONSSTOERUNG, NETZAUSFALL, SPANNUNGSAUSFALL, STATUS_GERAETEWECHSEL, KALIBRIERUNG, GERAET_ARBEITET_AUSSERHALB_DER_BETRIEBSBEDINGUNGEN, MESSEINRICHTUNG_GESTOERT_DEFEKT, UNSICHERHEIT_MESSUNG, BERUECKSICHTIGUNG_STOERMENGENZAEHLWERK, MENGENUMWERTUNG_VOLLSTAENDIG, UHRZEIT_GESTELLT_SYNCHRONISATION, MESSWERT_UNPLAUSIBEL, FALSCHER_WANDLERFAKTOR, FEHLERHAFTE_ABLESUNG, AENDERUNG_DER_BERECHNUNG, UMBAU_DER_MESSLOKATION, DATENBEARBEITUNGSFEHLER, BRENNWERTKORREKTUR, Z_ZAHL_KORREKTUR, STOERUNG_DEFEKT_MESSEINRICHTUNG, AENDERUNG_TARIFSCHALTZEITEN, TARIFSCHALTGERAET_DEFEKT, IMPULSWERTIGKEIT_NICHT_AUSREICHEND, ENERGIEMENGE_IN_UNGEMESSENEM_ZEITINTERVALL, ENERGIEMENGE_AUS_DEM_UNGEPAIRTEN_ZEITINTERVALL, WARTUNGSARBEITEN_AN_GEEICHTEM_MESSGERAET, GESTOERTE_WERTE, WARTUNGSARBEITEN_AN_EICHRECHTSKONFORMEN_MESSGERAETEN, KONSISTENZ_UND_SYNCHRONPRUEFUNG, GRUND_ANGABEN_MESSLOKATION, ANFORDERUNG_IN_DIE_VERGANGENHEIT_ZUM_ANGEFORDERTEN_ZEITPUNKT_LIEGT_KEIN_WERT_VOR, UMSTELLUNG_GASQUALITAET, ZAEHLERSTAND_ZUM_BEGINN_DER_ANGEGEBENEN_ENERGIEMENGE_VORHANDEN_UND_KOMMUNIZIERT, ZAEHLERSTAND_ZUM_ENDE_DER_ANGEGEBENEN_ENERGIEMENGE_VORHANDEN_UND_KOMMUNIZIERT, ZAEHLERSTAND_ZUM_BEGINN_DER_ANGEGEBENEN_ENERGIEMENGE_NICHT_VORHANDEN_DA_MENGENABGRENZUNG, ZAEHLERSTAND_ZUM_ENDE_DER_ANGEGEBENEN_ENERGIEMENGE_NICHT_VORHANDEN_DA_MENGENABGRENZUNG, GESCHEITERT, AUSGEBAUT |