HVS32 REST Interface (Interactive)

From Wiki - Heidler Strichcode GmbH
Revision as of 14:46, 1 February 2022 by Preichert (talk | contribs) (→‎Examples)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


Prerequisites

DGS-Version 3.8.2.673 or higher
DGS-Plugins HVS32Server, REST Client

Function description

In interactive processing, requests are made from the dispatch system to your REST server. Thereby the DGS acts as REST Client.
This gives you the possibility, for example, to request shipping data for a reference number (e.g. delivery note number) from the HVS32. The functionalities available to you can be found under Verfügbare HVS32 Funktionen.

The DataGatewayServer (DGS) is the central communication unit through which all data is exchanged between the shipping system and the host system. It runs as a service on a Windows server.

Available HVS32 functions

Item data and dangerous goods information have a 1:n relationship with package data.

Please note that the field descriptions only refer to a standard, which should serve as a suggestion for the interface. Function names, field names /-lengths /-formats can deviate in principle, but must be considered/analyzed individually in this case.

Verfügbare HVS32 Funktionen

Examples

Data format (Media-Type) JSON (text/plain, application/json)
Methods GET, POST
Authentication without, Basic


VersandDatenAnfrage (Datenanfragemeldung)

Request from DGS to REST Server

{
   "LIEFERSCHEINNR": "LS-123"
}


Response from REST Server to DGS for the above request

{
   "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)

Request from DGS to REST Server

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


Response from REST Server to DGS for the above request
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}


ArtikelRueckMeldung (Rückmeldung der Positionsdaten)

Request from DGS to 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"
      }
   ]
}


Response from REST Server to DGS for the above request
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}


AusgangslistenRueckMeldung (Rückmeldung der Ausgangslisten)

Request from DGS to 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"
      }
   ]
}


Response from REST Server to DGS for the above request
{
   "FEHLER": null,
   "FEHLERTEXT1": null
}

FAQ / Troubleshooting