EigenruecknahmesystemHerstellerlisteService Service
Der EigenruecknahmesystemHerstellerlisteService stellt verschiedene Funktionen zum Umgang mit der Herstellerliste eines Eigenrücknahmesystems zur Verfügung.
Es ist möglich den aktuellen Stand der Herstellerliste abzufragen. Diese stellt den zuletzt bearbeiteten Zustand dar, wie er auch im Portal sichtbar ist. Daraus kann nicht abgeleitet werden, welche Hersteller aktuell für das BattG-Eigenrücknahmesystem genehmigt wurden.
Der Liste können neue Einträge hinzugefügt oder bestehende geändert werden. Insbesondere ist es möglich, Einträge zu bestätigen, die durch eine Zuordnung des Eigenrücknahmesystems durch einen Hersteller entstanden sind.
- Namespace
- http://www.ear-system.de/ear-soap/v2
- WSDL
- /EigenruecknahmesystemHerstellerlisteService?wsdl
- Verfügbar ab
- 2.5
isAlive Operation
Diese Funktion beinhaltet eine Abfrage, welche prüft, ob der SOAP Service aktiv ist. Dies ist vergleichbar mit einem Ping.
- Verfügbar ab
- 2.5
| Typ | Beschreibung |
|---|---|
| StandardResponse | Text Service verfügbar, wenn verfügbar. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException | Service ist nicht verfügbar oder interner Serverfehler |
getHerstellerliste Operation
Abrufen aller Herstellerliste-Einträge des angemeledeten Eigenrücknahmesystems. Ausgeliefert werden alle Einträge, die auch im Portal sichtbar sind. Darüber hinaus können weitere Filterkriterien angegeben werden.
Gelöschte Einträge werden nicht mehr ausgeliefert.
Alle Parameter dieser Funktion (bis auf page) definieren Filter auf dem
aktuellen Stand der Liste. Das Ergebnis enthält dann nur Einträge, die in der entsprechenden
Eigenschaft einen Wert gleich dem angegebenen Parameter haben. Ist ein Parameter nicht
angegeben (bzw. null), dann wird nicht über diese Eigenschaft gefiltert. Wurde
mehr als ein Parameter angegeben, dann muss ein Eintrag alle Filterbedingungen erfüllen,
damit er ausgegeben wird.
- Verfügbar ab
- 2.5
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Der Filter für den Schlüssel eines Herstellerlisteneintrags. Dieser hat den Form
einer Vorgangs-ID, z.B. RV-202012-12345. Der Parameter ist optional
und erlaubt einen Nullwert (null = Keine Filterung). |
| herstellername | string | Der Filter für einen Herstellernamen. Der Parameter ist optional und erlaubt einen
Nullwert (null = Keine Filterung). |
| vertretenername | string | Der Filter für einen Vertretenernamen. Der Parameter ist optional und erlaubt
einen Nullwert (null = Keine Filterung). |
| registrierungsnummer | int | Der Filter für eine Registrierungsnummer, z.B. 12345678. Dies muss ein
ganzzahliger positiver Wert sein. Der Parameter ist optional und erlaubt einen
Nullwert (null = Keine Filterung). |
| status | BattGHerstellerlisteTeilnahmestatus | Der Filter für den Status. Dieser kann TRUE, FALSE oder
UNKNOWN sein. Der Parameter ist optional und erlaubt einen Nullwert
(null = Keine Filterung). |
| betriebsbeginn | int | Der Filter für das Jahr, in dem der Betriebsbeginn liegen soll. Dies muss ein
ganzzahliger positiver Wert sein, z.B. 2020. Der Parameter ist optional und
erlaubt einen Nullwert (null = Keine Filterung). |
| betriebsende | int | Der Filter für das Jahr, in dem das Betriebsende liegen soll. Dies muss ein
ganzzahliger positiver Wert sein, z.B. 2020. Der Parameter ist optional und
erlaubt einen Nullwert (null = Keine Filterung). |
| zugeordnet | boolean | Filtert, ob der Eintrag durch einen Hersteller zugeordnet ist. Dies muss ein
boolescher Wert sein, erlaubt sind also true und false.
Der Parameter ist optional und erlaubt einen Nullwert (null = Keine
Filterung). |
| page | int | Nummer der angefragten Seite (Paging). Je Seite werden max. 5000 Herstellerlisten-Einträge geliefert. Der Seitenzähler beginnt bei 1. |
| Typ | Beschreibung |
|---|---|
| list of BattGHerstellerliste | Eine Liste aller Einträge in der Herstellerliste, welche die angegebenen Filterbedingungen erfüllen. Die Liste enthält nur die Einträge für die angegebene Seite. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
createEintragMitRegistrierungsnummer Operation
Der Herstellerliste einen neuen Eintrag mit einer BattG-Registrierungsnummer hinzufügen.
Der Eintrag kann nur angelegt werden, wenn für die BattG-Registrierungsnummer ein passender Hersteller im Sysem gefunden wird. Herstellername und der Name eines eventuell vorhandenen Bevollmächtigten werden von diesem Hersteller übernommen. Der Eintrag kann nur zusammen mit einem Betriebsbeginn angelegt werden.
Gibt es schon einen Eintrag mit der genannten BattG-Registrierungsnummer, kann kein weiterer erzeugt werden und es wird eine Fehlermeldung ausgegeben. Zudem kann der Herstellerliste kein neuer Eintrag hinzugefügt werden, wenn sich derzeit eine Genehmigung in Prüfung befindet oder aktiv ist.
| Name | Typ | Beschreibung |
|---|---|---|
| registrierungsnummer | int | Die BattG-Registrierungsnummer des Herstellers, der durch den neuen Eintrag
repräsentiert wird, z.B. 12345678 |
| betriebsbeginn | dateTime | Das Datum des Betriebsbeginns für diesen Hersteller in Bezug auf das
Eigenrücknahmesystem, z.B. 2021-01-27 |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Eintrag wurde der Herstellerliste hinzugefügt., wenn der Eintrag
angelegt werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
createEintragMitUnternehmensname Operation
Der Herstellerliste einen neuen Eintrag mit einem Herstellernamen/Vertretenennamen hinzufügen.
Ist der Hersteller ein Bevollmächtigter für ein vertretenes Unternehmen, dann kann optional auch der Name des Vertretenen angegeben werden. Der Eintrag lässt sich nur anlegen, wenn ein Betriebsbeginn angegeben wird und sich derzeit keine Genehmigung in Prüfung befindet oder aktiv ist.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellername | string | |
| vertretenername | string | Der Unternehmensname des Vertretenen, falls der Hersteller ein Bevollmächtigter
ist, z.B. Vertretener AG. Dieser Wert ist optional und kann
null sein. |
| betriebsbeginn | dateTime | Das Datum des Betriebsbeginns für diesen Hersteller in Bezug auf das
Eigenrücknahmesystem, z.B. 2021-01-27 |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Eintrag wurde der Herstellerliste hinzugefügt., wenn der Eintrag
angelegt werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
updateUnternehmensname Operation
Den Unternehmensnamen eines Eintrags in der Herstellerliste ändern.
Diese Methode erlaubt das Anpassen des Herstellernamen und des Vertretenennamens in einem Eintrag der Herstellerliste, der durch den Herstellerkey identifiziert wird. Dabei darf für die neu übermittelten Namen noch kein Eintrag in der Herstellerliste existieren.
Voraussetzung ist, dass mit dem Herstellerkey ein Eintrag bezeichnet wird, der nicht über eine Rücknahmesystemzuordnung mit dem Hersteller verbunden ist. Da ist in der Regel der Fall, wenn der Eintrag ursprünglich durch das Eigenrücknahmesystem selbst angelegt wurde. Außerdem darf der Eintrag keine BattG-Registrierungsnummer haben.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Die Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt werden
kann, z.B. RV-202012-12345. |
| herstellername | string | Der neue Unternehmensname des Herstellers, z.B. Test GmbH |
| vertretenername | string | Der Unternehmensname des Vertretenen, falls der Hersteller ein Bevollmächtigter
ist, z.B. Vertretener AG. Dieser Wert ist optional und kann
null sein. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Der Eintrag der Herstellerliste wurde geändert., wenn der Eintrag
angepasst werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
teilnahmeBestaetigen Operation
Einen Betriebsbeginn für einen Eintrag in der Herstellerliste setzen oder ändern.
Mit dem Eintragen des Betriebsbeginns wird gleichzeitig bestätigt, dass der Hersteller beim Eigenrücknahmesystem beteiligt ist. Das ist insbesondere für Einträge entscheidend, die aus der Zuordnung des Eigenrücknahmesystems durch einen Hersteller neu entstanden sind, weil für diese noch kein Betriebsbeginn bekannt ist.
Diese Methode kann auch verwendet werden, um einen schon vorhandenen Betriebsbeginn zu ändern.
In keinem Fall darf der Betriebsbeginn nach einem eventuell vorhandenen Betriebsende liegen. Die Verarbeitung wird dann abgelehnt.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Die Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt werden
kann, z.B. RV-202012-12345. |
| betriebsbeginn | dateTime | Das Datum des Betriebsbeginns für diesen Hersteller in Bezug auf das
Eigenrücknahmesystem, z.B. 2021-01-27. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Der Eintrag der Herstellerliste wurde geändert., wenn der Eintrag
bestätigt werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
teilnahmeBeenden Operation
Ein Betriebsende für einen Eintrag in der Herstellerliste setzen, ändern oder entfernen.
In keinem Fall darf das Betriebsende vor dem Betriebsbeginn liegen. Ein Betriebsende kann erst eingetragen werden, wenn auch ein Betriebsbeginn eingetragen ist.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Die Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt werden
kann, z.B. RV-202012-12345. |
| betriebsende | dateTime | Das Datum des Betriebsendes für diesen Hersteller in Bezug auf das
Eigenrücknahmesystem, z.B. 2021-01-27. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Der Eintrag der Herstellerliste wurde geändert., wenn der Eintrag
beendet werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
teilnahmeAblehnen Operation
Die Teilnahme für einen Hersteller in der Herstellerliste ablehnen.
Die Ablehnung führt dazu, dass der Eintrag nicht mehr mit einem Betriebsbeginn und einem Betriebsende ausgestattet werden kann. Der Hersteller muss in der Folge ein anderes Eigenrücknahmesystem auswählen.
Es können nur Einträge abgelehnt werden, die infolge einer Rücknahmesystemzuordnung durch einen Hersteller erzeugt wurden und bisher weder bestätigt noch abgelehnt waren.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Die Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt werden
kann, z.B. RV-202012-12345. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Der Eintrag der Herstellerliste wurde geändert., wenn der Eintrag
abgelehnt werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
zusammenfuehren Operation
Zusammenführen zweier Einträge aus der Herstellerliste, um zugeordnete Einträge mit selbst angelegten zu identifizieren.
Hat das Eigenrücknahmesystem selbst einen Eintrag der Herstellerliste eingefügt und macht der Hersteller später eine Rücknahmesysemzuordnung, dann stehen zwei Einträge in der Liste, die den gleichen Hersteller repräsentieren. Um den Hersteller nur noch einmal in der Liste stehen zu haben, kann man mit dieser Methode sagen, dass die beiden Einträge den gleichen Hersteller benennen.
Die Methode nimmt zwei Herstellerkeys entgegen. Einer davon muss einen Herstellerseitigen Eintrag benennen, der noch ungeprüft ist. Der zweite muss einen Eigenrücknahmesystemseitigen Eintrag benennen. Im Ergebnis wird der Eintrag des Eigenrückmnahmesystem übernommen und die Rücknahmesystemzuordnung des Herstellers darauf umgeleitet. Die Vorgangs-ID des Eigenrücknahmesystemseitigen Eintrags wird für die Herstellerseitige Zuordnung übernommen.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey1 | string | Die erste Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt
werden kann, z.B. RV-202012-12345. |
| herstellerkey2 | string | Die zweite Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt
werden kann, z.B. RV-202012-12345. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Die Einträge aus der Herstellerliste wurden zusammengeführt., wenn das
Zusammenführen abgeschlossen werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
deleteHerstellerliste Operation
Löschen eines Eintrags aus der Herstellerliste.
Der Eintrag ist danach nicht mehr in der Herstellerliste sichtbar. Während eines laufenden Betriebszeitraumes ist das Löschen eines Eintrags nicht möglich. Der Service gibt in diesen Fällen eine Fehlermeldung aus.
| Name | Typ | Beschreibung |
|---|---|---|
| herstellerkey | string | Die Vorgangs-ID, mit der ein Herstellerlisteneintrag eindeutig benannt werden
kann, z.B. RV-202012-12345. |
| Typ | Beschreibung |
|---|---|
| StandardResponse | Der Eintrag der Herstellerliste wurde gelöscht., wenn der Eintrag aus
der Herstellerliste entfernt werden konnte. |
| Name | Typ | Bedingung |
|---|---|---|
| ServiceException | ServiceException |
Impressum
| Disclaimer
| Datenschutzerklärung
© ear ist eine eingetragene Marke
Schnittstellen-Version 2.5