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/bo4e-repository" } ], "tags": [ { "name": "Bo4e-Repository", "description": "Mit diesen Enpunkten können Daten in das Bo4e Repository gespeichert, aus den Bo4e Repository Daten gelöscht und vom Bo4e Repository Daten geholten werden." } ], "paths": { "/bo4e": { "post": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e", "description": "Dieser Webservice speichert die übergebenen BOs im Bo-Repository ab.
", "operationId": "saveBoUsingPOST", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } } ], "requestBody": { "description": "boRepositoryTransferApi", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BORepositoryTransferApi" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/Validierungsergebnis" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Validierungsergebnis" } } } }, "201": { "description": "Created", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ], "x-codegen-request-body-name": "boRepositoryTransferApi" } }, "/bo4e/content/{processId}/{boType}": { "get": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e/content/{processId}/{boType}", "description": "Dieser Webservice liefert den Inhalt des BO aus dem Bo-Repository, das zu der Prozess-Id gehört und den angegebenen Bo-Typ hat.
", "operationId": "getBoContentWithBoTypeUsingGET", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } }, { "name": "boType", "in": "path", "description": "BusinessObject-Typ", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] } }, "/bo4e/{processId}": { "delete": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e/{processId}", "description": "Dieser Webservice löscht alle BOs aus dem Bo-Repository, die zu der Prozess-Id gehören. Zurückgegeben wird die Anzahl der gelöschten BOs
", "operationId": "deleteBoUsingDELETE", "parameters": [ { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "security": [ { "basicAuth": [] } ] } }, "/bo4e/{processId}/boid": { "get": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e/{processId}/boid", "description": "Dieser Webservice ermittelt das BO aus dem Bo-Repository, das zu der Prozess-Id gehört und die angegebene Bo-Id hat.
", "operationId": "getSingleBoWithBoIdUsingGET", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } }, { "name": "boId", "in": "query", "description": "Id des BusinessObject", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BORepositoryTransferApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BORepositoryTransferApi" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] } }, "/bo4e/{processId}/{boType}": { "get": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e/{processId}/{boType}", "description": "Dieser Webservice ermittelt alle BOs aus dem Bo-Repository, die zu der Prozess-Id gehören und den angegebenen Bo-Typ haben.
", "operationId": "getAllBoWithBoTypeUsingGET", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } }, { "name": "boType", "in": "path", "description": "BusinessObject-Typ", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } }, { "name": "withOlderBo4e", "in": "query", "description": "Sollen auch alte Daten ausgegeben werden", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BORepositoryTransferApi" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BORepositoryTransferApi" } } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] }, "delete": { "tags": [ "Bo4e-Repository" ], "summary": "/bo4e/{processId}/{boType}", "description": "Dieser Webservice löscht alle BOs aus dem Bo-Repository, die zu der Prozess-Id gehören und den angegebenen Bo-Typ haben. Zurückgegeben wird die Anzahl der gelöschten BOs
", "operationId": "deleteBoWithBoTypeUsingDELETE", "parameters": [ { "name": "boType", "in": "path", "description": "BusinessObject-Typ", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "integer", "format": "int64" } } } }, "204": { "description": "No Content", "content": {} }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} } }, "security": [ { "basicAuth": [] } ] } }, "/singlebo4e/content/{processId}/{boType}": { "get": { "tags": [ "Bo4e-Repository" ], "summary": "/singlebo4e/content/{processId}/{boType}", "description": "Dieser Webservice ermittelt genau ein BO aus dem Bo-Repository, das zu der Prozess-Id gehört und den angegebenen Bo-Typ hat. Gibt es mehr als ein passendes BO wird eine Exception geworfen.
", "operationId": "getSingleBoContentWithBoTypeUsingGET", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } }, { "name": "boType", "in": "path", "description": "BusinessObject-Typ", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "object" } }, "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] } }, "/singlebo4e/{processId}/{boType}": { "get": { "tags": [ "Bo4e-Repository" ], "summary": "/singlebo4e/{processId}/{boType}", "description": "Dieser Webservice ermittelt genau ein BO aus dem Bo-Repository, das zu der Prozess-Id gehört und den angegebenen Bo-Typ hat. Gibt es mehr als ein passendes BO wird eine Exception geworfen.
", "operationId": "getSingleBoWithBoTypeUsingGET", "parameters": [ { "name": "access_token", "in": "query", "description": "access_token der aufrufenden App", "schema": { "type": "string" } }, { "name": "boType", "in": "path", "description": "BusinessObject-Typ", "required": true, "schema": { "type": "string" } }, { "name": "processId", "in": "path", "description": "Id des Prozesses", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "$ref": "#/components/schemas/BORepositoryTransferApi" } }, "application/json": { "schema": { "$ref": "#/components/schemas/BORepositoryTransferApi" } } } }, "401": { "description": "Unauthorized", "content": {} }, "403": { "description": "Forbidden", "content": {} }, "404": { "description": "Not Found", "content": {} } }, "security": [ { "basicAuth": [] } ] } } }, "components": { "schemas": { "BORepositoryTransferApi": { "title": "BORepositoryTransferApi", "type": "object", "properties": { "boContent": { "type": "array", "description": "Der BO-Typ.", "items": { "type": "object", "properties": {} } }, "boId": { "type": "string", "description": "Die BO-ID." }, "boTyp": { "type": "string", "description": "Der BO-Typ.", "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" ] }, "erzeugtAm": { "type": "string", "description": "Datum und Uhrzeit der Erzeugung.", "format": "date-time" }, "mandantId": { "type": "integer", "description": "Die Mandant-ID.", "format": "int32" }, "modifiziertAm": { "type": "string", "description": "Datum und Uhrzeit der Modifizierung.", "format": "date-time" }, "prozessId": { "type": "string", "description": "Die Prozess-ID." }, "prozessSchritt": { "type": "string", "description": "Der Prozessschritt." }, "prozessSchrittUserId": { "type": "integer", "description": "Der User des Prozessschritts.", "format": "int32" }, "versionStruktur": { "type": "integer", "description": "Die Versionsstruktur.", "format": "int32" } }, "description": "..." }, "Validierungsergebnis": { "title": "Validierungsergebnis", "type": "object", "properties": { "validierungsErgebnisse": { "type": "array", "description": "Die einzelnen Ergebnisse der Validierung mit Hinweisen zu den Abweichungen zum Standard", "items": { "type": "string" } }, "validierungsStatus": { "type": "string", "description": "Der Status der Validierung: hier wird der Status der Konformität zum Standard angegeben", "enum": [ "BO_IST_KONFORM", "BO_IST_NICHT_KONFORM" ] } }, "description": "Das Ergebnis eines Validierungsaufrufs" } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }}