Schnittstelle für Presets und Qualitätskriterien
Allgemeines
Der EBS Manager ist eine Internet-Datenbank zur elektronischen Verwaltung von Energieberatungen und den zugehörigen Energiedaten.
Für Clientsoftware zur Erstellung von Energieberatungs-Protokollen (Energieberatungssoftware) bietet der EBS Manager ein SOAP Web Service an, um Presets und Qualitätskriterien abfragen zu können.
Sicherheit
Für die Clientsoftware ist ein Zugriff mittels TLS/SSL (HTTPS) erforderlich. Jeder Zugriff erfordert eine HTTP Authentifizierung nach der „Digest Access Authentication“ Methode. Benutzername und Passwort für den Zugriff auf das Web Service werden nach Unterfertigung der Nutzungsvereinbarung zur Verfügung gestellt.
Die Benutzung des Web Services ist pro Methode und IP-Adresse auf 50 Abfragen pro Tag limitiert. Diese Maßnahme soll vor Missbrauch schützen.
Server
Die Schnittstelle ist unter folgenden URLs verfügbar:
- Testumgebung: https://spielwiese-service.energieausweise.net/energieberatung/1.0/wsdl/
- Produktion: https://service.energieausweise.net/energieberatung/1.0/wsdl/
Implementierte Methoden
Die ZEUS Web Services implementieren folgende SOAP Methoden:
- lstEbPresets
- Liefert die vorhandenen Versionen der Presets.
- getEbPreset in Arbeit
- Liefert das Preset für ein Bundesland und eine Version.
- lstEbKriterien
- Liefert die vorhandenen Versionen der Qualitätskriterien.
- getEbKriterien
- Liefert Förderstellen und Qualitätskriterien für ein Bundesland und eine Version.
Versionen der Presets abrufen
Die Methode lstEbPresets liefert die vorhandenen Versionen für die Presets.
Parameter
Folgende Parameter werden erwartet:
| Parameter | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| bundesland | Bundesland | sbg |
nein |
Resultat
Als Resultat wird eine Liste von Versionen zurückgegeben:
| Eigenschaft | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| version | Version | 2021-05-26 |
nein |
Preset abrufen in Arbeit
Die Methode getEbPreset liefert ein Preset für eine Version und ein Bundesland.
Parameter
Folgende Parameter werden erwartet:
| Parameter | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| bundesland | Bundesland | sbg |
nein |
| version | Version | 2021-05-26 |
nein |
Resultat
Als Resultat wird eine Liste von Versionen zurückgegeben:
| Eigenschaft | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| version | Version | 2021-05-26 |
nein |
| systeme | Systeme | |
nein |
| konfiguration | Konfiguration | |
nein |
Versionen der Qualitätskriterien abrufen
Die Methode lstEbKriterien liefert die vorhandenen Versionen für die Qualitätskriterien.
Parameter
Folgende Parameter werden erwartet:
| Parameter | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| bundesland | Bundesland | sbg |
nein |
Resultat
Als Resultat wird eine Liste von Versionen zurückgegeben:
| Eigenschaft | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| version | Version | 2021-05-26 |
nein |
Förderstellen und Qualitätskriterien abrufen
Die Methode getEbKriterien liefert Förderstellen und Qualitätskriterien für ein Bundesland und eine Version.
Parameter
Folgende Parameter werden erwartet:
| Parameter | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| bundesland | Bundesland | sbg |
nein |
| version | Version | 2021-05-26 |
nein |
Resultat
Als Resultat wird eine Liste von Förderstellen und Qualitätskriterien zurückgegeben:
| Eigenschaft | Beschreibung | Beispielwert | optional |
|---|---|---|---|
| version | Version | 2021-05-26 |
nein |
| foerderstellen | Förderstellen | |
ja |
| kriterien | Kriterien | |
ja |