Services

Namespace http://www.ear-system.de/ear-soap/v2
Name Beschreibung
AbholkoordinationsService Der AbholkoordinationsService beinhaltet Funktionen zum Abruf von Informationen zur Abholkoordination. Hersteller können sich hier u.a. generierte PDF-Dokumente herunterladen. Bitte beachten Sie, dass Sie nur noch für Anordnungen (Codes) welche bis einschließlich 27.12.2023 ergangen sind die entsprechenden Gebührenbescheide über die Schnittstelle abrufen können.

Der Anwender der Schnittstelle ruft zunächst die Methode getCodes auf. Diese ermittelt die Schlüsseldaten (Abholungs-/Aufstellungscode, Status, Art) nach den übergebenen Kriterien. Die Daten werden als XML zur Verfügung gestellt und bestehen aus einer Liste, die den Kriterien entsprechenden Abholungs-/Aufstellungscodes (Code) inklusive des Status sowie der Art entspricht.

Des Weiteren bietet die Schnittstelle dem Anwender die Möglichkeit, im ear-System an den eigenen Abholungen bzw. Aufstellungen einen herstellereigenen Status zu pflegen. Dies geschieht über die Methode setStatusHst. Dieser durch den Anwender frei zu belegende Status kann bei der Methode getCodes als statusHstVon - statusHstBis Kriterium mit übergeben werden und versetzt den Anwender in die Lage, sich eine vom ear-System unabhängige Logik der Abholung bzw. Nachverfolgung von Codes aus dem ear-System aufzubauen. Der herstellereigene Status findet außerhalb der in diesem Dokument beschriebenen Schnittstellenfunktionalität keine Verwendung.

Die Dokumente werden bei den Aufrufen getDetails bzw. getGebuehrenbescheid mittels SOAP Message Transmission Optimization Mechanism (MTOM) übertragen. Dabei wird XOP für die Übermittlung der binären Daten verwendet. Bei den übertragenen Dokumenten handelt es sich ausschließlich um PDF-Dokumente. Bei der Implementierung eines Clients ist darauf zu achten, dass die Codierung der SOAP-Nachrichten entsprechend konfiguriert ist (z.B für .NET binding.MessageEncoding = WSMessageEncoding.Mtom).

BattGRSVerzeichnisService Der BattGRSVerzeichnisService beinhaltet Funktionen zum Abrufen für das Verzeichnis der genehmigten Eigenrücknahmesysteme.

BattGVerzeichnisService Der BattGVerzeichnisService beinhaltet Funktionen zum Abrufen für das Verzeichnis der registrierten Hersteller und registrierten Bevollmächtigten nach dem BattG.

Bildmarken werden bei dem Aufruf getMarken mittels SOAP Message Transmission Optimization Mechanism (MTOM) übertragen. Dabei wird XOP für die Übermittlung der binären Daten verwendet. Bei der Implementierung eines Clients ist darauf zu achten, dass die Codierung der SOAP-Nachrichten entsprechend konfiguriert ist und dass die Puffergröße für den Nachrichtenempfang und die maximal erlaubte Größe einer Nachricht entsprechend groß gewählt wird (z.B für .NET binding.MessageEncoding = WSMessageEncoding.Mtom, binding.MaxBufferSize = 10_000_000 und binding.MaxReceivedMessageSize = 10_000_000).

EigenruecknahmesystemHerstellerlisteService 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.

MitteilungsService Dieser Service beinhaltet die Funktionalität, Mengenmitteilungen elektronisch abzusetzen. Für die fristgerechten Abrufe und Mengenmitteilungen über die SOAP Schnittstelle sind die Kunden selbst verantwortlich. Sollten die erforderlichen Voraussetzungen für die Abgabe einer Mengenmitteilung nicht erfüllt sein, so wird dies durch eine entsprechende Fehlermeldung quittiert.
VerzeichnisService Der VerzeichnisService beinhaltet Funktionen zum Abrufen von Statusinformationen zu einem Abhol- und/oder Aufstellungscode. Der Anwender der Schnittstelle kann mit Hilfe der Methode getAhkstatus unter Angabe des Abhol- und Aufstellungscode die entsprechende Statusinformation sowie den Typ des Codes abfragen.

