Reading backend interfaces
Read counting time definition
Read counting time definition
GET
https://mock.macoapp.de
/getDefinitionCounting
Reading a metering time definition based on the code (Parameter1) at the point in time (Parameter3) | Reading a perfomance definition using code (Parameter1) at the time (Parameter2)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | Metering time period definition · 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 counting time definition › Responses
Successful reading of the metering time period definition | Successful reading of the counting definition
Array of: Counting period definition — 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 |
beginndatum | Validity, start date - indication of the point in time at which the definition becomes valid DTM 157 PI 25004 DTM Z34 PI 25005 PI | string (date-time) |
endedatum | End of validity of the rolled-out definition DTM Z35 PI 25005 | string (date-time) |
version | Version of the metering time period definition as a date | string (date-time) |
notwendigkeit | Status of the use of definitions; the market partner states whether it uses definitions STS Z36 PI 25004 | stringZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET, ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET, DEFINITIONEN_WERDEN_VERWENDET DEFINITIONEN_WERDEN_NICHT_VERWENDET |
versionsangabe | new version specification for changes in content with completion date/time DTM 293 PI 25004 25005 | string |
code | Metering time period definition LOC Z09 PI 25005 | string |
| zaehlzeiten[ ] | . | object[] |
code | Code of the metering time period definition CCI Z39 PI 17122 UTILTS PI 25004 | string |
haeufigkeit | Frequency of transmission, whether the metering time period definition is to be transmitted annually or only once CAV ZE0 PI 25004 | stringEINMALIG, JAEHRLICH |
uebermittelbarkeit | Transmissibility of the rolled-out definition CAV ZD5 PI 25004 | stringELEKTRONISCH, NICHT_ELEKTRONISCH |
ermittlungLeistungsmaximum | Determination of the maximum demand for atypical grid usage, whether the grid operator uses high-load time windows in the determination CAV ZD4 PI 25004 | stringVERWENDUNG_HOCHLASTFENSTER, KEINE_VERWENDUNG_HOCHLASTFENSTER |
istBestellbar | Orderability of the metering time period definition Z27 metering time period definition can be ordered Z28 metering time period definition cannot be ordered CAV ZD7 PI 25004 | boolean |
typ | Metering time period definition type CAV ZD3 PI 25004 | stringWAERMEPUMPE, NACHTSPEICHERHEIZUNG, SCHWACHLASTZEITFENSTER SONSTIGE, HOCHLASTZEITFENSTER |
beschreibungTyp | Description of the metering time period definition type in text form | string |
aenderungszeitpunkt | Metering time change point in time, switch to a new active metering time register DTM Z33 PI 25005 | string (date-time) |
register | Counting register RFF Z28 PI 25005 | string |
| zaehlzeitregister[ ] | List of the metering time period registers | object[] |
register | Code of the metering time period register CCI Z38 PI 55218 55220 55640 55645 55650 55655 55660 55665 55643 55648 55653 55658 55663 55669 55553 55555 55035 55060 55043 55168 55169 UTILTS CCI Z38 PI 25004 | string |
zaehlzeitDefinition | Code of the metering time period definition CCI Z39 PI 55218 55220 55035 55640 55645 55650 55655 55660 55665 55643 55648 55653 55658 55663 55669 55553 55555 55060 55043 55168 55169 CCI Z41 No metering time period required for the metering product PI 55060 55043 55168 55169 Z39 Code of the metering time period definition ORDERS Z41 No metering time period required for the metering product ORDERS CCI Z39 PI 17123 17121 17118 17134 17135 UTILTS RFF Z27 PI 25004 | string |
schwachlastfaehig | Off-peak capability of the register; this states whether an off-peak capability is required for the concession levy. Z59 Not off-peak capable Z60 Off-peak capable CCI Z10 PI 25004 | stringSCHWACHLASTFAEHIG, NICHT_SCHWACHLASTFAEHIG |