HVS32 REST Schnittstelle (Interaktiv)

From Wiki - Heidler Strichcode GmbH
Jump to navigation Jump to search


Voraussetzungen

DGS-Version 3.8.2.673 oder höher
DGS-Plugins HVS32Server, REST Client

Funktionsbeschreibung

Bei einer interaktiven Verarbeitung werden Anfragen aus dem Versandsystem heraus an Ihren REST Server gestellt. Dabei agiert der DGS als REST Client.
Dadurch hat man zum Beispiel die Möglichkeit, aus dem HVS32 heraus Versanddaten zur einer Referenznummer (z.B. Lieferscheinnummer) anzufragen. Die Ihnen zur Verfügung stehenden Funktionalitäten können Sie unter Verfügbare HVS32 Funktionen entnehmen.

Der DataGatewayServer (DGS) ist die zentrale Kommunikationseinheit, über die sämtliche Daten zwischen dem Versandsystem und dem Hostsystem ausgetauscht werden. Er läuft in Form eines Dienstes auf einem Windows-Server.

Verfügbare HVS32 Funktionen

Artikel-Daten und Gefahrgut-Informationen stehen in einer 1:n Beziehung zu den Packstückdaten.

Bitte beachten Sie, dass die Feld-Beschreibungen sich nur auf einen Standard beziehen, welcher als Vorschlag für die Schnittstelle dienen soll. Funktionsnamen, Feldnamen /-längen /-formate können prinzipiell abweichen, müssen in diesem Fall jedoch individuell betrachtet/analysiert werden.

Verfügbare HVS32 Funktionen

Beispiele

Datenformat (Media-Type) JSON (text/plain, application/json)
Methoden GET, POST
Authentifizierung ohne, Basic


VersandDatenAnfrage (Datenanfragemeldung)

Anfrage vom DGS an den REST Server

{
   "LIEFERSCHEINNR": "LS-123"
}


Rückmeldung vom REST Server an den DGS zur obigen Anfrage

{
   "AUFTRAGGEBERID": "01",
   "AUFTRAGNR": "A1234",
   "FEHLER": null,
   "FEHLERTEXT1": null,
   "KUNDENNR": "KD123",
   "LIEFERSCHEINNR": "LS-123",
   "VERSANDARTID": "DPD",
   "ZIELADRLKZ": "D",
   "ZIELADRNAME1": "Heidler Strichcode GmbH",
   "ZIELADRNAME2": "Wareneingang",
   "ZIELADRNAME3": null,
   "ZIELADRORT": "Wolfschlugen",
   "ZIELADRPLZ": "72649",
   "ZIELADRSTRASSE": "Max-Eyth-Straße 25",
   "ArtikelDaten": [
      {
         "ARTIKELBTNNR": "123",
         "ARTIKELGEWICHT": "0.5",
         "ARTIKELMENGE": "1",
         "ARTIKELTEXT1": "Testartikel 1",
         "ARTIKELTEXT2": null,
         "KUNDENARTIKELNR": "0123456789",
         "POSITIONNR": "1"
      },
      {
         "ARTIKELBTNNR": "124",
         "ARTIKELGEWICHT": "0.25",
         "ARTIKELMENGE": "1",
         "ARTIKELTEXT1": "Testartikel 2",
         "ARTIKELTEXT2": null,
         "KUNDENARTIKELNR": "0123456790",
         "POSITIONNR": "2"
      }
   ]
}


PaketscheinDruckMeldung (Rückmeldung der Paketscheindaten)

Anfrage vom DGS an den REST Server

{
   "AUFTRAGGEBERID": "01",
   "AUSGANGDATETIME": "01.01.2021",
   "DRUCKDATETIME": "01.01.2021",
   "GEWICHT": "0.700",
   "LIEFERSCHEINNR": "LS-123",
   "PACKSTKGES": "2",
   "PACKSTKNR": "1",
   "TRACKINGNR": "00112233445566778899"
}


Rückmeldung vom REST Server an den DGS zur obigen Anfrage
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}


ArtikelRueckMeldung (Rückmeldung der Positionsdaten)

Anfrage vom DGS an den REST Server

{
   "LIEFERSCHEINNR": "LS-123",
   "ArtikelDaten": [
      {
         "ARTIKELBTNNR": "123",
         "ARTIKELMENGE": "1",
         "KUNDENARTIKELNR": "0123456789",
         "PACKSTKGES": "2",
         "PACKSTKNR": "1",
         "POSITIONNR": "1",
         "TRACKINGNR": "00112233445566778899"
      },
      {
         "ARTIKELBTNNR": "124",
         "ARTIKELMENGE": "1",
         "KUNDENARTIKELNR": "0123456790",
         "PACKSTKGES": "2",
         "PACKSTKNR": "2",
         "POSITIONNR": "2",
         "TRACKINGNR": "00112233445566778900"
      }
   ]
}


Rückmeldung vom REST Server an den DGS zur obigen Anfrage
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}


AusgangslistenRueckMeldung (Rückmeldung der Ausgangslisten)

Anfrage vom DGS an den REST Server

{
   "ListenDaten": [
      {
         "AUFTRAGGEBERID": "01",
         "AUSGANGDATETIME": "01.01.2021",
         "DRUCKDATETIME": "01.01.2021",
         "FRACHTFUEHRERTYP": "DPD",
         "GEWICHT": "0.700",
         "LIEFERSCHEINNR": "LS-123",
         "PACKSTKGES": "2",
         "PACKSTKNR": "1",
         "TRACKINGNR": "00112233445566778899"
      },
      {
         "AUFTRAGGEBERID": "01",
         "AUSGANGDATETIME": "01.01.2021",
         "DRUCKDATETIME": "01.01.2021",
         "FRACHTFUEHRERTYP": "DPD",
         "GEWICHT": "0.500",
         "LIEFERSCHEINNR": "LS-123",
         "PACKSTKGES": "2",
         "PACKSTKNR": "2",
         "TRACKINGNR": "00112233445566778900"
      }
   ]
}


Rückmeldung vom REST Server an den DGS zur obigen Anfrage
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}

FAQ / Troubleshooting