Reading backend interfaces
Read location bundle
Read location bundle
GET
https://mock.macoapp.de
/getLocationBundleBasic
Reading a location bundle using the location ID (Parameter1) at the point in time (parameter3)
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 to) · 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) |
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 location bundle › Responses
Successful reading of the location bundle | Successful reading of the location bundle
Array of: Location bundle — the response is a list of these objects, not a single object. Every entry has this structure:
| Structure (BO4E) | Description | 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 of the location bundle structure | string |
lokationsbuendelNummer | Sequential number of a location bundle | integer |
standardisierteLokationsbuendelstruktur | Indicates whether the structure can be described by a location bundle structure code (Z31) or whether there is no matching location bundle structure code (Z39). RFF Z31 Z39 55175 55180 55173 55177 55690 55035 55095 55060 55043 55168 55169 | boolean |
datenqualitaet | Reference to the location bundle structure. Location bundle structures that are located behind a grid location. SEQ Z78 Reference to the location bundle structure PI 55175 55173 55690 55043 55168 55169 SEQ ZC7 Expected reference to the location bundle structure PI 55180 55177 SEQ ZC8 Reference to the location bundle structure present in the system PI 55180 55177 SEQ ZD5 Informational reference to the location bundle structure PI 55035 55095 55060 SEQ Z58 Assignment of the location to the object code of the location bundle PI 55175 55173 55690 55043 55168 55169 SEQ ZC9 Expected assignment of the location to the object code of the location bundle PI 55180 55177 SEQ ZD0 Assignment of the location to the object code of the location bundle present in the system PI 55180 55177 SEQ ZD6 Informational assignment of the location to the object code of the location bundle 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 | Reference to time period ID | object |
zeiteinheit | not in use | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
dauer | Time span, value | integer |
startdatum | Date from DTM Z25 Use of the data from DTM 163 Processing, start date/time DTM 155 Invoicing period, start date DTM Z42 Provisional billing period start | string (date-time) |
enddatum | Date from DTM Z26 Use of the data until DTM164 Processing, end date/time DTM 156 Invoicing period, end date DTM Z43 Provisional billing period end | string (date-time) |
einheit | not in use | stringSEKUNDE, MINUTE, STUNDE VIERTEL_STUNDE, TAG, WOCHE, MONAT, QUARTAL, HALBJAHR, JAHR |
ableseZeitraum | Periodic meter reading of the NB DTM 752 PI 44113 44140 44142 44043 44168 44169 44060 | string |
abrechnungsZeitraum | Date on which the grid usage settlement of the NB takes place DTM Z21 PI 44112 44139 44142 44002 44013 44014 44035 | string |
zeitraumText | Period text | string |
zeitraumId | Reference to period ID RFF Z46 PI 25001 | integer |
| zuordnungObjectcode[ ] | Assignment object code | object[] |
referenzLokationsTyp | Reference to the ID of the grid location, market location, metering location, technical resource RFF Z18 | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
referenzLokationsId | ID of a location | string |
vorgelagerteLokationTyp | Reference to the ID of the grid location, market location, metering location, technical resource RFF Z18 | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESSOURCE, TRANCHE, MABIS_ZAEHLPUNKT |
vorgelagerteLokationId | ID of a location | string |
referenzMarktlokationTechnischeRessource[ ] | Reference to the market location assigned to the technical resource RFF Z16 PI 55035 55095 55060 55043 55168 55169 | string[] |
| objectcode[ ] | Object code of the location in the location bundle structure. For referencing the object code of the location bundle structure (named in the case). RFF Z33 | object[] |
objectcode | Object code | string |
lokationsbuendelNummer | Sequential number of a location bundle | integer |