ACHTUNG: Programm im Beta-Test
Wenn man in einem Eingabefeld die F1-Taste drückt, öffnet sich eine separate Hilfeseite mit Erläuterungen zum entsprechenden Eingabefeld bzw. zur Eingabeseite. Ob diese Hilfeseite in einem searaten Fenster geöfffnet wird oder im aktuellen kann im Benutzer- und Programm-Profil festgelegt werden.

REST - Serviceschnitttellen für Programme

Die Schnittstellen sind noch in Entwicklung, d.h. die Aufrufe und deren Parameter können sich ändern!
Erst wenn hier eine finale Fassung verkündet wird, kann davon ausgegangen werden, dass die Zugriff-URLs beibehalten werden.

Diese Seite wendet sich an Softwarehersteller, die HIT per REST-Service nutzen wollen.


REST Version 2 - Übersicht

Seit 1.April 2019 steht die neue Version unserer REST-Schnittstellen zur Erprobung bereit. Die Grundstruktur ist weitgehend stabil. Wer sie im Rahmen von Pilotprojekten nutzen möchte, ist eingeladen Verbesserungsmöglichkeiten mit uns zu erörtern.

Es grundsätzlich zwei Arten von Funktionen

  • einfache Funktionen, die ohne Anmeldung benutzt werden können, z.B.
    • Prüfen einer Ohrmarke oder Betriebsnummer auf syntaktische Korrektheit
    • Umwandeln einer beliebig formatierten Ohrmarke oder Betriebsnummer in die numerische bzw. alphanumerische normierte Darstellungsform
  • zugriffsbeschränkte Funktionen, die nur mit Anmeldung benutzt werden können, z.B.
    • Einfügen mittels PUT, abfagen mittels GET, ändern mittels POST, stornieren mittels DELETE gemäß CRUD-Pattern im "Standard REST-Modell"
    • Einfügen, abfagen, ändern, stornieren mittels HIT-Abfragesyntax, aber strukturieren Daten

Weiterführende Dokumentation

  • zu den einzelnen Schnittstellen-Definitionen siehe apiHelp
  • Swashbuckle Swagger - Dokumenatation und Testinterface, hier unter swagger

REST Version 1 - Aufrufbeispiele für die verschiedenen Schnittstellen

Version 1.15b, Stand 29.04.2018 14:00 (beta)

Seit 2014 existiert die "alte" Version unserer REST-Schnittstellen. Grundsätzlich dienen diese Schnittstellen als Transportmittel und Kapselung für das generische HIT-Protokoll, in verschiedenen Ausprägungen für unterschiedliche Anwendungsszenarien angepasst.

Es gibt drei Komplexitätsstufen und eine Demo-Schnittstelle:

Höheres Level HitCom
Level, welches den HitBatch "nachahmt" HitBatch
Niedriges Level, d.h. auf Protokollebene HitRaw
Demo mit einfachen Beispielen HitDemo

Einführung in die Nutzung der HIT-Rest Version 1.x Schnittstellen (API)

Es gibt die oben aufgeführten verschiedene Schnittstellen-Gruppen mit unterschiedlicher Zielsetzung und unterschiedlicher Nähe zum rohen HIT-Protokoll.

In der Regel sind die HTTP-Verben GET und POST implementiert, teilweise auch PUT und DELETE. Die Parameter beim GET sind gemäß HTTP-Spezifikation URL-encoded. Beim POST müssen die Formulardaten mittels HTTP-Header content-type: application/x-www-form-urlencoded oder content-type: application/json übermittelt werden. Die Antwortdaten werden standardmäßig im JSON-Format geliefert, können aber mittels HTTP-Header accept: application/xml auch im XML-Format angefordert werden.

Weiterführende Dokumentation

  • zu den einzelnen Schnittstellendefinitionen siehe apiHelp
  • Swashbuckle Swagger - Dokumenatation und Testinterface, hier unter swagger

Internal connection settings

DNS:ml-sv-wsvhzd4
HIT-Server:194.94.221.190;194.94.221.190;194.94.221.190;194.94.221.190;194.94.221.190