Expand description
Wire-format types for the EDI-Energy electricity market APIs.
Covers three API families:
- Control Measures (
controlMeasuresV1.yaml) — Steuerungshandlungen between NB/LF and MSB. - MaLo Identification (
maloIdentV1.yaml) — MaLo-ID retrieval for the 24 h supplier-switch process (GPKE part 2). - WiM Order (
wimOrderV1.yaml) — iMS Universalbestellprozess for smart meter commissioning (PIDs 11021–11023).
Structs§
- Command
Control - Regulate a location to a specific maximum power value.
- Command
Regular - Reset a location to its initial / uncontrolled state.
- Data
Controllable Resource - Data about a controllable resource (Steuerbare Ressource) at the market location.
- Data
Market Location - Full data about the identified market location.
- Data
Meter Location - Data about a metering location (Messlokation) at the market location.
- Data
Network Location - Data about a network location (Netzlokation) linked to the market location.
- Data
Technical Resource - Data about a technical resource (Technische Ressource) at the market location.
- Data
Tranche - A billing tranche at a market location.
- Identification
Parameter - Input parameters for a MaLo identification request.
- Identification
Parameter Address - Address-based identification parameters.
- Identification
Parameter Id - Optional ID-based identification parameters.
- MaloId
- Market location identifier — 11-digit string.
- Malo
Ident Result Negative - Negative identification result, referencing the applicable decision tree.
- Malo
Ident Result Positive - Positive identification result — all data the NB holds about the market
location from
identificationDateTimeonwards. - Market
Location Properties - Property of a market location valid for a specific time slice.
- Maximum
Power Value - Maximum power value in kW (
"\d{0,6}(\.\d{1,3})?"). - MeloId
- Metering location identifier — pattern
DE\d{11}[A-Z,\d]{20}. - NeloId
- Network location identifier — pattern
E[A-Z0-9]{9}[0-9]. - Person
Name - Person or company name.
- Postal
Address - German postal address.
- SrId
- Controllable resource identifier — pattern
C[A-Z0-9]{9}[0-9]. - SrMarket
Partner - Market partner assignment at a controllable resource.
- Time
Sliced Market Partner - A market partner assignment valid for a specific time slice.
- TrId
- Technical resource identifier — pattern
D[A-Z0-9]{9}[0-9]. - WimAblehnung
- Payload for a WiM Ablehnung (PID 11023) — MSB rejects the order.
- WimAnmeldung
Request - Payload for a WiM Anmeldung (PID 11021) — NB orders iMS installation from MSB.
- WimBestaetigung
- Payload for a WiM Bestätigung (PID 11022) — MSB confirms the order.
Enums§
- Energy
Direction - Energy flow direction at a market location.
- Location
Id - Either a network location ID or a controllable resource ID.
- Market
Location Property - Lifecycle property / category of a market location.
- Measurement
Technology Classification - Metering technology classification of a market location.
- Optional
Change Forecast Basis - Whether the forecast basis may be changed.
- Preliminary
State Positive - Preliminary state — command is executable in principle.
- Proportion
Type - Tranche proportion type.
- Reason
Negative - Reason for a negative response from the MSB.
- State
Negative - Terminal state for negative (failure) responses.
- State
Positive - Terminal state for positive (success) responses.
- State
Unknown - State indicating the final outcome is not yet known.
- WimDevice
Category - Device category for the iMS Universalbestellprozess.
- WimRejection
Reason - Rejection reason code for a WiM Ablehnung response.
Type Aliases§
- Initial
Transaction Id - Idempotency key for retries (UUID RFC 4122).
- Market
Partner Id - 13-digit market partner identifier.
- Reference
Id - External reference correlating a response to a prior request (UUID RFC 4122).
- Transaction
Id - External transaction ID (UUID RFC 4122), chosen by the sender.