Lesende Backend-Schnittstellen
Lokationsbündel lesen
Lokationsbündel lesen
GET
https://mock.macoapp.de
/getLocationBundleBasic
Lesen eines Lokationsbündels mittels LokationsId (Parameter1) zum Zeitpunkt (parameter3)
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) |
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 |
Lokationsbündel lesen › Responses
Erfolgreiches Lesen des Lokationsbündels | Successful reading of the location bundle
Array of: Lokationsbuendel — die Antwort ist eine Liste dieser Objekte, nicht ein einzelnes Objekt. Jeder Eintrag hat diesen Aufbau:
| Struktur (BO4E) | Beschreibung | Format |
|---|---|---|
boTyp* | . | 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 |
lokationsbuendelstrukturId | ID der Lokationsbündelstruktur | string |
lokationsbuendelNummer | Fortlaufende Nummer eines Lokationsbündels | integer |
standardisierteLokationsbuendelstruktur | Gibt an, ob sich die Struktur mittels eines Lokationsbündelstrukturcodes beschreiben lässt (Z31) oder ob es keinen passenden Lokationsbündelstrukturcode gibt (Z39). RFF Z31 Z39 55175 55180 55173 55177 55690 55035 55095 55060 55043 55168 55169 | boolean |
datenqualitaet | Referenz auf die Lokationsbündelstruktur. Lokationsbündelstrukturen, welche sich hinter einer Netzlokation befinden. SEQ Z78 Referenz auf die Lokationsbündelstruktur PI 55175 55173 55690 55043 55168 55169 SEQ ZC7 Erwartete Referenz auf die Lokationsbündelstruktur PI 55180 55177 SEQ ZC8 Im System vorhandene Referenz auf die Lokationsbündelstruktur PI 55180 55177 SEQ ZD5 Informative Referenz auf die Lokationsbündelstruktur PI 55035 55095 55060 SEQ Z58 Zuordnung Lokation zum Objektcode des Lokationsbündels PI 55175 55173 55690 55043 55168 55169 SEQ ZC9 Erwartete Zuordnung Lokation zum Objektcode des Lokationsbündels PI 55180 55177 SEQ ZD0 Im System vorhandene Zuordnung Lokation zum Objektcode des Lokationsbündels PI 55180 55177 SEQ ZD6 Informative Zuordnung Lokation zum Objektcode des Lokationsbündels PI 55035 55095 55060 | stringERWARTETE_DATEN, IM_SYSTEM_VORHANDENE_DATEN, INFORMATIVE_DATEN GUELTIGE_DATEN, KEINE_DATEN, IM_SYSTEM_KEINE_DATEN_VORHANDEN, KEINE_DATEN_ERWARTET, DIFFERENZ_DATEN, DIFFERENZ_ERWARTETE_DATEN, DIFFERENZ_IM_SYSTEM_VORHANDENE_DATEN |
| gueltigkeitszeitraum | Referenz auf Zeitraum-ID | object |
zeiteinheit | nicht in Benutzung | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Zeitspanne, Wert | integer |
startdatum | Datum aus DTM Z25 Verwendung der Daten ab DTM 163 Verarbeitung, Beginndatum/-zeit DTM 155 Rechnungsperiode, Beginndatum DTM Z42 vorläufiger Abrechnungszeitraum Beginn | string (date-time) |
enddatum | Datum aus DTM Z26 Verwendung der Daten bis DTM164 Verarbeitung, Endedatum/-zeit DTM 156 Rechnungsperiode, Endedatum DTM Z43 vorläufiger Abrechnungszeitraum Ende | string (date-time) |
einheit | nicht in Benutzung | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Turnusablesung des NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Termin, zu dem die Netznutzungsabrechnung des NB erfolgt DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | ZeitraumText | string |
zeitraumId | Referenz auf Zeitraum-ID RFF Z46 PI 25001 | integer |
| zuordnungObjectcode[ ] | Zuordnung Objectcode | object[] |
referenzLokationsTyp | Referenz auf die ID der Netzlokation, Marktlokation, Messlokation, Technischen Ressource RFF Z18 | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
referenzLokationsId | ID einer Lokation | string |
vorgelagerteLokationTyp | Referenz auf die ID der Netzlokation, Marktlokation, Messlokation, Technischen Ressource RFF Z18 | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
vorgelagerteLokationId | ID einer Lokation | string |
referenzMarktlokationTechnischeRessource[ ] | Referenz auf die der Technischen Ressource zugeordneten Marktlokation RFF Z16 PI 55035 55095 55060 55043 55168 55169 | string[] |
| objectcode[ ] | Objektcode der Lokation in der Lokationsbündelstruktur. Zur Referenzierung auf den Objektcode der (im Vorgang genannten) Lokationsbündelstruktur. RFF Z33 | object[] |
objectcode | Objectcode | string |
lokationsbuendelNummer | Fortlaufende Nummer eines Lokationsbündels | integer |