Die Webservices des ene't Navigators sind [RESTful Services](https://en.wikipedia.org/wiki/Representational_state_transfer) und tauschen Daten im JSON Format aus.
Weitere Informationen: Authentifizierung | Fehlerbehandlung | FAQ
", "version": "" }, "servers": [ { "url": "https://ws.enet-navigator.de/hochlastzeitfenster" } ], "paths": { "/strom": { "get": { "tags": [ " " ], "summary": " ", "description": "Der Webservice ermittelt Hochlastzeitfenster für einen Netzbetreiber an einer Abnahmestelle.Dabei kann dem Webservice eine Liste von Abnahmefällen übergeben werden, für die jeweils eine Ermittlung durchgeführt wird. Mit einem Request können maximal 4000 Abnahmefälle zur Ermittlung übergeben werden.", "operationId": "getHochlastzeitfensterListUsingPOST", "requestBody": { "description": "apiList", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HochlastzeitfensterRequestApi" }, "example": [ { "identifier": 1, "jahr": 2022, "plz": 41836, "ort": "Hückelhoven", "ortsteil": "", "strasse": "Weserstr.", "hausnummer": "9", "spannungsebene": "NSP" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterWithId" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterWithId" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ], "x-codegen-request-body-name": "apiList" } }, "/strom/codenummer": { "get": { "tags": [ " " ], "summary": " ", "description": "Der Webservice ermittelt eine Liste von Hochlastzeitfenster für einen Netzbetreiber über die eingegebene Codenummer.
Durch Übergabe der Spannungsebene und des Betrachtungsjahres werden die relevanten Zeitfenster ermittelt.
Bei der Ermittlung anhand der Codenummer werden keine Feiertagsinformationen ausgegeben, da keine eindeutige Zuordnung möglich ist.", "operationId": "getHochlastzeitfensterCodenummerUsingGET", "parameters": [ { "name": "jahr", "in": "query", "description": "Jahr", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "codenummer", "in": "query", "description": "BDEW-Codenummer oder ILN-Codenummer des Netzbetreibers.", "required": true, "schema": { "type": "string" } }, { "name": "spannungsebene", "in": "query", "description": "Spannungsebene", "required": true, "schema": { "type": "string", "enum": [ "NSP", "MSP", "MSP_NSP_UMSP", "HSP", "HSP_MSP_UMSP" ] } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterCodenummer" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterCodenummer" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] }, "post": { "tags": [ " " ], "summary": " ", "description": "Der Webservice ermittelt eine Liste von Hochlastzeitfenster für einen Netzbetreiber über die eingegebene Codenummer.
Durch Übergabe der Spannungsebene und des Betrachtungsjahres werden die relevanten Zeitfenster ermittelt.
Bei der Ermittlung anhand der Codenummer werden keine Feiertagsinformationen ausgegeben, da keine eindeutige Zuordnung möglich ist.
Dabei kann dem Webservice eine Liste von Abnahmefällen übergeben werden, für die jeweils eine Ermittlung durchgeführt wird.
Mit einem Request können maximal 4000 Abnahmefälle zur Ermittlung übergeben werden.", "operationId": "getHochlastzeitfensterCodenummerListUsingPOST", "requestBody": { "description": "apiList", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HochlastzeitfensterCodenummerRequestApi" }, "example": [ { "identifier": 1, "jahr": 2026, "codenummer": 9900426000009, "spannungsebene": "NSP" } ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterCodenummerWithId" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterCodenummerWithId" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ], "x-codegen-request-body-name": "apiList" } } }, "components": { "schemas": { "BOReferenz": { "title": "BOReferenz", "type": "object", "properties": { "botyp": { "type": "string", "description": "Der Type des Objektes auf das verwiesen wird", "example": "MARKTTEILNEHMER", "enum": [ "ANGEBOT", "ANSPRECHPARTNER", "AUSSCHREIBUNG", "ENERGIEMENGE", "FREMDKOSTEN", "GESCHAEFTSPARTNER", "KOSTEN", "LASTGANG", "MARGE", "MARKTLOKATION", "MARKTTEILNEHMER", "MESSLOKATION", "NETZNUTZUNGSKOSTEN", "NETZNUTZUNGSRECHNUNG", "NETZPARAMETER", "PREISBLATT", "PREISBLATTDIENSTLEISTUNG", "PREISBLATTHARDWARE", "PREISBLATTKONZESSIONSABGABE", "PREISBLATTMESSUNG", "PREISBLATTNETZNUTZUNG", "RECHNUNG", "REGION", "REGIONALTARIF", "STANDORTEIGENSCHAFTEN", "STROMNETZPARAMETER", "TABELLE", "TARIF", "TARIFINFO", "TARIFKALKULATIONSPARAMETER", "TARIFKOSTEN", "TARIFPREISBLATT", "VERTRAG", "ZAEHLER", "ZEITREIHE" ] }, "referenz": { "type": "string", "description": "Hyperlink auf das Objekt.", "example": "" } }, "description": "Dient der Umsetzung von Verweisen zwischen Geschäftsobjekten." }, "Detail": { "title": "Detail", "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "fields": { "uniqueItems": true, "type": "array", "items": { "type": "string" } }, "indexes": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" } }, "information": { "type": "object", "properties": {} }, "message": { "type": "string" }, "values": { "uniqueItems": true, "type": "array", "items": { "type": "object", "properties": {} } } } }, "ErrorApi": { "title": "ErrorApi", "type": "object", "properties": { "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "type": { "type": "string", "enum": [ "AUTHENTICATION", "AUTHORIZATION", "CALCULATION", "ERROR", "HANDLING", "OUT_OF_MEMORY", "UNBEKANNT", "VALIDATION" ] }, "information": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "details": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Detail" } } } }, "ExterneReferenz": { "title": "ExterneReferenz", "type": "object", "properties": { "exRefName": { "type": "string", "description": "Bezeichnung der externen Referenz (z.B. „de.cursor.evi.gpnr“, „eu.enet.navigator.kundenid“)", "example": "" }, "exRefWert": { "type": "string", "description": "Wert der externen Referenz (z.B. \"123456\"; \"4711\")", "example": "" } }, "description": "Viele Datenobjekte weisen in unterschiedlichen Systemen eine eindeutige ID (Kundennummer, GP-Nummer etc.) auf. Beim Austausch von Datenobjekten zwischen verschiedenen Systemen ist es daher hilfreich, sich die eindeutigen IDs der anzubindenden Systeme zu merken. Diese Komponente ermöglicht es, sich die SAP GP-Nummer zu merken, um diese bei SAP-Aufrufen als Parameter mitgeben zu können." }, "Feiertag": { "title": "Feiertag", "type": "object", "properties": { "name": { "type": "string", "description": "Name/Bezeichnung des Feiertags.", "example": "" }, "datum": { "type": "string", "description": "Datum des Feiertags (ISO-Date)", "format": "date", "example": "" } }, "description": "Komponente zur Darstellung eines Feiertags." }, "HochlastProJahreszeit": { "title": "HochlastProJahreszeit", "type": "object", "properties": { "jahreszeit": { "type": "string", "description": "Eine der vier Jahreszeiten.", "example": "", "enum": [ "FRUEHLING", "SOMMER", "HERBST", "WINTER" ] }, "zeitbereich": { "$ref": "#/components/schemas/Zeitraum" }, "jahreszeitenfenster": { "type": "array", "description": "Die Lastzeitfenster für die Jahreszeit.", "items": { "$ref": "#/components/schemas/Lastzeitfenster" } } }, "description": "Modell für ein Hochlastzeitfenster pro Jahreszeit." }, "Hochlastzeitfenster": { "title": "Hochlastzeitfenster", "type": "object", "properties": { "jahreszeitenfenster": { "type": "array", "description": "Jahreszeitenfenster für Frühling ... Winter.", "items": { "$ref": "#/components/schemas/HochlastProJahreszeit" } }, "feiertage": { "type": "array", "description": "Die Feiertage für dieses Hochlastzeitfenster.", "items": { "$ref": "#/components/schemas/Feiertag" } } }, "description": "Modell für ein Hochlastzeitfenster." }, "HochlastzeitfensterOhneFeiertage": { "title": "HochlastzeitfensterOhneFeiertage", "type": "object", "properties": { "jahreszeitenfenster": { "type": "array", "description": "Jahreszeitenfenster für Frühling ... Winter.", "items": { "$ref": "#/components/schemas/HochlastProJahreszeit" } } }, "description": "Modell für ein Hochlastzeitfenster." }, "HochlastzeitfensterRequestApi": { "title": "HochlastzeitfensterRequestApi", "type": "object", "properties": { "identifier": { "type": "integer", "description": "Identifier um das Ergebnis der entsprechenden Anfrage zuzuordnen.", "format": "int32" }, "jahr": { "type": "integer", "description": "Jahr, für das die Hochlastzeitfenster ermittelt werden soll.", "format": "int32" }, "plz": { "type": "integer", "description": "Postleitzahl", "format": "int32" }, "ort": { "type": "string", "description": "Ort" }, "ortsteil": { "type": "string", "description": "Ortsteil" }, "strasse": { "type": "string", "description": "Straße" }, "hausnummer": { "type": "string", "description": "Hausnummer" }, "spannungsebene": { "type": "string", "description": "Spannungsebene", "enum": [ "NSP", "MSP", "MSP_NSP_UMSP", "HSP", "HSP_MSP_UMSP" ] } }, "description": "Diese Klasse fasst alle Parameter für den Hochlastzeitfenster Strom POST-Endpunkt zusammen, wenn über die Adresse ermittelt wird." }, "HochlastzeitfensterCodenummerRequestApi": { "title": "HochlastzeitfensterCodenummerRequestApi", "type": "object", "properties": { "identifier": { "type": "integer", "description": "Identifier um das Ergebnis der entsprechenden Anfrage zuzuordnen.", "format": "int32" }, "jahr": { "type": "integer", "description": "Jahr, für das das Hochlastzeitfenster ermittelt werden soll.", "format": "int32" }, "codenummer": { "type": "string", "description": "BDEW-Codenummer oder ILN-Codenummer des Netzbetreibers.", "example": "" }, "spannungsebene": { "type": "string", "description": "Spannungsebene", "enum": [ "NSP", "MSP", "MSP_NSP_UMSP", "HSP", "HSP_MSP_UMSP" ] } }, "description": "Diese Klasse fasst alle Parameter für den Hochlastzeitfenster Strom POST-Endpunkt zusammen, wenn über die Codenummer ermittelt wird." }, "Lastzeitfenster": { "title": "Lastzeitfenster", "type": "object", "properties": { "spannungsebene": { "type": "string", "description": "Spannungsebene für die das Lastzeitfenster gilt. ", "enum": [ "NSP", "MSP", "MSP_NSP_UMSP", "HSP", "HSP_MSP_UMSP" ], "example": "" }, "von": { "$ref": "#/components/schemas/LocalTime" }, "bis": { "$ref": "#/components/schemas/LocalTime" } }, "description": "Abbildung eines Lastzeitfensters. Das Ende des Tages wird mit 00:00 Uhr im Bis-Wert abgebildet." }, "LocalTime": { "title": "LocalTime", "type": "object", "properties": { "hour": { "type": "integer", "format": "int32", "example": "" }, "minute": { "type": "integer", "format": "int32", "example": "" }, "nano": { "type": "integer", "format": "int32", "example": "" }, "second": { "type": "integer", "format": "int32", "example": "" } } }, "Stromnetzparameter": { "title": "Stromnetzparameter", "type": "object", "properties": { "versionStruktur": { "minimum": 1, "exclusiveMinimum": false, "type": "integer", "description": "Geschäftsobjektversion", "format": "int32" }, "boTyp": { "type": "string", "description": "Typ des in mit dieser Struktur übertragenen Geschäftsobjektes", "example": "STROMNETZPARAMETER", "enum": [ "ANGEBOT", "ANSPRECHPARTNER", "AUSSCHREIBUNG", "ENERGIEMENGE", "FREMDKOSTEN", "GESCHAEFTSPARTNER", "KOSTEN", "LASTGANG", "MARGE", "MARKTLOKATION", "MARKTTEILNEHMER", "MESSLOKATION", "NETZNUTZUNGSKOSTEN", "NETZNUTZUNGSRECHNUNG", "NETZPARAMETER", "PREISBLATT", "PREISBLATTDIENSTLEISTUNG", "PREISBLATTHARDWARE", "PREISBLATTKONZESSIONSABGABE", "PREISBLATTMESSUNG", "PREISBLATTNETZNUTZUNG", "RECHNUNG", "REGION", "REGIONALTARIF", "STANDORTEIGENSCHAFTEN", "STROMNETZPARAMETER", "TABELLE", "TARIF", "TARIFINFO", "TARIFKALKULATIONSPARAMETER", "TARIFKOSTEN", "TARIFPREISBLATT", "VERTRAG", "ZAEHLER", "ZEITREIHE" ] }, "externeReferenzen": { "type": "array", "description": "Hier können ID`s anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer)", "items": { "$ref": "#/components/schemas/ExterneReferenz" } }, "netzbetreiber": { "$ref": "#/components/schemas/BOReferenz" }, "bilanzierungsgebietEIC": { "type": "string", "description": "Die EIC-Nummer des Bilanzierungsgebietes.", "example": "" }, "regelzone": { "type": "string", "description": "Der Name der Regelzone.", "example": "" }, "regelzoneEIC": { "type": "string", "description": "Die EIC-Nummer der Regelzone.", "example": "" }, "hochlastzeitfenster": { "$ref": "#/components/schemas/Hochlastzeitfenster" }, "schaltzeiten": { "type": "array", "description": "Die Zeitfenster für die Tarifschaltzeiten.", "items": { "$ref": "#/components/schemas/Tarifschaltzeit" } } }, "description": "Modellierung der Parameter eines Stromnetzes." }, "StromnetzparameterWithId": { "title": "StromnetzparameterWithId", "type": "object", "properties": { "identifier": { "type": "integer", "format": "int32" }, "stromnetzparameter": { "type": "array", "items": { "$ref": "#/components/schemas/Stromnetzparameter" } }, "error": { "$ref": "#/components/schemas/ErrorApi" } } }, "StromnetzparameterCodenummer": { "title": "StromnetzparameterCodenummer", "type": "object", "properties": { "versionStruktur": { "minimum": 1, "exclusiveMinimum": false, "type": "integer", "description": "Geschäftsobjektversion", "format": "int32" }, "boTyp": { "type": "string", "description": "Typ des in mit dieser Struktur übertragenen Geschäftsobjektes", "example": "STROMNETZPARAMETER", "enum": [ "ANGEBOT", "ANSPRECHPARTNER", "AUSSCHREIBUNG", "ENERGIEMENGE", "FREMDKOSTEN", "GESCHAEFTSPARTNER", "KOSTEN", "LASTGANG", "MARGE", "MARKTLOKATION", "MARKTTEILNEHMER", "MESSLOKATION", "NETZNUTZUNGSKOSTEN", "NETZNUTZUNGSRECHNUNG", "NETZPARAMETER", "PREISBLATT", "PREISBLATTDIENSTLEISTUNG", "PREISBLATTHARDWARE", "PREISBLATTKONZESSIONSABGABE", "PREISBLATTMESSUNG", "PREISBLATTNETZNUTZUNG", "RECHNUNG", "REGION", "REGIONALTARIF", "STANDORTEIGENSCHAFTEN", "STROMNETZPARAMETER", "TABELLE", "TARIF", "TARIFINFO", "TARIFKALKULATIONSPARAMETER", "TARIFKOSTEN", "TARIFPREISBLATT", "VERTRAG", "ZAEHLER", "ZEITREIHE" ] }, "externeReferenzen": { "type": "array", "description": "Hier können ID`s anderer Systeme hinterlegt werden (z.B. eine SAP-GP-Nummer)", "items": { "$ref": "#/components/schemas/ExterneReferenz" } }, "netzbetreiber": { "$ref": "#/components/schemas/BOReferenz" }, "bilanzierungsgebietEIC": { "type": "string", "description": "Die EIC-Nummer des Bilanzierungsgebietes.", "example": "" }, "regelzone": { "type": "string", "description": "Der Name der Regelzone.", "example": "" }, "regelzoneEIC": { "type": "string", "description": "Die EIC-Nummer der Regelzone.", "example": "" }, "hochlastzeitfenster": { "$ref": "#/components/schemas/HochlastzeitfensterOhneFeiertage" }, "schaltzeiten": { "type": "array", "description": "Die Zeitfenster für die Tarifschaltzeiten, ohne Angabe von Feiertagen.", "items": { "$ref": "#/components/schemas/Tarifschaltzeit" } } }, "description": "Modellierung der Parameter eines Stromnetzes." }, "StromnetzparameterCodenummerWithId": { "title": "StromnetzparameterCodenummerWithId", "type": "object", "properties": { "identifier": { "type": "integer", "format": "int32" }, "stromnetzparameter": { "type": "array", "items": { "$ref": "#/components/schemas/StromnetzparameterCodenummer" } }, "error": { "$ref": "#/components/schemas/ErrorApi" } } }, "Tarifschaltzeit": { "title": "Tarifschaltzeit", "type": "object", "properties": { "bilanzierungsmethode": { "type": "string", "description": "Tarifzeiten gelten entweder für SLP- oder RLM-Abnahmestellen. ", "enum": [ "RLM", "SLP" ], "example": "" }, "tarifzeit": { "type": "string", "description": "Welche Tarifzeit gilt zu den Zeiten.", "enum": [ "TZ_HT", "TZ_NT", "TZ_STANDARD" ], "example": "" }, "von": { "$ref": "#/components/schemas/LocalTime" }, "bis": { "$ref": "#/components/schemas/LocalTime" }, "tagestyp": { "type": "string", "description": "Angabe an welchen Tagen die Tarifzeit geschaltet wird.", "enum": [ "NEBENZEIT", "SONNFEIERTAG", "WERKTAG" ], "example": "" } }, "description": "Abbildung von Tarifschaltzeiten." }, "Zeitraum": { "title": "Zeitraum", "type": "object", "properties": { "einheit": { "type": "string", "description": "Die Einheit in der die Dauer angeben ist. Z.B. Monate.", "enum": [ "HALBJAHR", "JAHR", "MINUTE", "MONAT", "QUARTAL", "SEKUNDE", "STUNDE", "TAG", "VIERTEL_STUNDE", "WOCHE" ], "example": "" }, "dauer": { "type": "number", "description": "Gibt die Anzahl der Zeiteinheiten an, z.B. 3 (Monate).", "example": "" }, "startdatum": { "type": "string", "description": "Gibt den Tag an, an dem der Zeitraum startet.", "format": "date", "example": "" }, "enddatum": { "type": "string", "description": "Gibt den Tag an, an dem der Zeitraum endet.", "format": "date", "example": "" }, "startzeitpunkt": { "type": "string", "description": "Gibt Tag und Uhrzeit an, wann der Zeitraum startet", "format": "date-time", "example": "" }, "endzeitpunkt": { "type": "string", "description": "Gibt Tag und Uhrzeit an, wann der Zeitraum endet.", "format": "date-time", "example": "" } }, "description": "Diese Komponente wird zur Abbildung von Zeiträumen in Form von Dauern oder der Angabe von Start und Ende verwendet. Es muss daher entweder eine Dauer oder ein Zeitraum in Form von Start und Ende angegeben sein." } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }}