Reading backend interfaces
Read technical resource
Read technical resource
GET
https://mock.macoapp.de
/getTechnicalResourceBasic
Reading a technical resource using LocationId (Parameter1) at the point in time (Parameter2) | Reading a technical resource using location ID (Parameter1) at the time (Parameter2)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | Location ID | Location ID · Example: 74018657187 · Default: 74018657187 | string |
parameter2* | Location type | Location type · Example: MALO · Default: MALO | stringMALO, MELO, NELO TECHNISCHE_RESSOURCE, STEUERBARE_RESOURCE, TRANCHE |
parameter3* | Date (Valid from) | Date (Valid from) · 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) | 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) |
Read technical resource › Responses
Successful reading of the technical resource | Successful reading of the technical resource
Array of: Technical resource — 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 |
ressourcenId | ID of the technical resource, serves for the unique identification of a technical resource LOC Z20 PI 55002 55078 55600 55602 55601 55603 55013 55607 55617 55623 55629 55635 55175 55180 55173 55177 55690 55035 55095 55060 55043 RFF Z37 PI 55035 55095 55060 55043 55168 55169 RFF Z37 PI 17003 | string |
sparte | not in use | stringSTROM, GAS, FERNWAERME NAHWAERME, WASSER, ABWASSER |
lokationszuordnung | not in use | stringUNVERAENDERT, BEGINNT, ENDET |
referenzMesslokation | Reference to an ID of an upstream metering location, for determining energy quantities where there are several Melos. RFF Z34 PI 55043 55168 55169 | string |
referenzMarktlokation | Reference to an ID of the market locations assigned to a technical resource RFF Z16 PI 55175 55180 55173 55177 55690 55035 55095 55060 55043 55168 55169 | string |
referenzNetzlokation | Reference to an ID of the assigned grid location. RFF Z32 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | string |
referenzSteuerbareRessource | Reference to an ID of the controllable resource; this describes which SR is used to control the TR. RFF Z38 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | string |
referenzTranche | referenzTranche | string |
| nennleistung | Rated power of the technical resource; for consuming installations it is what the TR can draw, and for storage installations it is what the TR can draw to fill the storage unit. | object |
aufnahme | Rated power input QTY Z43 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | number (float) |
abgabe | Output of the rated capacity QTY Z44 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | number (float) |
speicherkapazitaet | Storage capacity that can be stored by the TR. Specified in kWh. QTY Z42 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | number (float) |
verbrauchsart[ ] | Consumption type | string[]KL, W, EMOB SB, SW, WK |
waermenutzung | in the case of heat utilisation, the more precise specification of the heat utilisation is defined here. CAV Z56 PI 55617 55623 55629 55635 55035 55060 55043 55168 55169 | stringSPEICHERHEIZUNG, WAERMEPUMPE, DIREKTHEIZUNG WAERMEPUMPE_WAERME_KAELTE, WAERMEPUMPE_KAELTE, WAERMEPUMPE_WAERME |
artEMobilitaet | Defines the more precise type of e-mobility. CAV ZE6 PI 55617 55623 55629 55635 55035 55060 55043 55168 55169 | stringWB, LS, LP |
erzeugungsart | Type of energy generation CAV ZF5 PI 55617 55623 55629 55635 55095 55060 55043 55168 55169 | stringEEG, KWK, EEG_DV KWK_DV, WIND, SOLAR, KERNKRAFT, WASSER, GEOTHERMIE, BIOMASSE, KOHLE, GAS, SONSTIGE, SONSTIGE_EEG, SONSTIGE_ERZEUGUNGSART |
speicherart | Storage type CAV ZF7 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | stringWASSERSTOFFSPEICHER, PUMPSPEICHER, BATTERIESPEICHER SONSTIGE_SPEICHERART |
enwg | Category of the consuming technical resource ZG8 Technical resource falls under § 14a EnWG ZG9 Technical resource does not fall under § 14a EnWG CAV ZG8 PI 55617 55623 55629 55635 55035 55060 55043 55168 55169 | boolean |
inbetriebsetzungsdatum | Commissioning date of the consuming technical resource pursuant to § 14a EnWG CAV ZH0 PI 55617 55623 55035 | stringINBETRIEBSETZUNG_NACH_2023, INBETRIEBSETZUNG_VOR_2024 |
einordnung | Classification of the consuming technical resource in accordance with § 14a EnWG with commissioning before 2024 CAV ZH2 PI 55617 55623 55035 | stringWECHSELMOEGLICHKEIT_EINMALIG_NOCH_MOEGLICH, WECHSELMOEGLICHKEIT_NICHT_MOEGLICH, BEFRISTET_OHNE_WECHSELMOEGLICHKEIT WECHSEL_WURDE_DURCHGEFUEHRT |
weitereEinrichtung | Information on further technical devices. These devices were not exchanged in market communication. ZH7 Further technical devices present ZH8 No further technical device present CAV ZH7 PI 55617 55623 55629 55635 55035 55060 55043 55168 55169 | boolean |
art | Type and use of the technical resource CCI Z17 PI 55617 55623 55629 55635 55035 55095 55060 55043 55168 55169 | stringSTROMERZEUGUNG, STROMVERBRAUCH, SPEICHER |
datenqualitaet | Introduces segment group SEQ Z52 Data of the technical resource SEQ ZF0 Informational data of the technical resource SEQ ZG4 Expected data of the technical resource SEQ ZG5 Data of the technical resource present in the system | 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 |
| erforderlicheProdukte[ ] | required products | object[] |
produktCode | Product code Required product billing data ORDERS PIA 5 PI 17133 | string |
codeProdukteigenschaft | Code of the product property CAV ZH9 PI 55001 55077 55600 55601 55014 55608 | string |
wertedetails | Value details for the product, value details for the product are described in the code list of the configurations CAV ZV4 PI 55001 55077 55600 55601 55014 55608 | string |
fernsteuerbarkeit | fernsteuerbarkeit | boolean |
verguetungsverpflichtung | verguetungsverpflichtung | boolean |