Weiterhin sind Funktionen zum Abrufen für das Verzeichnis der registrierten Hersteller und registrierten Bevollmächtigten nach dem ElektroG, das Verzeichnis der Sammel- und Rücknahmestellen und das Verzeichnis der Betreiber von Erstbehandlungsanlagen vorhanden.

Bildmarken werden bei dem Aufruf getMarken mittels SOAP Message Transmission Optimization Mechanism (MTOM) übertragen. Dabei wird XOP für die Übermittlung der binären Daten verwendet. Bei der Implementierung eines Clients ist darauf zu achten, dass die Codierung der SOAP-Nachrichten entsprechend konfiguriert ist und dass die Puffergröße für den Nachrichtenempfang und die maximal erlaubte Größe einer Nachricht entsprechend groß gewählt wird (z.B für .NET binding.MessageEncoding = WSMessageEncoding.Mtom, binding.MaxBufferSize = 10_000_000 und binding.MaxReceivedMessageSize = 10_000_000).

Datentypen

Default Namespace
Typ Beschreibung
createEintragMitRegistrierungsnummer
createEintragMitUnternehmensname
teilnahmeBeenden
teilnahmeBestaetigen
Namespace http://www.ear-system.de/ear-soap/v2
Typ Beschreibung
Ahkstatus Der Ahkstatus beinhaltet Statusinformation sowie den Typ (Abholanordnung / Aufstellungsanordnung) zu einem bestimmten Code.
Ansprechpartner Kontaktdaten wie Name, Telefon und E-Mail-Adresse des jeweiligen Ansprechpartners.
Art Die Art des Buchungsschlüssels spezifiziert den fachlichen Auslöser für die Abholung bzw. Bereitstellung. Durch die zugrundeliegende fachliche Semantik, werden nur Codes, bzw. Details zu Codes geliefert, wenn die Art des Buchungsschlüssels identisch ist mit der Art des Codes.
BattGHerstellerliste Ein einzelner Eintrag der Herstellerliste.

Grundsätzlich ist zwischen Einträgen, die durch einen Hersteller zugeordnet sind und solchen, die es nicht sind. Für Einträge mit Zuordnung sind Unternehmensname, Vertretenername und BattG-Registrierungsnummer aus dem Hersteller übertragen worden und können nicht geändert werden. Bei Einträge ohne Zuordnung wurden diese Informationen durch das Eigenrücknahmesystem bereitgestellt und sind durch dieses auch editierbar. Allerdings kann dann entweder die BattG-Registrierungsnummer alleine oder der Unternehmensname und der Vertretenername gefüllt sein.

Der Teilnahmestatus kann nur bei einer vorhandenen Zuordnung die Werte TRUE oder FALSE annehmen. Der Wert UNKNOWN zeigt an, dass der Teilnahmestatus des Eintrags nicht bekannt ist. Das ist bei einer vorhandenen Zuordnung dann der Fall, wenn der Teilnahmestatus vom Eigenrücknahmesystem noch nicht bestätigt wurde. Bei Einträgen ohne Zuorndung ist der Teilnahmestatus immer UNKNOWN.

BattGHerstellerlisteTeilnahmestatus Der Teilnahmestatus eines Eintrags in der Herstellerliste.

Der Teilnahmestatus zeigt an, ob der Hersteller das Eigenrücknahmesystem frisch zugeordnet hat und das Eigenrücknahmesystem noch keine Prüfung vorgenommen hat, oder ob das Eigenrücknahmesystem den Eintrag positiv oder negativ bestätigt hat.

