Reading backend interfaces
Read switching time definition
Read switching time definition
GET
https://mock.macoapp.de
/getDefinitionSwitch
Reading a switching time definition based on the configuration product code (Parameter1) at the point in time (Parameter3) | Reading a switchtime definition using konfigurationproduct-code (Parameter1) at the time (Parameter2)
query Parameters
| Structure (BO4E) | Description | Format |
|---|---|---|
parameter1* | Switching time 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 switching time definition › Responses
Successful reading of the switching time definition | Successful reading of the switchtime definition
Array of: Switching time 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 25006 DTM Z34 PI 25008 | string (date-time) |
endedatum | End of validity of the rolled-out definition DTM Z35 PI 25008 | string (date-time) |
version | new version specification for changes in content with completion date/time DTM 293 PI 25006 25008 | string (date-time) |
code | Switching time definition LOC Z09 PI 25008 | string |
notwendigkeit | Status of the use of definitions; the market partner states whether it uses definitions STS Z36 PI 25006 | stringZAEHLZEITDEFINITIONEN_WERDEN_VERWENDET, ZAEHLZEITDEFINITIONEN_WERDEN_NICHT_VERWENDET, DEFINITIONEN_WERDEN_VERWENDET DEFINITIONEN_WERDEN_NICHT_VERWENDET |
| schaltzeiten[ ] | . | object[] |
code | Code of the switching time definition CCI Z52 PI 17130 17122 17128 UTILTS PI 25006 REQOTE PI 35004 QUOTES PI 15004 | string |
aenderungszeitpunkt | Switching time change timestamp DTM Z44 PI 25008 | string (date-time) |
haeufigkeit | Frequency of transmission, indication of whether the switching time definition is transmitted annually or once CAV ZE0 PI 25006 | stringEINMALIG, JAEHRLICH |
uebermittelbarkeit | Transmissibility of the rolled-out definition CAV ZD5 PI 25004 | stringELEKTRONISCH, NICHT_ELEKTRONISCH |
schalthandlung | Switching operation at the location CCI Z58 PI 25008 | stringLEISTUNG_AN, LEISTUNG_AUS |
konfigurationsprodukt | Product identification - code list of the configurations Required product switching time definitions PIA 5 PI 17130 17128 REQOTE PI 35004 QUOTES PI 15004 | string |