HVS32 SOAP Interface (Interactive): Unterschied zwischen den Versionen

Aus Wiki - Heidler Strichcode GmbH
Zur Navigation springen Zur Suche springen
Zeile 1: Zeile 1:
−
[[de:HVS32_SOAP_Schnittstelle_(Interaktiv)]]
+
[[en:HVS32_REST_Interface_(Interactive)]]
  
 
= Prerequisites =
 
= Prerequisites =
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
| DGS-Version || 3.6.0.588 or higher
+
| DGS-Version || 3.8.2.673 or higher
 
|-
 
|-
−
| DGS-Plugins || HVS32Server, SOAP Client
+
| DGS-Plugins || HVS32Server, REST Client
 
|}
 
|}
 
= Function description =
 
= Function description =
−
In interactive processing, requests are made from the dispatch system to your SOAP server. Thereby the DGS acts as SOAP Client.<br>
+
In interactive processing, requests are made from the dispatch system to your REST server. Thereby the DGS acts as REST Client.<br>
 
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|Verfügbare HVS32 Funktionen]].
 
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|Verfügbare HVS32 Funktionen]].
  
Zeile 23: Zeile 23:
 
= Examples =
 
= Examples =
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">'''VersandDatenAnfrage'''</div>
+
<div style="font-weight:bold;line-height:1.6;">'''VersandDatenAnfrage ([https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_Funktionen_Interaktiv#Datenanfragemeldung_.28VersandDatenAnfrage.29 Datenanfragemeldung])'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
;request from the DGS to the SOAP server.
+
Request from DGS to REST Server
−
<source>
+
<source lang="json">
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:std="http://my.path.to.endpoint.functions">
+
{
−
<soapenv:Header/>
+
  "LIEFERSCHEINNR": "LS-123"
−
<soapenv:Body>
+
}
−
<std:my_function>
 
−
<arg0>
 
−
<item>LS-123</item>
 
−
</arg0>
 
−
</std:my_function>
 
−
</soapenv:Body>
 
−
</soapenv:Envelope>
 
 
</source>
 
</source>
−
 
+
<br>
−
;Feedback from the SOAP server to the DGS about the above request.
+
Response from REST Server to DGS for the above request
−
<source>
+
<source lang="json">
−
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
+
{
−
   <S:Body>
+
  "AUFTRAGGEBERID": "01",
−
       <ns2:my_function_Response xmlns:ns2="http://my.path.to.endpoint">
+
  "AUFTRAGNR": "A1234",
−
         <return>
+
  "FEHLER": null,
−
            <AUFTRAGGEBERID>01</AUFTRAGGEBERID>
+
  "FEHLERTEXT1": null,
−
            <LIEFERSCHEINNR>LS-123</LIEFERSCHEINNR>
+
  "KUNDENNR": "KD123",
−
            <PACKSTUECKID>PID-53185</PACKSTUECKID>
+
  "LIEFERSCHEINNR": "LS-123",
−
            <VERSANDARTID>UPS</VERSANDARTID>
+
  "VERSANDARTID": "DPD",
−
            <ZIELADRLKZ>D</ZIELADRLKZ>
+
  "ZIELADRLKZ": "D",
−
            <ZIELADRNAME1>Heidler Strichcode GmbH</ZIELADRNAME1>
+
  "ZIELADRNAME1": "Heidler Strichcode GmbH",
−
            <ZIELADRORT>Wolfschlugen</ZIELADRORT>
+
  "ZIELADRNAME2": "Wareneingang",
−
            <ZIELADRPLZ>72649</ZIELADRORT>
+
  "ZIELADRNAME3": null,
−
            <ZIELADRSTRASSE>Max-Eyth-Straße 25</ZIELADRORT>
+
  "ZIELADRORT": "Wolfschlugen",
−
        </return>
+
  "ZIELADRPLZ": "72649",
−
      </ns2:my_function_Response>
+
  "ZIELADRSTRASSE": "Max-Eyth-Straße 25",
−
   </S:Body>
+
   "ArtikelDaten": [
−
</S:Envelope>
+
       {
 +
        "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"
 +
      }
 +
  ]
 +
}
 +
</source></div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''PaketscheinDruckMeldung ([https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_Funktionen_Interaktiv#R.C3.BCckmeldung_der_Lieferscheindaten_.28LieferscheinRueckMeldung.29 Rückmeldung der Paketscheindaten])'''</div>
 +
<div class="mw-collapsible-content">
 +
Request from DGS to REST Server
 +
<source lang="json">
 +
{
 +
  "AUFTRAGGEBERID": "01",
 +
  "AUSGANGDATETIME": "01.01.2021",
 +
  "DRUCKDATETIME": "01.01.2021",
 +
  "GEWICHT": "0.700",
 +
  "LIEFERSCHEINNR": "LS-123",
 +
  "PACKSTKGES": "2",
 +
   "PACKSTKNR": "1",
 +
  "TRACKINGNR": "00112233445566778899"
 +
}
 
</source>
 
</source>
−
</div></div>
+
<br>
 +
Response from REST Server to DGS for the above request<source lang="json">
 +
{
 +
  "FEHLER": null,
 +
  "FEHLERTEXT1": null
 +
}
 +
</source></div></div>
 