BattGMarke Informationen zu einer registrierten Marke eines Herstellers, wie Registrierungsnummer (BattG-Reg.-Nr. DE), Herstellername, Markenname, Bildmarke, Geräteart, Veröffentlichungsdatum und Marktaustritt. Handelt es sich bei Marke um eine Bildmarke ist statt dem Element <marke> das Element <bildmarke> gesetzt. Die Bilddatei der Bildmarke wird in binärer Form mittels XOP übertragen.
BattGMarken Die Abfrage getMarken liefert die Liste von registrierten Marken, die den Abfragekriterien entsprechen. Die Liste der Marken ist pro Aufruf auf 5.000 Elemente beschränkt.
BattGRegistrierung Informationen zu einer bestimmten Registrierung eines Herstellers, wie Registrierungsnummer, Geräteart und Marktaustritt.
BattGRegistrierungen Die Abfrage getHersteller liefert die Liste von registrierten Herstellern und registrierten Bevollmächtigten nach dem BattG, die den Abfragekriterien entsprechen. Die Liste der Hersteller bzw. Bevollmächtigten ist pro Aufruf auf 5.000 Elemente beschränkt.
BattGRuecknahmesystem Instanz für ein Eigenrücknahmesystem
BattGRuecknahmesysteme Die Abfrage getBattGRuecknahmesysteme liefert die Liste der genehmigten Eigenrücknahmesysteme.
Batterieart Instanz für eine Batterieart
Behaeltnis Ein Behältnis ist ein Bestandteil einer Transporteinheit.
Bildmarke Die Bilddatei der Bildmarke wird in binärer Form mittels XOP übertragen. Das Bildformat der Bilddatei ist entweder PNG (image/png) oder JPEG (image/jpeg).
Bundesland Die Liste aller Bundesländer Deutschlands. Der Schlüssel kann z.B. als Filterparameter (bundesland) in den Servicemethoden getErstbehandlungsanlagen verwendet werden.
Code Informationen zu einem bestimmten Abhol- bzw. Aufstellungscode, wie Art, Hersteller (in Form der Registrierungsnummer), die zugeordnete Geräteart sowie den Status der Abholung bzw. Aufstellung.
Codes Die Abfrage getCodes liefert die Codes, die den Abfragekriterien entsprechen. Die Liste der Codes ist auf 100 Elemente beschränkt.
Detailinformation Die Detailinformationen enthalten alle relevanten Daten aus den Dokumenten der jeweiligen Anordnung.
Dokument Bei den Dokumenten handelt es sich um Gebührenbescheide, Abhol- und Aufstellanordnungen, die als PDF-Datei heruntergeladen werden können. Die Datei wird mittels SOAP Message Transmission Optimization Mechanism (MTOM) übertragen. Dabei wird XOP für die Übermittlung der binären Daten verwendet. Bei der Implementierung eines Clients ist darauf zu achten, dass die Codierung der SOAP-Nachrichten entsprechend konfiguriert ist (z.B für .NET binding.MessageEncoding = WSMessageEncoding.Mtom;).
Entsorger Der dem Hersteller zugeordnete Entsorger, der mit der Abholung bzw. Aufstellung beauftragt wurde.
Erstbehandlungsanlage Betreiber einer Erstbehandlungsanlage
Erstbehandlungsanlagen Die Abfrage getEba liefert die Liste von Betreibern von Erstbehandlungsanlagen, die den Abfragekriterien entsprechen. Die Liste ist pro Aufruf auf 5.000 Elemente beschränkt.
Gebuehr Eine einzelne Gebühr als Teil eines Gebührenbescheids.
Gebuehrenbescheid Der Aufruf getGebuehrenbescheid liefert alle relevanten Daten eines Gebührenbescheids in elektronischer Form.
Gebuehrentatbestand Gebührentatbestand gemäß der Gebührenverordnung zum ElektroG.
Geraeteart Die im ear-System konfigurierte Geräteart.
Gruppe Die im Falle einer aktiven b2c-Geräteart zugeordnete Gruppe
Hersteller Kontaktdaten, wie Name, Telefon und E-Mail-Adresse des Herstellers, sowie des Hauptansprechpartners.
Kategorie Kategorien gemäß ElektroG
Marke Informationen zu einer registrierten Marke eines Herstellers, wie Registrierungsnummer, Markenname, Herstellername, Bildmarke, Geräteart, Veröffentlichungsdatum und Marktaustritt. Handelt es sich bei Marke um eine Bildmarke ist statt dem Element <marke> das Element <bildmarke> gesetzt. Die Bilddatei der Bildmarke wird in binärer Form mittels XOP übertragen.
Marken Die Abfrage getMarken liefert die Liste von registrierten Marken, die den Abfragekriterien entsprechen. Die Liste der Marken ist pro Aufruf auf 5.000 Elemente beschränkt.
Masseinheit Die Maßeinheit, in der die übermittelten Mitteilungsmengen angegeben sind. Die Angabe als Gewicht darf dabei maximal auf 1 Gramm genau erfolgen. Das bedeutet, je nach Art der Maßeinheit sind unterschiedlich viele Nachkommastellen erlaubt.
  • STUECK: 0 Nachkommastellen
  • KILOGRAM: 3 Nachkommastellen
  • TONNEN: 6 Nachkommastellen
