Lesende Backend-Schnittstellen
Zählerstand einer Lokation lesen
Zählerstand einer Lokation lesen
GET
https://mock.macoapp.de
/getEnergyAmountMeterReading
Lesen eines oder mehrerer Zählerstände über eine Lokation (Parameter1) in einer Range (Parameter2/Parameter3) und einer OBIS Kennzahl (Parameter4 optional)
query Parameters
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
parameter1* | LokationsId · Beispiel: 74018657187 · Vorgabe: 74018657187 | string |
parameter2* | LokationsTyp · Beispiel: MALO · Vorgabe: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Datum (Gültig ab) oder Stichtag, wenn parameter4 nicht gesetzt · Beispiel: 2024-06-28T12:18:00Z · Muster: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter4 | Datum (Gültig bis) · Beispiel: 2024-06-28T12:18:00Z · Muster: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$ | string (date-time) |
parameter5 | OBIS Kennzah · Beispiel: 123456789 | string |
command | Entspricht der operationId dieser Schnittstelle. Diese Operation Id entspricht dem Command im Camunda Konnektor Prozess. Wenn das Backend einen generischen Endpunkt bereitstellt, kann dieses Command gentutzt werden um zu definieren welche Operation ausgeführt werden soll. | string |
Zählerstand einer Lokation lesen › Responses
Erfolgreiches Lesen der Zählerstände | Successful reading of the meter readings
Array of: Energiemenge — die Antwort ist eine Liste dieser Objekte, nicht ein einzelnes Objekt. Jeder Eintrag hat diesen Aufbau:
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
boTyp* | Typ des 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 | Angabe der Identifikation, für den die Daten gelten 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 | Gibt an, ob es sich um eine Markt- oder Messlokation handelt. | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
fertigstellungsdatum | eindeutige Versionsnummer - Fertigstellungsdatum/-zeit DTM 293 PI 13010 13011 13012 13003 13023 13005 13026 13020 13022 13021 13007 13013 | string (date-time) |
startdatum | Beginn-Zeitpunkt des Übertragungszeitraumes 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 | Ende-Zeitpunkt des Übertragungszeitraumes 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 | Bilanzierungsmonat DTM 492 PI 13003 13023 13020 13013 | string (date-time) |
beginndatum | Gültigkeit, Beginndatum Profilschar DTM 157 PI 13011 | string (date-time) |
referenzStammdatenmeldungMsb | Referenz auf vorherige Stammdatenmeldung des MSB RFF Z30 PI 13002 | string |
konfiguration | Konfigurations-ID RFF AGK PI 13017 13019 | string |
| energieverbrauch[ ] | Gibt den Verbrauch in einer Zeiteinheit an. | object[] |
startdatum | Beginn Messperiode 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 | Ende Messperiode 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 | Messwert oder Prognosewert - bezieht sich auf die Statusangabe | stringPROGNOSE, MESSUNG |
messwertstatus | Statusangaben 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 | Produktidentifikation unter Verwendung des OBIS-Kennzeichens PIA 5 SRW OBIS-Kennzahl PI 13017 13019 13016 13015 13028 13002 13009 13018 13025 13008 13010 13011 13012 13003 13005 13007 13027 Z02 BDEW OBIS-ähnliche Kennzahl PI 13016 13011 13013 13014 Z08 Medium PI 13023 13026 13020 13022 13021 | string |
wert | Energiemenge, Mengenangabe MSCONS QTY 136 Erreichte Menge in dem Zeitintervall PI 21045 | number (float) |
einheit | Maßeinheit 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 | nicht in Benutzung | stringARBEITLEISTUNGTAGESPARAMETERABHMALO, VERANSCHLAGTEJAHRESMENGE, TUMKUNDENWERT |
tarifstufe | nicht in Benutzung | stringTARIFSTUFE_0, TARIFSTUFE_1, TARIFSTUFE_2 TARIFSTUFE_3, TARIFSTUFE_4, TARIFSTUFE_5, TARIFSTUFE_6, TARIFSTUFE_7, TARIFSTUFE_8, TARIFSTUFE_9 |
nutzungszeitpunkt | Nutzungszeitpunkt - eindeutige Zählerstandszuordnung DTM 7 PI 13017 13002 13027 | string (date-time) |
ausfuehrungszeitpunkt | Ausführungs- / Änderungszeitpunkt - Konstruktionsänderungsdatum DTM 60 PI 13017 13002 | string (date-time) |
position | Positionsdaten - zeigt den Beginn eines Positionsteils, Hochzählung 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 | Ablesedatum DTM 9 PI 13017 13002 | string (date-time) |
leistungsperiode | Leistungsperiode DTM 306 PI 13016 13015 13013 | string |
| statuszusatzinformationen[ ] | . | object[] |
art | Z33 Plausibilisierungshinweis STS Z33 | stringPLAUSIBILISIERUNGSHINWEIS, ERSATZWERTBILDUNGSVERFAHREN, KORREKTURGRUND GRUND_ERSATZWERTBILDUNGSVERFAHREN, GASQUALITAET, MESSKLASSIFIZIERUNG |
status | Statusanlaß 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 |