{ "openapi": "3.0.1", "info": { "title": "Standorteigenschaften", "description": "

Allgemeines

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/standorteigenschaften" } ], "paths": { "/standorteigenschaften": { "get": { "tags": [" "], "summary": " ", "description": "

Mit diesem Webservice können regionale und Energienetz-bezogene Eigenschaften auf der Grundlage einer Standortangabe abgefragt werden.
Der Standort kann dabei als vollständige Adresse oder unspezifisch als Postleitzahl oder Postort vorgegeben werden. Als Ergebnis der Abfrage wird eine Liste von BOs Standorteigenschaften zurückgegeben.

", "operationId": "getStandorteigenschaftenUsingGET", "parameters": [ { "name": "stichtag", "in": "query", "description": "Der Stichtag, zu dem Informationen ermittelt werden. Es muss entweder ein Stichtag oder ein Zeitraum (von-bis) angegeben werden. Wenn beide Informationen angegeben sind, dann hat die Stichtagsangabe Priorität.", "schema": { "type": "string", "format": "date" } }, { "name": "zeitraumVon", "in": "query", "description": "Der Beginn des Betrachtungszeitraums, in dem Informationen ermittelt werden. Es muss entweder ein Stichtag oder ein Zeitraum (von-bis) angegeben werden. Wenn beide Informationen angegeben sind, dann hat die Stichtagsangabe Priorität.", "schema": { "type": "string", "format": "date" } }, { "name": "zeitraumBis", "in": "query", "description": "Das Ende des Betrachtungszeitraums, in dem Informationen ermittelt werden. Es muss entweder ein Stichtag oder ein Zeitraum (von-bis) angegeben werden. Wenn beide Informationen angegeben sind, dann hat die Stichtagsangabe Priorität.", "schema": { "type": "string", "format": "date" } }, { "name": "plz", "in": "query", "description": "Postleitzahl", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "ort", "in": "query", "description": "Ort", "schema": { "type": "string" } }, { "name": "strasse", "in": "query", "description": "Straße", "schema": { "type": "string" } }, { "name": "hausnummer", "in": "query", "description": "Hausnummer", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Standorteigenschaften" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Standorteigenschaften" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "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." }, "Marktgebietinfo": { "title": "Marktgebietinfo", "type": "object", "properties": { "marktgebiet": { "type": "string", "description": "Der Name des Marktgebietes", "example": "" }, "marktgebietcode": { "type": "string", "description": "Die standardisierte Codenummer des Marktgebietes", "example": "" } }, "description": "Informationen zum Marktgebiet im Gas" }, "NetzinformationGasResponseApi": { "title": "NetzinformationGasResponseApi", "type": "object", "properties": { "kaId": { "type": "integer", "description": "Identifikationsnummer der Konzessionsabgabe", "format": "int32" }, "marktgebietIds": { "type": "array", "description": "Identifikationsnummer des Marktgebiets", "items": { "type": "integer", "format": "int32" } }, "netzbereich": { "type": "integer", "description": "Netzbereich", "format": "int32" }, "netznummer": { "type": "integer", "description": "Die zusammengesetzte Netznummer(6-stelliges VNBG + 2-stelliges Teilnetz + 2-stelliuges Netzbereich)", "format": "int64" }, "tarifgebietId": { "type": "integer", "description": "Identifikationsnummer des Tarifgebiets", "format": "int32" }, "teilnetz": { "type": "integer", "description": "Teilnetznummer", "format": "int32" }, "vnb": { "type": "integer", "description": "Die Verteilnetzbetreibernummer", "format": "int32" } }, "description": "Netzinformation für den Bereich Gas" }, "NetzinformationGasZeitraumResponseApi": { "title": "NetzinformationGasZeitraumResponseApi", "type": "object", "properties": { "kaId": { "type": "integer", "description": "Identifikationsnummer der Konzessionsabgabe", "format": "int32" }, "marktgebietIds": { "type": "array", "description": "Identifikationsnummer des Marktgebiets", "items": { "type": "integer", "format": "int32" } }, "netzbereich": { "type": "integer", "description": "Netzbereich", "format": "int32" }, "netznummer": { "type": "integer", "description": "Die zusammengesetzte Netznummer(6-stelliges VNBG + 2-stelliges Teilnetz + 2-stelliuges Netzbereich)", "format": "int64" }, "tarifgebietId": { "type": "integer", "description": "Identifikationsnummer des Tarifgebiets", "format": "int32" }, "teilnetz": { "type": "integer", "description": "Teilnetznummer", "format": "int32" }, "vnb": { "type": "integer", "description": "Die Verteilnetzbetreibernummer", "format": "int32" }, "gueltigVon": { "type": "string", "description": "Gueltigkeit von", "format": "date" }, "gueltigBis": { "type": "string", "description": "Gueltigkeit bis", "format": "date" } }, "description": "Netzinformation für den Bereich Gas" }, "NetzinformationStromResponseApi": { "title": "NetzinformationStromResponseApi", "type": "object", "properties": { "kaId": { "type": "integer", "description": "Identifikationsnummer der Konzessionsabgabe", "format": "int32" }, "netznummer": { "type": "integer", "description": "Die Netznummer", "format": "int32" }, "regelgebietId": { "type": "integer", "description": "Identifikationsnummer des Regelgebiets", "format": "int32" }, "vnb": { "type": "integer", "description": "Die Verteilnetzbetreibernummer", "format": "int32" } }, "description": "Netzinformation für den Bereich Strom" }, "NetzinformationStromZeitraumResponseApi": { "title": "NetzinformationStromZeitraumResponseApi", "type": "object", "properties": { "kaId": { "type": "integer", "description": "Identifikationsnummer der Konzessionsabgabe", "format": "int32" }, "netznummer": { "type": "integer", "description": "Die Netznummer", "format": "int32" }, "regelgebietId": { "type": "integer", "description": "Identifikationsnummer des Regelgebiets", "format": "int32" }, "vnb": { "type": "integer", "description": "Die Verteilnetzbetreibernummer", "format": "int32" }, "gueltigVon": { "type": "string", "description": "Gueltigkeit von", "format": "date" }, "gueltigBis": { "type": "string", "description": "Gueltigkeit bis", "format": "date" } }, "description": "Netzinformation für den Bereich Strom" }, "Standorteigenschaften": { "title": "Standorteigenschaften", "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": "STANDORTEIGENSCHAFTEN", "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" } }, "eigenschaftenAllgemein": { "$ref": "#/components/schemas/StandorteigenschaftenAllgemein" }, "eigenschaftenStrom": { "type": "array", "description": "Eigenschaften zur Sparte Strom", "items": { "$ref": "#/components/schemas/StandorteigenschaftenStrom" } }, "eigenschaftenGas": { "type": "array", "description": "Eigenschaften zur Sparte Gas", "items": { "$ref": "#/components/schemas/StandorteigenschaftenGas" } } }, "description": "In diesem BO werden die regionalen und spartenspezifischen Eigenschaften einer gegebenen Adresse modelliert." }, "StandorteigenschaftenAllgemein": { "title": "StandorteigenschaftenAllgemein", "type": "object", "properties": { "postleitzahl": { "type": "string", "description": "Die Postleitzahl des Standorts", "example": "" }, "ort": { "type": "string", "description": "Die Ortsbezeichnung des Standorts", "example": "" }, "kreisname": { "type": "string", "description": "Der Name des Kreises in dem der Standort liegt", "example": "" }, "gemeindename": { "type": "string", "description": "Der Name der Gemeinde des Standortes", "example": "" }, "gemeindekennziffer": { "type": "string", "description": "Die standardisierte Kennziffer der Gemeinde", "example": "" }, "gemeindeeinwohner": { "type": "integer", "description": "Anzahl der Einwohner in der Gemeinde", "format": "int32", "example": "" }, "bundesland": { "type": "string", "description": "Das Bundesland zu dem der Standort gehört", "example": "" } }, "description": "Allgemeine Standorteigenschaften" }, "StandorteigenschaftenGas": { "title": "StandorteigenschaftenGas", "type": "object", "properties": { "netzkontonummern": { "type": "array", "description": "Netzkontonummern der Gasnetze", "items": { "type": "string", "example": "" } }, "marktgebiete": { "type": "array", "description": "Die Informationen zu Marktgebieten in dem Netz. Details siehe COM Marktgebietinfo", "items": { "$ref": "#/components/schemas/Marktgebietinfo" } } }, "description": "Standorteigenschaften der Sparte Gas" }, "StandorteigenschaftenStrom": { "title": "StandorteigenschaftenStrom", "type": "object", "properties": { "bilanzierungsgebiet_EIC": { "type": "string", "description": "Die EIC-Nummer des Bilanzierungsgebietes", "example": "" }, "regelzone": { "type": "string", "description": "Der Name der Regelzone", "example": "" }, "regelzone_EIC": { "type": "string", "description": "Die EIC-Nummer der Regelzone", "example": "" } }, "description": "Standorteigenschaften der Sparte Strom" } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }}