Die Schnittstelle zur DVGW Gasgeräte-Datenbank folgt dem Representational state transfer (REST)-Programmierparadigma. Die übertragene Daten müssen in der Auszeichnungssprache XML codiert sein und dem XML-Schema entsprechen, das von der jeweiligen Funktion des RESTful-Webservices erwartet wird. Die XML-Schemata sind als XML Schema Definition (XSD) verfügbar.
Die Schnittstellenbeschreibungen unterliegen einer Versionierung und sind hier einsehbar.

Schnittstellenversionen:

Version 2.5

Am 03.12.2018 wurde die Schnittstellenversion im Testsystem und am 25.01.2019 im Produktivsystem freigeben. Die Version 2.4 ist damit als "veraltet" gekennzeichnet.

Was ist neu in Version 2.5:

• Einführung Stammdate "Führungsgröße"
  Die Führungsgröße soll zukünftig den Monteuren schnell zeigen, welche Werte für die Anpassung eines Gerätes relevant sind. Die Stammdate besteht aus einem Namen, einem Code und 0-2 möglichen Werten.

• Einführung Stammdate "Gerätegruppe"
  Die Gerätegruppe leitet sich aus dem Anhang D der DVGW G 695 ab. Versch. Gerätearten sind zu Gerätegruppen zusammengefasst. Eine Geräteart kann immer nur in einer Gerätegruppe sein.

• Die Fehlermeldungen der Schnittstelle wurden nochmals erweitert. Die Fehlermeldungen werden damit "sprechender".

Bitte nutzen Sie folgendene Links um sich weitergehend über die Änderungen zu informieren:

Testsystem: http://anpassungshandbuch.dvgw-sc.de:8080/schnittstelle/2.5/

Produktivsystem: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.5/

Version 2.4 (veraltet)

Am 03.05.2018 wurde die neue Schnittstellenversion 2.4. implementiert. Die Version 2.3 wird mit der Übertragung in das Produktivsystem der Version 2.4. in den Status "veraltet" gesetzt.

Die Version 2.4 wird zum 01.09.2019 abgeschaltet.

Was ist neu in Version 2.4:

• Dublettenkennzeichnung
  Die Dublettenkennzeichnung wurde überarbeitet. Dubletten erhalten nun ein weiteres Attribut:
  • „dubletteTyp“ - dieses kann 2 Werte enthalten: Inhaltsdublette oder Versionsdublette. Inhaltsdubletten sind „böse“ Dubletten, die sie den Monteuren z.B. bei der Suche, nicht anzeigen sollten. Sie sind reine Dubletten und haben keinen Nutzen. Versionsdubletten sind „gute“ Dubletten, die z.B. aus unterschiedlichen Schreibweisen auf Typschildern resultieren, die sich bei Herstellern im Laufe von Jahren ergeben können. Sie dienen der genauen Identifikation und sollten den Monteuren auch, z.B. in der Suche, zugänglich sein. Intern wird aber jeweils nur auf einen gültigen Datensatz verwiesen, d.h. wenn Sie Werte zu dem Datensatz anzeigen wollen, müssen Sie diese aus dem jeweils gültigen Datensatz ziehen.

• End of support

• End of nozzle
  Diese beiden Felder können 4-stellige Jahreszahlen zwischen 1900 und 2155 (Default-Wert) enthalten. Der Default-Wert ist so zu verstehen, das kein Enddatum des Ersatzteilsupports oder der Düsenversorgung hinterlegt worden ist.

Bitte nutzen Sie folgendene Links um sich weitergehend über die Änderungen zu informieren:

Testsystem: http://anpassungshandbuch.dvgw-sc.de:8080/schnittstelle/2.4/

Produktivsystem: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.4/

Link zum PDF: http://anpassungshandbuch.de/schnittstelle/2.4/schnittstellenBeschreibung.pdf

Version 2.3 (abgeschaltet)

Die Version 2.3 wird zum 01.09.2018 abgeschaltet.

Am 06.03.2017 wurde die neue Schnittstellenversion 2.3. auf dem Testsystem implementiert. Die Version 2.2 wird mit der Übertragung in das Produktivsystem der Version 2.3. in den Status "veraltet" gesetzt.

Folgende Änderungen sind mit der Version 2.3. eingeführt worden:

• /schnittstelle/2.3/holeGeraeteErfahrung: Diese Schnittstelle übernimmt die Funktion der bisherigen holeGeraete-Schnittstelle aus Version 2.2, d.h. hier werden sowohl AnpassungszeitpunktHersteller als auch AnpassungszeitpunktErfahrung ausgeliefert.
• /schnittstelle/2.3/holeGeraete: Diese Schnittstelle arbeitet analog zur /schnittstelle/2.2/holeGeraete

Bitte nutzen Sie folgendene Links um sich weitergehend über die Änderungen zu informieren:

Testsystem: http://anpassungshandbuch.dvgw-sc.de:8080/schnittstelle/2.3/

Produktivsystem: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.3/

Link zum PDF: http://anpassungshandbuch.de/schnittstelle/2.3/schnittstellenBeschreibung.pdf

Version 2.2 (abgeschaltet)

Für das Produktivsystem wurde die Version am 22.11.2016 bereitgestellt. Die Version wird zum 31.07.2017 abgeschaltet.

Am 26. Oktober 2016 wurde die neue Schnittstellenversion 2.2 auf dem Testsystem implementiert. Mit der Übertragung der Schnittstellenversion 2.2 auf das Produktivsystem werden wir die Schnittstellenversion 2.0 deaktivieren.

Folgende Änderungen sind mir der Version 2.2 durchgeführt worden:

• Abschaltung Version 2.0 im Testsystem
• Einführung W3C-Webservice (SOAP) samt WSDL
• Einführung von Codes für Marken

Bitte nutzen Sie folgendene Links um sich weitergehend über die Änderungen zu informieren:

Testsystem: http://anpassungshandbuch.dvgw-sc.de:8080/schnittstelle/2.2/

Produktivsystem: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.2/

Link zum PDF: http://anpassungshandbuch.de/schnittstelle/2.2/schnittstellenBeschreibung.pdf

Version 2.1 (abgeschaltet)

Die Version 2.1 ist seit dem 13.06.2016 (im Testsystem), bzw. seit 30.06.2016 im Produktivsystem aktiv. Die Version wurde zum 17.03.2017 abgeschaltet. Die Schnittstelle ist abwärtskompatibel, d. h. die Version 2.0 ist weiterhin funktionsfähig.

Link zur Schnittstelle: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.1/
Link zum PDF: http://anpassungshandbuch.de/schnittstelle/2.1/schnittstellenBeschreibung.pdf

Änderungen:

• Neuaufnahme des Datenmodell "Baujahr_Von"
• Neuaufnahme des Datenmodell "Baujahr_Bis"
• Neuaufnahme des Datenmodell "Herstellernummer"
• Neuaufnahme des Datenmodell "Herstellernummer_Bezeichnung"
• Neuaufnahme des Datenmodell "Menge Material"

Version 2.0 (abgeschaltet)

Die Version 2.0 war im Zeitraum vom 14.01.2016 bis zum 25.11.2016 aktiv. Aufgrund von Änderungen in der Datenstruktur war ein Parallelbetrieb zu alten Versionen nicht möglich.

Link zur Schnittstelle: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/2.0/
Link zum PDF: http://anpassungshandbuch.de/schnittstelle/2.0/schnittstellenBeschreibung.pdf

Änderungen:

• Neuaufnahme des Datenmodell "Anpassung möglich"
• Neuaufnahme des Datenmodell "Anpassungszeitpunkt (Hersteller)"
• Neuaufnahme des Datenmodell "Anpassungszeitpunkt (Erfahrung)"
• Überarbeitung des Datenmodell "Material / Materiallieferant"
• Abschaltung des Datenmodell "Umbauwürdigkeit"
• Erweiterung Schnittstelle "holeFeedbackStatus"

Version 1.1 (abgeschaltet)

Die Version 1.1 war vom 30.07.2015 bis zum 14.01.2016 aktiv. Im August 2015 war ein Parallelbetrieb mit der alten Schnittstellenversion 1.0 möglich.

Link zur Schnittstelle: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/1.1/
Link zum PDF: http://anpassungshandbuch.de/schnittstelle/1.1/schnittstellenBeschreibung.pdf

Änderungen:

• Überarbeitung des Datenmodell "Hersteller / Marke"
• Überarbeitung des Datenmodell "Gerät" (Felder CO²-Min und -Max)

Version 1.0 (abgeschaltet)

Die Version 1.0 war vom 16.03.2015 bis 31.08.2015 aktiv.

Link zur Schnittstelle: http://anpassungshandbuch.dvgw-sc.de/schnittstelle/1.0/
Link zum PDF: http://anpassungshandbuch.de/schnittstelle/1.0/schnittstellenBeschreibung.pdf