Oeffnungszeit Öffnungszeit einer Übergabestelle
PagedList Services des VerzeichnisServices, die eine Liste von Objekten zurückgeben, wie getHersteller, getMarken und getErstbehandlungsanlagen , liefern diese Objekte seitenweise aus. Der Aufruf der ersten Seite erfolgt mit page=1. Die maximal zurückgelieferte Menge an Objekten (pageSize) beträgt jeweils 5.000 Elemente. Alle weiteren Elemente können über subsequente Aufrufe mit einer weiteren Seite, wie z.B. page=2 usw., ausgelesen werden. Liegen noch weitere Elemente auf einer nächsten Seite vor, so ist der Wert von moreFound=true.
Registrierung Informationen zu einer bestimmten Registrierung eines Herstellers, wie Registrierungsnummer, Geräteart und Marktaustritt.
Registrierungen Die Abfrage getHersteller liefert die Liste von registrierten Herstellern und registrierten Bevollmächtigten nach dem ElektroG, die den Abfragekriterien entsprechen. Die Liste der Hersteller bzw. Bevollmächtigten ist pro Aufruf auf 5.000 Elemente beschränkt.
StandardResponse Einige SOAP-Aufrufe, wie z.B. die Mengenmitteilungen des Services MitteilungsServicePort, liefern über die StandardResponse die Information, ob der Aufruf erfolgreich war.
Status Status einer Abholung bzw. einer Aufstellung.
Status einer Abholung
0Abholung unbearbeitet
1Abholung zugewiesen
2Abholung angemahnt
5Abholung bestätigt nach Zuweisung
6Abholung bestätigt nach Anmahnung
8Abholung aufgehoben

Status einer Aufstellung
0Aufstellung unbearbeitet
1Aufstellung zugewiesen
2Aufstellung angemahnt
5Aufstellung bestätigt nach Zuweisung
6Aufstellung bestätigt nach Anmahnung
8Aufstellung aufgehoben
9Behältnis abgemeldet
Transporteinheit Eine Transporteinheit kann eine, von der stiftung ear vorgeschlagene und im ear-System gepflegte Standardtransporteinheit sein, es ist aber auch möglich für die öffentlich-rechtlichen Entsorgungsträger und Übergabestellen eine eigene Kombination von Behältnissen anzufordern.
Transporteinheitsaufbau Eine Transporteinheit kann aus einem oder mehreren Behältnissen bestehen.
Uebergabestelle Kontaktdaten, wie Name, Telefon und E-Mail-Adresse der Übergabestelle, sowie des Leitungsbefugten.

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