<br>
 
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">'''PaketscheinDruckMeldung'''</div>
+
<div style="font-weight:bold;line-height:1.6;">'''ArtikelRueckMeldung ([https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_Funktionen_Interaktiv#R.C3.BCckmeldung_der_Positionsdaten_.28Artikel.29_.28ArtikelRueckMeldung.29 Rückmeldung der Positionsdaten])'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
<source>
+
Request from DGS to REST Server
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:std="http://my.path.to.endpoint.functions">
+
<source lang="json">
−
<soapenv:Header/>
+
{
−
<soapenv:Body>
+
  "LIEFERSCHEINNR": "LS-123",
−
<std:my_function>
+
  "ArtikelDaten": [
−
<arg0>
+
      {
−
<AUSGANGDATETIME>28.04.2020</AUSGANGDATETIME>
+
        "ARTIKELBTNNR": "123",
−
<DRUCKDATETIME>28.04.2020 15:23:45</DRUCKDATETIME>
+
        "ARTIKELMENGE": "1",
−
<FEHLERTEXT1/>
+
        "KUNDENARTIKELNR": "0123456789",
−
<FEHLERTEXT2/>
+
        "PACKSTKGES": "2",
−
<GEBUEHR>5.30</GEBUEHR>
+
        "PACKSTKNR": "1",
−
<GEBUEHRWAEHRUNG>EUR</GEBUEHRWAEHRUNG>
+
        "POSITIONNR": "1",
−
<PACKSTUECKID>PID-53185</PACKSTUECKID>
+
        "TRACKINGNR": "00112233445566778899"
−
<RETOURTRACKINGNR/>
+
      },
−
<TRACKINGNR>1Z0000DE6860000014</TRACKINGNR>
+
      {
−
</arg0>
+
        "ARTIKELBTNNR": "124",
−
</std:my_function>
+
        "ARTIKELMENGE": "1",
−
</soapenv:Body>
+
        "KUNDENARTIKELNR": "0123456790",
−
</soapenv:Envelope>
+
        "PACKSTKGES": "2",
 +
        "PACKSTKNR": "2",
 +
        "POSITIONNR": "2",
 +
        "TRACKINGNR": "00112233445566778900"
 +
      }
 +
  ]
 +
}
 
</source>
 
</source>
−
</div></div>
+
<br>
 +
Response from REST Server to DGS for the above request<source lang="json">
 +
{
 +
  "FEHLER": null,
 +
  "FEHLERTEXT1": null
 +
}
 +
</source></div></div>
 
<br>
 
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">'''AusgangsListenRueckmeldung'''</div>
+
<div style="font-weight:bold;line-height:1.6;">'''AusgangslistenRueckMeldung ([https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_Funktionen_Interaktiv#R.C3.BCckmeldung_der_Ausgangslisten_.28AusgangslistenRueckMeldung.29 Rückmeldung der Ausgangslisten])'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
<source>
+
Request from DGS to REST Server
−
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:std="http://my.path.to.endpoint.functions">
+
<source lang="json">
−
<soapenv:Header/>
+
{
−
<soapenv:Body>
+
  "ListenDaten": [
−
<std:my_function>
+
      {
−
<arg0>
+
        "AUFTRAGGEBERID": "01",
−
<PACKSTUECK>
+
        "AUSGANGDATETIME": "01.01.2021",
−
<PACKSTUECKID>PID-102</PACKSTUECKID>
+
        "DRUCKDATETIME": "01.01.2021",
−
<TRACKINGNR>889000232</TRACKINGNR>
+
        "FRACHTFUEHRERTYP": "DPD",
−
</PACKSTUECK>
+
        "GEWICHT": "0.700",
−
<PACKSTUECK>
+
        "LIEFERSCHEINNR": "LS-123",
−
<PACKSTUECKID>PID-100</PACKSTUECKID>
+
        "PACKSTKGES": "2",
−
<TRACKINGNR>889000221</TRACKINGNR>
+
        "PACKSTKNR": "1",
−
</PACKSTUECK>
+
        "TRACKINGNR": "00112233445566778899"
−
<PACKSTUECK>
+
      },
−
<PACKSTUECKID>PID-101</PACKSTUECKID>
+
      {
−
<TRACKINGNR>889000221</TRACKINGNR>
+
        "AUFTRAGGEBERID": "01",
−
</PACKSTUECK>
+
        "AUSGANGDATETIME": "01.01.2021",
−
<PACKSTUECK>
+
        "DRUCKDATETIME": "01.01.2021",
−
<PACKSTUECKID>PID-104</PACKSTUECKID>
+
        "FRACHTFUEHRERTYP": "DPD",
−
<TRACKINGNR>889000243</TRACKINGNR>
+
        "GEWICHT": "0.500",
−
</PACKSTUECK>
+
        "LIEFERSCHEINNR": "LS-123",
−
<PACKSTUECK>
+
        "PACKSTKGES": "2",
−
<PACKSTUECKID>PID-105</PACKSTUECKID>
+
        "PACKSTKNR": "2",
−
<TRACKINGNR>889000243</TRACKINGNR>
+
        "TRACKINGNR": "00112233445566778900"
−
</PACKSTUECK>
+
      }
−
<PACKSTUECK>
+
  ]
−
<PACKSTUECKID>PID-106</PACKSTUECKID>
+
}
−
<TRACKINGNR>889000243</TRACKINGNR>
 
−
</PACKSTUECK>
 
−
</arg0>
 
−
</std:my_function>
 
−
</soapenv:Body>
 
−
</soapenv:Envelope>
 
 
</source>
 
</source>
−
</div></div>
+
<br>
 +
Response from REST Server to DGS for the above request<source lang="json">
 +
{
 +
  "FEHLER": null,
 +
  "FEHLERTEXT1": null
 +
}
 +
</source></div></div>
  
 
= FAQ / Troubleshooting =
 
= FAQ / Troubleshooting =

Version vom 1. Februar 2022, 09:22 Uhr


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

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

Abgerufen von „https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_SOAP_Interface_(Interactive)&oldid=4107“