OfHTeilnahmeService Service

Dieser Service beinhaltet die Funktionalität auf Basis der Teilnehmerliste. Aus dieser Liste kann man (durch geeignete Filter) jeden Teilnehmer der OfH identifizieren und für nachfolgende Funktionen auswählen. Für die Funktionen, die sich auf einen Teilnehmer beziehen, ist immer eine eindeutige Vorgangs-ID erforderlich.

Namespace
http://www.ear-system.de/ear-soap/v2
WSDL
/OfHTeilnahmeService?wsdl

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.0
Rückgabewert
Typ Beschreibung
StandardResponse Text Service verfügbar, wenn verfügbar.
Exception
Name Typ Bedingung
ServiceException ServiceException Service ist nicht verfügbar oder interner Serverfehler

getTeilnehmer Operation

Liste aller Teilnehmenden an der Organisation für Herstellerverantwortung. Nachfolgend sind alle Parameter dieses Aufrufs aufgeführt. Alle Parameter (bis auf page) sind mögliche Filter, ist kein Filter gesetzt, werden alle Teilnehmer gelistet. Die Funktion liefert maximal 100 Einträge. Sollten mehr Teilnehmer enthalten sein (Rückgabewerte "moreFound"), dann kann über den Parameter "page" eine weitere Seite angefordert werden.

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
registrierungsnummerBattg int Die BattG-Registrierungsnummer
herstellername string Name des Herstellers
vertretenesUnternehmen string Name des vertretenen Unternehmens, sofern der Hersteller ein Bevollmächtiger ist
batteriekategorie string Die Battergiekategorie
jahrTeilnahmebeginn int Jahr des Teilnahmebeginns
jahrTeilnahmeende int Jahr des Teilnahmeendes
status string Status der Teilnahme (UNBESTAETIGT, BESTAETIGT, ABGELEHNT, ZURUECKGEZOGEN, BEENDET, VORZEITIG_BEENDET)
page int Eingabeparameter, welche Seite der Liste angefragt wird, der Default ist 1. Es werden bis zu 100 Einträge mit einem Aufruf geliefert.
Rückgabewert
Typ Beschreibung
OfHTeilnehmerList Liste aller Teilnehmenden
Exception
Name Typ Bedingung
ServiceException ServiceException  

getZuPruefendeMengen Operation

Es werden alle Vorgang-Ids geliefert, für die eine Mengenprüfung aussteht. Mithilfe der Vorgangs-ID können die Details (mit getDetails) abgerufen werden und bei Bedarf die Menge bestätigt (mengenmitteilungBestaetigen) oder abgelehnt (mengenmitteilungAblehnen) werden.

Eingabeparameter
Name Typ Beschreibung
page int Eingabeparameter, welche Seite der Liste angefragt wird, der Default ist 1. Es werden bis zu 100 Einträge mit einem Aufruf geliefert
Rückgabewert
Typ Beschreibung
VorgangsIds Liste von Vorgang-Ids für die eine Mengenprüfung aussteht.
Exception
Name Typ Bedingung
ServiceException ServiceException  

getDetails Operation

Die Funktion liefert die Details zu einem OfH Teilnehmer, insbesondere die Details zu den Mengen.

Eingabeparameter
Name Typ Beschreibung
vorgangsId string  
Rückgabewert
Typ Beschreibung
OfHTeilnehmer Teilnehmer mit Beteilgungsmengen
Exception
Name Typ Bedingung
ServiceException ServiceException  

teilnahmeBestaetigen Operation

Die Funktion ändert den Status eines OfH Teilnehmers in BESTAETIGT. Es wird geprüft, ob mit dieser Beteiligungsmenge die Pflichtenwahrnehmensgrenze überschritten würde.

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Teilnahme erfolgreich bestätigt
Exception
Name Typ Bedingung
ServiceException ServiceException  

teilnahmeAblehnen Operation

Die Funktion ändert den Status eines OfH Teilnehmers in ABGELEHNT.

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Teilnahme erfolgreich abgelehnt
Exception
Name Typ Bedingung
ServiceException ServiceException  

teilnahmeBeenden Operation

Die Funktion ändert den Status eines OfH Teilnehmers in BEENDET.

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Teilnahme erfolgreich beendet
Exception
Name Typ Bedingung
ServiceException ServiceException  

prognosemengeBearbeiten Operation

Prognosemenge bearbeiten

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
menge decimal Neue Prognosemenge
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Prognosemenge erfolgreich bearbeitet
Exception
Name Typ Bedingung
ServiceException ServiceException  

mengenmitteilungBestaetigen Operation

Mengenmitteilung bestätigen

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Mengenmitteilung erfolgreich bestätigt
Exception
Name Typ Bedingung
ServiceException ServiceException  

mengenmitteilungAblehnen Operation

Mengenmitteilung ablehnen

Eingabeparameter
Name Typ Beschreibung
vorgangsId string Die Vorgangs-ID
Rückgabewert
Typ Beschreibung
StandardResponse Im Erfolgsfall Mengenmitteilung erfolgreich abgelehnt
Exception
Name Typ Bedingung
ServiceException ServiceException  

Impressum | Disclaimer | Datenschutzerklärung
© ear ist eine eingetragene Marke
Schnittstellen-Version 2.5