HVS32 REST Schnittstelle (Automatik-Polling): Unterschied zwischen den Versionen

Aus Wiki - Heidler Strichcode GmbH
Zur Navigation springen Zur Suche springen
(44 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
−
DataGatewayServer Versionsstand: DGS-3_6_0_586
+
[[en:HVS32_REST_Interface_(Polling)]]
 +
 
 +
<!-- ------------------------------------------------------------------------------- Voraussetzungen ------------------------------------------------------------------------------- -->
 +
= Voraussetzungen =
 +
{| class="wikitable"
 +
|-
 +
| DGS-Version || 3.7.0.646 oder höher
 +
|-
 +
| DGS-Plugins || HVS32Client, REST Server
 +
|}
 +
<!-- ------------------------------------------------------------------------------- ENDE Voraussetzungen ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- Funktionsbeschreibung ------------------------------------------------------------------------------- -->
 +
 
 +
= Funktionsbeschreibung =
 +
Bei der REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST Server mit folgenden [[#Übersicht der Funktionen|Funktionen]] zur Verfügung.
 +
Dieser ist in der Standardkonfiguration unter '''http://<Servername>:<Port>/hvs32rest''' erreichbar. Dabei wird der Port 8081 verwendet, welcher bei Bedarf geändert werden kann.
 +
<!-- ------------------------------------------------------------------------------- ENDE Funktionsbeschreibung ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- -->
 +
 
= Datentypen =
 
= Datentypen =
 
'''Integer''' - Zahl mit ausschließlich numerischen Zeichen (0-9).<br>
 
'''Integer''' - Zahl mit ausschließlich numerischen Zeichen (0-9).<br>
Zeile 10: Zeile 27:
 
'''Map''' - Key/Value Map<br>
 
'''Map''' - Key/Value Map<br>
 
<!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->
−
= Übersicht der Funktionen =
+
 
−
'''Fett''' dargestellte Felder müssen IMMER belegt sein.
+
= Zusätzliche Datentypen =
−
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
+
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer [[#Übersicht der Funktionen|Funktion]] genutzt werden.
−
<!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
−
== anonymisiereVersandDaten ==
+
== artikelDaten ==
−
Anonymisiert personenbezogene Daten, wie zum Beispiel Anschrift, Telefonnr., usw.<br><br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
'''Funktion (POST): /hvs32rest/anonymisiereVersandDaten'''<br>
+
<div style="font-weight:bold;line-height:1.6;">Artikel-Daten</div>
−
;AnonymisiereVersandDatenRequest. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="mw-collapsible-content">
−
:Anfrage vom Hostsystem zur Anonymisierung personenbezogener Daten.<br>
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| anzahlBuegel || [[#Datentypen|Integer]] || - || - || Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist
 +
|-
 +
| anzahlPosEtiketten || [[#Datentypen|Integer]] || - || - || Anzahl Artikeletiketten, welche gedruckt werden sollen
 +
|-
 +
| artikelBTNNr || [[#Datentypen|String]] || 25 || - || BTN Nummer / Zolltarifnummer
 +
|-
 +
| artikelEAN || [[#Datentypen|String]] || 20 || - || EAN Nummer
 +
|-
 +
| artikelEinheit || [[#Datentypen|String]] || 10 || - || Einheit der Artikelmenge
 +
|-
 +
| artikelGewicht || [[#Datentypen|Decimal]] || 9 || 3 || Gewicht des Arikels
 +
|-
 +
| artikelGruppe || [[#Datentypen|String]] || 50 || - || Artikelgruppe
 +
|-
 +
| artikelMenge || [[#Datentypen|Decimal]] || 9 || 3 || Menge des Artikels
 +
|-
 +
| artikelServices || [[#Datentypen|String]] || 100 || - || Pipe getrennte Services für diesen Artikel
 +
|-
 +
| artikelSollMenge || [[#Datentypen|Decimal]] || 9 || 3 || -
 +
|-
 +
| artikelText1 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
 +
|-
 +
| artikelText2 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
 +
|-
 +
| artikelText3 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
 +
|-
 +
| artikelText4 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
 +
|-
 +
| artikelVolumen || [[#Datentypen|Decimal]] || 9 || 3 || Volumen des Artikels
 +
|-
 +
| artikelWaehrung || [[#Datentypen|String]] || 3 || - || Währung in welcher der Wert des Artikels angegeben wird
 +
|-
 +
| artikelWert || [[#Datentypen|Decimal]] || 18 || 2 || Wert des Artikels
 
|-
 
|-
−
| auftragsNr || [[#Datentypen|String]] || 20 || - || -
+
| chargeFlag || [[#Datentypen|String]] || 1 || - ||  
 
|-
 
|-
−
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
+
| kundenArtikelNr || [[#Datentypen|String]] || 50 || - || Artikelnummer
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| kundenBestellNr || [[#Datentypen|String]] || 50 || - || Bestellnummer
 
|-
 
|-
−
| packstueckID || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| posAuftragNr || [[#Datentypen|String]] || 50 || - || Auftragsnummer
 
|-
 
|-
−
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
+
| posLieferNr || [[#Datentypen|String]] || 40 || - || Lieferscheinnummer
−
|}
 
−
<br>
 
−
;AnonymisiereVersandDatenResponse. '''[[#Datentypen|Datentyp String]]'''<br>
 
−
:Rückmeldung vom HVS32 nachdem der Datensatz anonymisiert worden ist.
 
−
{| class="wikitable sortable"
 
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
+
| positionNr || [[#Datentypen|String]] || 50 || - || Laufende Nummer innerhalb des Packstücks
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
| serienNr || [[#Datentypen|String]] || 30 || - || Seriennummer
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
| ursprungLand || [[#Datentypen|String]] || 2 || - || Ursprungsland des Artikels
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- -->
−
== echo ==
+
 
−
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br>
+
== gefahrgut ==
−
'''Funktion (GET): /hvs32rest/echo/<Nachricht>'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<Nachricht> wird zurück gegeben.
+
<div style="font-weight:bold;line-height:1.6;">Gefahrgut-Daten</div>
−
<!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- -->
+
<div class="mw-collapsible-content">
−
<!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->
 
−
== ediabschlussAnfrage ==
 
−
Zum Erzeugen der Frachtführer DFÜ ([[#ListenabschlussAnfrage|AusgangsListe]] muss zuvor erzeugt worden sein!)<br><br>
 
−
'''Funktion (POST): /hvs32rest/ediabschlussAnfrage'''<br>
 
−
;EDIabschlussAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
 
−
:Anfrage vom Hostsystem zum Abschließen der EDI (muss nach der [[#ListenabschlussAnfrage|ListenabschlussAnfrage]] erfolgen)
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| auftraggeberID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
| gefahrgutBefoerdKat || [[#Datentypen|Integer]] || 1 || - || Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein.
−
Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br>
 
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird.<br>
+
| gefahrgutBegrenzteMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht
−
(Benötigt Druckerspooler Erweiterungsmodul)
+
|-
 +
| gefahrgutBezeichnung || [[#Datentypen|String]] || 110 || - || Pflicht (siehe ADR-Tabelle Spalte (2))
 +
|-
 +
| gefahrgutBuchst640 || [[#Datentypen|String]] || 1 || - || Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6))
 +
|-
 +
| gefahrgutFFCode || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
 +
|-
 +
| gefahrgutFaktor || [[#Datentypen|Integer]] || 3 || - || Bewertungsfaktor für Punktesummation auf dem Beförderungspapier,  (kann 0, 1, 3, 50 oder 999 sein), eigentlich Pflicht, kann aber eindeutig aus der Beförderungskategorie geschlossen werden, daher muss es nicht unbedingt belegt sein
 +
|-
 +
| gefahrgutFreigestMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht
 +
|-
 +
| gefahrgutID || [[#Datentypen|String]] || 8 || - || Eindeutige Suchnummer für Gefahrgut-Stammdaten
 +
|-
 +
| gefahrgutKCode || [[#Datentypen|String]] || 10 || - || Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b))
 +
|-
 +
| gefahrgutKlasse || [[#Datentypen|String]] || 100 || - || Pflicht (siehe ADR-Tabelle Spalte (3a))
 +
|-
 +
| gefahrgutMenge || [[#Datentypen|Decimal]] || 8 || 3 || Stoff-Menge an Gefahrgut, die ADR-technisch zu deklarieren ist ( in Litern bei Flüssigkeiten und verdichteten Gasen, sonst in kg, bei LQ-Gefahrgut immer kg )
 +
|-
 +
| gefahrgutMengenEinheit || [[#Datentypen|String]] || 2 || - || Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg
 
|-
 
|-
−
| frachtfuehrerTyp || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".<br>
+
| gefahrgutNebenGefahr || [[#Datentypen|String]] || 10 || - || bedingte Pflicht bei Stoffen, bei denen neben der Hauptgefahr-Klasse/Zettelnummer noch Nebengefahr-Zettelnummern vorhanden sind (siehe ADR-Tabelle Spalte (5), wenn dort z.B. 3+6.1+8 eingetragen ist, sind 6.1 und 8 die Nebengefahr-Zettelnummern und als (6.1)(8) im Feld Nebengefahr zu übermitteln )
−
Wenn leer, werden alle Frachtführer abgeschlossen.<br>
 
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll.
+
| gefahrgutNettoExplMasse || [[#Datentypen|Decimal]] || 8 || 3 || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
 
|-
 
|-
−
| versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.<br>
+
| gefahrgutPositionNr || [[#Datentypen|Integer]] || - || - || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
+
| gefahrgutTechBenennung || [[#Datentypen|String]] || 150 || - || bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet)
−
|}
 
−
<br>
 
−
;EDIabschlussAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
 
−
:Rückmeldung vom HVS32 nach einer EDIabschlussAnfrage
 
−
{| class="wikitable sortable"
 
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
| gefahrgutTunnelBCode || [[#Datentypen|String]] || 10 || - || Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15))
 
|-
 
|-
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
| gefahrgutUNNR || [[#Datentypen|String]] || 10 || - || Pflicht (siehe ADR-Tabelle Spalte (1))
 
|-
 
|-
−
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs.
+
| gefahrgutUmweltGef || [[#Datentypen|String]] || 1 || - || T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| gefahrgutVPG || [[#Datentypen|String]] || 3 || - || Verpackungsgruppe, bedingt Pflicht bei den Stoffen, bei denen diese in der ADR-Tabelle belegt ist, kann I,II oder III sein oder gar nicht belegt (letzteres z.B. bei Klasse 2)) (siehe ADR-Tabelle Spalte (4))
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| gefahrgutVerpAnzahl || [[#Datentypen|Integer]] || 4 || - || Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart)
 
|-
 
|-
−
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map.
+
| gefahrgutVerpackungsart || [[#Datentypen|String]] || 5 || - || ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- ListenabschlussAnfrage ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- -->
  
−
== ListenabschlussAnfrage ==
+
== edistatus ==
−
Zum Erzeugen einer AusgangsListe.<br><br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
'''Funktion (POST): /hvs32rest/ListenabschlussAnfrage'''<br>
+
<div style="font-weight:bold;line-height:1.6;">EDIStatus</div>
−
;ListenabschlussAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="mw-collapsible-content">
−
:Anfrage vom Hostsystem zum Abschließen der Listen (muss vor dem [[#ediabschlussAnfrage|ediabschlussAnfrage]] erfolgen)
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
−
Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br>
 
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
+
| statuscode || [[#Datentypen|String]] || 2 || - ||
−
(Benötigt Druckerspooler Erweiterungsmodul)
+
01 = FFDatei wurde erzeugt.<br>
 +
02 = FFDatei wurde geschrieben.<br>
 +
03 = FFDatei wurde verschickt.<br>
 +
11 = FFDatei konnte nicht erzeugt werden!<br>
 +
12 = FFDatei konnte nicht geschrieben werden!<br>
 +
13 = FFDatei konnte nicht verschickt werden!<br>
 +
 
 +
Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration.<br>
 +
D.h. solange kein Status „1x“ enthalten ist, wurde mit der FFDatei gemäß der HVS32 Konfiguration verfahren.
 +
|-
 +
| statustext || [[#Datentypen|String]] || 200 || - || Klartext des Statuscodes
 
|-
 
|-
−
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
+
| fftyp || [[#Datentypen|String]] || 50 || - || Frachtführertyp (z.B. UPS, GLS, DPD)
−
Wenn leer, werden alle Frachtführer abgeschlossen.<br>
 
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
+
| dateityp || [[#Datentypen|String]] || 50 || - || FFDateityp (z.B.: Standard, Express, etc.)
 
|-
 
|-
−
| versandartID || [[#Datentypen|String]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
+
| auftraggeber || [[#Datentypen|String]] || 10 || - || Auftraggebernummer ('''ACHTUNG!''' Nicht die AuftraggeberID)
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
−
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
+
| ffdateinr || [[#Datentypen|String]] || 10 || - || Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)
 
|}
 
|}
−
<br>
+
</div></div>
−
;ListenabschlussAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- -->
−
:Rückmeldung vom HVS32 nach einer ListenabschlussAnfrage
+
<!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- -->
 +
== packstueckDaten ==
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">Packstückdaten</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
 +
|-
 +
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
 
|-
 
|-
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
 +
|-
 +
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 +
|-
 +
| '''gewicht''' || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
 +
|-
 +
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Falls die Paketnummer aus dem Vorsystem verwendet werden soll.
 +
|-
 +
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
 +
|-
 +
| nachnahme || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 +
|-
 +
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 +
|-
 +
| nnVermerk || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
 +
|-
 +
| nnVerwendung || [[#Datentypen|String]] || 1 || - || 'B' = Bar, 'V' = Verrechnungsscheck
 +
|-
 +
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
 +
|-
 +
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nummer pro Sendung
 +
|-
 +
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
 +
|-
 +
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
 +
|-
 +
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
 +
|-
 +
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
 +
|-
 +
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
 +
|-
 +
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe-Versicherungswert
 +
|-
 +
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 +
|-
 +
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 +
|-
 +
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 +
|}
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE packstueckDaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
 +
 
 +
= Übersicht der Funktionen =
 +
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- -->
 +
== Schnittstelle testen (echo) ==
 +
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br>
 +
{| class="wikitable"
 +
|-
 +
| '''Funktion (GET): /hvs32rest/echo/<Nachricht>'''
 +
|}
 +
 
 +
<Nachricht> wird zurück gegeben.
 +
<!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- versanddatenAnfrage ------------------------------------------------------------------------------- -->
 +
== Packstück-Verarbeitung (versanddatenAnfrage) ==
 +
Die Gatewayfunktion versanddatenAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück zu erzeugen und verbuchen. Ein Etikett wird für alle weiteren Funktionen wir Storno, Verladefreigabe, etc. anhand der hostseitigen Packstück-ID identifiziert. Diese wird im Feld PackstueckID übergeben und muss dementsprechend innerhalb des Versandsystems eindeutig sein.
 +
<br>
 +
{| class="wikitable"
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
|'''Funktion (POST) || /hvs32rest/versanddatenAnfrage'''
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
| '''MediaType || text/plain'''<br>
 
|-
 
|-
−
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
+
| '''Charset || UTF-8'''<br>
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
 
−
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
 
  
−
== Sendungs-Verarbeitung (sendungsdatenAnfrage) ==
+
 
−
HVS32-Sendungsdaten Anfrage – wird zur Laufzeit in einzelne [[#versandDatenAnfragen|versandDatenAnfragen]] unterteilt. Muss bei einer Anfrage für das [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] genutzt werden (requestSPM=TRUE).<br><br>
+
<br>
−
'''Funktion (POST): /hvs32rest/sendungsdatenAnfrage'''<br>
+
<!-- ------------------------------------------------------------------------------- Request ------------------------------------------------------------------------------- -->
−
;sendungsdatenAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Anfrage vom Hostsystem zum Drucken einer Sendung mit mehreren Packstücken.
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
|absenderAdresseID
 +
|[[#Datentypen|String]]
 +
|10
 +
| -
 +
| Eindeutige ID um eine Neutrale-Absenderadresse aus dem HVS32 zu verwenden
 
|-
 
|-
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 +
|-
 +
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
 +
|-
 +
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
 
|-
 
|-
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
Zeile 166: Zeile 321:
 
|-
 
|-
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
−
|-
 
−
| ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Ausschluss-Frachtführer für SPM Anfrage
 
 
|-
 
|-
 
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
 
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
Zeile 177: Zeile 330:
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 
|-
 
|-
−
| bestellNr || [[#Datentypen|String]] || 20 || - || -
+
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
 +
|-
 +
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
 
|-
 
|-
−
| email || [[#Datentypen|String]] || 100 || - || Für automatische Mailavisierung
+
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
 
|-
 
|-
 
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
 
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
Zeile 185: Zeile 346:
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
|-
 
|-
−
| flexZustellungEmailadResponsese || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Email-Adresse
+
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
 +
|-
 +
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
 +
|-
 +
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
 
|-
 
|-
−
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
+
|freiAvis1
 +
|[[#Datentypen|String]]
 +
| -
 +
| -
 +
| -
 
|-
 
|-
−
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer.
+
|freiAvis2
 +
|[[#Datentypen|String]]
 +
| -
 +
| -
 +
| -
 
|-
 
|-
 
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 +
|-
 +
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 +
|-
 +
| '''gewicht''' ||[[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
 +
|-
 +
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
 
|-
 
|-
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 +
|-
 +
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
 
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
 
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
Zeile 199: Zeile 398:
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| Lagerkennzeichen || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
+
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
 +
|-
 +
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
 +
|-
 +
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
 +
|-
 +
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
 
|-
 
|-
−
| LieferantenID || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
+
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
|-
 
|-
−
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
+
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 
|-
 
|-
 
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
 
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
Zeile 226: Zeile 431:
 
|-
 
|-
 
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 +
|-
 +
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
 +
|-
 +
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
 +
|-
 +
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
 
|-
 
|-
 
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
|-
 
|-
−
| [[#packstueckDaten|packstueckDaten]] || [[#Datentypen|Sequence]] [[#packstueckDaten|<PackStueckDaten>]] || - || - || -
+
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
 
|-
 
|-
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 +
|-
 +
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
 +
|-
 +
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
 +
|-
 +
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
 +
|-
 +
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
 
|-
 
|-
 
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
 
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
Zeile 254: Zeile 473:
 
|-
 
|-
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
−
|-
 
−
| requestSPM || [[#Datentypen|String]] || 5 || - || T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
 
 
|-
 
|-
 
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
Zeile 265: Zeile 482:
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
|-
 
|-
−
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
+
| terminArt || [[#Datentypen|String]] || 1 || - || 'A' = ab diesem Tag liefern
 +
'B' = bis zu diesem Tag liefern
 +
 
 +
'F' = an diesem Tag liefern
 
|-
 
|-
 
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM
+
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
 
|-
 
|-
 
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 +
|-
 +
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
 
|-
 
|-
 
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
|-
 
|-
−
| vorgabeFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Vorgabe-Frachtführer für [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] Anfrage
+
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
 
|-
 
|-
 
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen werden soll
+
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 +
|-
 +
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 +
|-
 +
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
 +
|-
 +
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 
|-
 
|-
 
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
 
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
Zeile 285: Zeile 513:
 
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
 
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
 
|-
 
|-
−
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort des Bahnhofs
+
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort
 
|-
 
|-
−
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ)
+
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
 
|-
 
|-
 
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
Zeile 305: Zeile 533:
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|}
 
|}
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE Request ------------------------------------------------------------------------------- -->
 +
<br>
 +
<!-- ------------------------------------------------------------------------------- Response ------------------------------------------------------------------------------- -->
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 +
|-
 +
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 +
|-
 +
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 +
|-
 +
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 +
|-
 +
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
 +
|-
 +
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
 +
|-
 +
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 +
|-
 +
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 +
|-
 +
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
 +
|-
 +
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 +
|-
 +
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
 +
|-
 +
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
 +
|-
 +
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
 +
|-
 +
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 +
|-
 +
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
 +
|-
 +
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
 +
|-
 +
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|}
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE Response ------------------------------------------------------------------------------- -->
 
<br>
 
<br>
−
;SendungsdatenAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<!-- ------------------------------------------------------------------------------- Beispiel ------------------------------------------------------------------------------- -->
−
:Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
;Sendungsdaten
+
<div style="font-weight:bold;line-height:1.6;">Beispiele</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"absenderAdresseID": "",
 +
"ansprechpartner": "",
 +
"assoc": {
 +
"":""
 +
},
 +
"artikelDaten": [
 +
{
 +
"anzahlBuegel": 0,
 +
"anzahlPosEtiketten": 0,
 +
"artikelBTNNr": "",
 +
"artikelEAN": "",
 +
"artikelEinheit": "",
 +
"artikelGewicht": 0,
 +
"artikelGruppe": "",
 +
"artikelMenge": 0,
 +
"artikelServices": "",
 +
"artikelSollMenge": 0,
 +
"artikelText1": "",
 +
"artikelText2": "",
 +
"artikelText3": "",
 +
"artikelText4": "",
 +
"artikelVolumen": 0,
 +
"artikelWaehrung": "",
 +
"artikelWert": 0,
 +
"chargeFlag": "",
 +
"kundenArtikelNr": "",
 +
"kundenBestellNr": "",
 +
"posAuftragNr": "",
 +
"posLieferNr": "",
 +
"positionNr": "",
 +
"serienNr": "",
 +
"ursprungLand": ""
 +
}
 +
],
 +
"auftragNr": "",
 +
"auftraggeberID": "",
 +
"avisHinweis1": "",
 +
"avisHinweis2": "",
 +
"avisZusatz1": "",
 +
"avisZusatz2": "",
 +
"bestellNr": "",
 +
"druckername": "",
 +
"email": "",
 +
"faxNr": "",
 +
"frachtBrief": "",
 +
"frachtfuehrerKdNr": "",
 +
"freiAvis1": "",
 +
"freiAvis2": "",
 +
"frankaturKennung": "",
 +
"gefahrgut": [
 +
{
 +
"gefahrgutBefoerdKat": 0,
 +
"gefahrgutBegrenzteMenge": "",
 +
"gefahrgutBezeichnung": "",
 +
"gefahrgutBuchst640": "",
 +
"gefahrgutFFCode": "",
 +
"gefahrgutFaktor": 0,
 +
"gefahrgutFreigestMenge": "",
 +
"gefahrgutKCode": "",
 +
"gefahrgutKlasse": "",
 +
"gefahrgutMenge": 0,
 +
"gefahrgutMengenEinheit": "",
 +
"gefahrgutNebenGefahr": "",
 +
"gefahrgutNettoExplMasse": 0,
 +
"gefahrgutTunnelBCode": "",
 +
"gefahrgutUNNR": "",
 +
"gefahrgutUmweltGef": "",
 +
"gefahrgutVPG": "",
 +
"gefahrgutVerpAnzahl": 0,
 +
"gefahrgutVerpackungsart": ""
 +
}
 +
],
 +
"gewicht": 0,
 +
"ilnNr": "",
 +
"infotext1": "",
 +
"infotext2": "",
 +
"infotext3": "",
 +
"infotext4": "",
 +
"infotext5": "",
 +
"infotext6": "",
 +
"infotext7": "",
 +
"infotext8": "",
 +
"infotext9": "",
 +
"infotext10": "",
 +
"kostenstelle": "",
 +
"kundenNr": "",
 +
"lieferscheinNr": "",
 +
"nachnahme": 0,
 +
"nettoGewicht": 0,
 +
"neutabsenderLKZ": "",
 +
"neutabsenderName1": "",
 +
"neutabsenderName2": "",
 +
"neutabsenderName3": "",
 +
"neutabsenderOrt": "",
 +
"neutabsenderPLZ": "",
 +
"neutabsenderStrasse": "",
 +
"nnVermerk": "",
 +
"nnVerwendung": "",
 +
"nnWaehrung": "",
 +
"packStkGes": 0,
 +
"packStkNr": 0,
 +
"packplatz": "",
 +
"packstueckBreite": 0,
 +
"packstueckHoehe": 0,
 +
"packstueckID": "",
 +
"packstueckLaenge": 0,
 +
"paperlessInvoice": "",
 +
"postLeitcode": "",
 +
"postZielFrachtzent": "",
 +
"rechnungsEmpfLKZ": "",
 +
"rechnungsEmpfName1": "",
 +
"rechnungsEmpfName2": "",
 +
"rechnungsEmpfName3": "",
 +
"rechnungsEmpfOrt": "",
 +
"rechnungsEmpfPLZ": "",
 +
"rechnungsEmpfStrasse": "",
 +
"sendungsinhalt": "",
 +
"sonderdienste": "",
 +
"telefonNr": "",
 +
"terminArt": "",
 +
"terminDatum": "",
 +
"terminZeit": "",
 +
"ustIDNr": "",
 +
"verpackungsart": "",
 +
"versandartID": "",
 +
"versicherungswert": 0,
 +
"vwWaehrung": "",
 +
"warenwert": 0,
 +
"wwWaehrung": "",
 +
"zahlungsbedingung": "",
 +
"zbZoll": "",
 +
"zielAdrBahnhof": "",
 +
"zielAdrLKZ": "",
 +
"zielAdrName1": "",
 +
"zielAdrName2": "",
 +
"zielAdrName3": "",
 +
"zielAdrOrt": "",
 +
"zielAdrPLZ": "",
 +
"zielAdrRegion": "",
 +
"zielAdrStrasse": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"packstueckID": "",
 +
"trackingNr": "",
 +
"retourTrackingNr": "",
 +
"versandSendungsNr": "",
 +
"druckDateTime": "",
 +
"ausgangDateTime": "",
 +
"gebuehr": 0,
 +
"gebuehrWaehrung": "",
 +
"fehlertext1": "",
 +
"fehlertext2": "",
 +
"etikettName": "",
 +
"etikettDaten": "",
 +
"zusatzEtikettenDaten": {
 +
"": ""
 +
},
 +
"trackingURL": "",
 +
"zusatzfeld1": "",
 +
"zusatzfeld2": "",
 +
"zusatzfeld3": "",
 +
"zusatzfeld4": "",
 +
"zusatzfeld5": "",
 +
"zusatzfeld6": "",
 +
"zusatzfeld7": "",
 +
"zusatzfeld8": "",
 +
"zusatzfeld9": "",
 +
"zusatzfeld10": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE Beispiel ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ENDE versanddatenAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
 +
 
 +
== Etikett nachdrucken (versanddatenNachdruckAnfrage) ==
 +
Die Gatewayfunktion versanddatenNachdruckAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück nachzudrucken. Ein Etikett wird anhand der hostseitigen Packstück-ID nachgedruckt. Diese wird im Feld PackstueckID übergeben. Bei manchen Frachtführern (z.B. DPD) werden beim Nachdruck neue Trackingnummern vergeben. Somit ist die alte Trackingnummer nicht mehr gültig und das alte Versandetikett muss vernichtet werden. Die neue Trackingnummer kann in der Rückmeldung zurückgemeldet werden.
 +
<br>
 +
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| fehler || [[#Datentypen|String]] || - || - || Wird im Fehlerfall befüllt
+
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird.
 
|-
 
|-
−
| sendungsGebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachkosten
+
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
|-
 
|-
−
| sendungsGebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
+
| '''packstueckID''' || [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
 
|-
 
|-
−
| versandSendungsNr || [[#Datentypen|String]] || 20 || - || Sendungsnummer
+
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
 
|}
 
|}
−
 
+
</div></div>
−
;Packstückdaten
+
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 358: Zeile 859:
 
|-
 
|-
 
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 +
|-
 +
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
 
|-
 
|-
 
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
 
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
Zeile 381: Zeile 884:
 
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- sperreVersanddaten ------------------------------------------------------------------------------- -->
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"druckername": "",
 +
"packplatz": "",
 +
"packstueckID": "",
 +
"trackingNr": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"packstueckID": "",
 +
"trackingNr": "",
 +
"retourTrackingNr": "",
 +
"versandSendungsNr": "",
 +
"druckDateTime": "",
 +
"ausgangDateTime": "",
 +
"gebuehr": 0,
 +
"gebuehrWaehrung": "",
 +
"fehlertext1": "",
 +
"fehlertext2": "",
 +
"etikettName": "",
 +
"etikettDaten": "",
 +
"zusatzEtikettenDaten": {
 +
"": ""
 +
},
 +
"trackingURL": "",
 +
"zusatzfeld1": "",
 +
"zusatzfeld2": "",
 +
"zusatzfeld3": "",
 +
"zusatzfeld4": "",
 +
"zusatzfeld5": "",
 +
"zusatzfeld6": "",
 +
"zusatzfeld7": "",
 +
"zusatzfeld8": "",
 +
"zusatzfeld9": "",
 +
"zusatzfeld10": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- -->
  
−
== sperreVersanddaten ==
+
== Packstück stornieren (stornoVersanddaten) ==
−
HVS32-Sperre-VersandDaten zum Sperren von bereits freigegebenen Versandeinheiten<br><br>
+
Die Gatewayfunktion stornoVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort bestehende Packstücke zu stornieren, die noch nicht auf einer Ausgangsliste sind. In der Regel wird ein Packstück anhand der hostseitigen Packstück-ID storniert. Diese wird im Feld PackstueckID übergeben. Zusätzlich zur hostseitigen Packstück-ID kann auch die TrackingNr zur Identifikation des Packstücks beitragen, für den Fall, dass die hostseitige Packstück-ID keine Eindeutigkeit garantieren kann. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Storno wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
−
'''Funktion (POST): /hvs32rest/sperreVersanddaten'''<br>
+
<br>
−
;SperrAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
{| class="wikitable"
−
:Anfrage vom Hostsystem zum Sperren von Packstücken im HVS32.  
+
|-
 +
|'''Funktion (POST) || /hvs32rest/stornoVersanddaten'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 396: Zeile 958:
 
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
|-
 
|-
−
| packstueckID|| [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
 +
|-
 +
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;SperrAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer sperreVersanddaten
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 411: Zeile 977:
 
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- -->
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
== Packstück-Storno (stornoVersanddaten) ==
+
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
−
HVS32-StornoVersandDaten zum Stornieren von erzeugten Versandeinheiten<br><br>
+
<div class="mw-collapsible-content">
−
'''Funktion (POST): /hvs32rest/stornoVersanddaten'''<br>
+
;Request
−
;StornoAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
<source lang="json">
−
:Anfrage vom Hostsystem zum Stornieren/Löschen eines zuvor etikettierten Packstücks.
+
{
 +
"packplatz": "",
 +
"packstueckID": "",
 +
"trackingNr": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- -->
 +
== Packstück verladen / freigeben (verladeVersanddaten) ==
 +
Die Gatewayfunktion verladeVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang frei zu geben. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Freigabe wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
 +
<br>
 +
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/verladeVersanddaten'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| hostFreigabeNr || [[#Datentypen|String]] || 20 || - || Hostseitige Freigabenummer die für dieses Packstück gesetzt wird.
 +
|-
 +
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 +
|-
 +
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. <br>
 +
Beim Etikettendruck zuvor muss die gleiche ID übergeben worden sein, damit das HVS32 das zu verladene Packstück eindeutig identifizieren kann.
 +
|-
 +
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird.
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"hostFreigabeNr": "",
 +
"packplatz": "",
 +
"packstueckID": "",
 +
"wechselbruecke": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE verladeVersandaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- sperreVersanddaten ------------------------------------------------------------------------------- -->
 +
 
 +
== Packstück sperren (sperreVersanddaten) ==
 +
Die Gatewayfunktion sperreVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang zu sperren. Gesperrte Packstücke, werden für den Tagesabschluss nicht berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Sperrung wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
 +
<br>
 +
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/sperreVersanddaten'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 425: Zeile 1.093:
 
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
|-
 
|-
−
| '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| '''packstueckID'''|| [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
−
|-
 
−
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
 
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;StornoAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer stornoVersanddaten
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 442: Zeile 1.110:
 
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- -->
+
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"packplatz": "",
 +
"packstueckID": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- -->
  
−
== tagesabschluss ==
+
== Tagesabschluss (tagesabschluss) ==
−
Generiert den HVS32 Tagesabschluss ([[#ListenabschlussAnfrage|Listenabschluss]] + [[#ediabschlussAnfrage|EDI Übertragung]])<br><br>
+
Das Gateway sendet die tagesabschluss-Anfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit ein Tagesabschluss anhand der zusätzlich übergebenen Parameter ausgelöst. Der Tagesabschluss setzt sich aus den Punkten Ausgangsliste erzeugen und Frachtführer DFÜ erzeugen zusammen. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Ausführen des Tagesabschluss statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Tagesabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
−
'''Funktion (POST): /hvs32rest/tagesabschluss'''<br>
+
<br>
−
;TagesabschlussAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
{| class="wikitable"
−
:Anfrage vom Hostsystem zum Abschließen der Listen + EDI
+
|-
 +
|'''Funktion (POST) || /hvs32rest/tagesabschluss'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
| auftraggeberID || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
−
Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br>
+
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
 
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
 
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
 
(Benötigt Druckerspooler Erweiterungsmodul)
 
(Benötigt Druckerspooler Erweiterungsmodul)
 
|-
 
|-
−
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
+
| frachtfuehrerTyp || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
−
Wenn leer, werden alle Frachtführer abgeschlossen.<br>
+
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
 
|-
 
|-
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
 
|-
 
|-
−
| versandartID || [[#Datentypen|String]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
+
| versandartID || [[#Datentypen|Sequence<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
 
|-
 
|-
 
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
 
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;TagesabschlussAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer tagesabschluss
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 482: Zeile 1.181:
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
|-
 
|-
−
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#Sequence|<EDIStatus>]] || - || - || -
+
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] '''[[#Sequence|<EDIStatus>]]''' || - || - || -
 
|-
 
|-
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
Zeile 491: Zeile 1.190:
 
|-
 
|-
 
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
 
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
 +
|-
 +
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
 +
|-
 +
| ausgangsListeNr|| [[#Datentypen|Sequence<String>]] || - || - || Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"auftraggeberID": [
 +
""
 +
],
 +
"druckername": "",
 +
"frachtfuehrerTyp": [
 +
""
 +
],
 +
"packplatz": "",
 +
"versandartID": [
 +
""
 +
],
 +
"wechselbruecke": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"edistatus": [
 +
{
 +
"fehlercode": 0,
 +
"statuscode": "",
 +
"statustext": "",
 +
"fftyp": "",
 +
"dateityp": "",
 +
"auftraggeber": "",
 +
"ffdateinr": ""
 +
}
 +
],
 +
"listenDaten": {},
 +
"ausgangsListeNr": [
 +
"75"
 +
]
 +
}
 +
</source>
 +
</div></div>
 
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- -->
 
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- listenabschlussAnfrage ------------------------------------------------------------------------------- -->
  
−
== updateVersanddaten ==
+
== Ausgangsliste erzeugen (listenabschlussAnfrage) ==
−
HVS32-UpdateVersandDaten zur Aktualisierung von Feldinhalten bei einer bereits erzeugten Versandeinheit. Zur Identifizierung der Versandeinheit dient das Feld PackstueckID. Tatsächlich zu aktualisierende Felder müssen zusätzlich im HVS32 unter den Sektionen GW_UpdateFieldList_VE / AE / AssocMemo / Lieferung<br><br>
+
Das Gateway sendet die listenabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Ausgangsliste anhand der zusätzlich übergebenen Parameter erzeugt. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Listenabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Ausgangsliste statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
−
'''Funktion (POST): /hvs32rest/updateVersanddaten'''<br>
+
<br>
−
;[[#versanddatenAnfrage|VersandDatenAnfrage]]. '''[[#Datentypen|Datentyp String]]'''<br>
+
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/listenabschlussAnfrage'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
 +
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
 +
|-
 +
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
 +
(Benötigt Druckerspooler Erweiterungsmodul)
 +
|-
 +
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
 +
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
 +
|-
 +
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
 +
|-
 +
| versandartID || [[#Datentypen|String]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
 +
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
 +
|-
 +
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 +
|-
 +
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 +
|-
 +
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
 +
|-
 +
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
 +
|-
 +
| ausgangsListeNr|| [[#Datentypen|Sequence<String>]] || - || - || Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"auftraggeberID": [
 +
""
 +
],
 +
"druckername": "",
 +
"frachtfuehrerTyp": [
 +
""
 +
],
 +
"packplatz": "",
 +
"versandartID": [
 +
""
 +
],
 +
"wechselbruecke": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"listenDaten": {
 +
"": ""
 +
},
 +
"ausgangsListeNr": [
 +
"75"
 +
]
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ListenNachdruck------------------------------------------------------------------------------- -->
  
 +
== Ausgangsliste nachdrucken (listenNachdruckAnfrage) ==
 +
Das Gateway sendet die listenNachdruckAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine bereits erstellte Ausgangsliste anhand der übergebenen ausgangsListeNr anchgedruckt. Eine Liste kann nur nachgedruckt werden, wenn diese bereits über die Funktionen tagesabschluss, listenabschlussAnfrage oder manuell über die HVS32 Maske erzeugt wurde. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
 
<br>
 
<br>
−
;[[#versanddatenAnfrage|VersanddatenAntwort]]. '''[[#Datentypen|Datentyp String]]'''
+
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/listenNachdruckAnfrage'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| ausgangsListeNr || [[#Datentypen|Sequence<String>]] || - || - || Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt werden sollen.
 +
|-
 +
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
 +
(Benötigt Druckerspooler Erweiterungsmodul)
 +
|-
 +
| auftraggeberID || [[#Datentypen|Sequence<String>]] || - || - || Liste der Auftraggerber-ID's, für welche die Listen nachgedruckt werden sollen.
 +
|-
 +
| frachtFuehrerTyp || [[#Datentypen|Sequence<String>]] || - || - || Liste der Frachtführertypen, für welche die Listen nachgedruckt werden sollen.
 +
|-
 +
| erstellDatum || [[#Datentypen|String]] || 10 || - || Erstelldatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001
 +
|-
 +
| druckDatum || [[#Datentypen|String]] || 10 || - || Druckdatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001 oder null wenn nur Listen nachgedruckt werden sollen, die noch nicht gedruckt wurden
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| ausgangsListeNr || [[#Datentypen|Sequence<String>]] || - || - || Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt wurden.
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 +
|-
 +
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 +
|-
 +
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
 +
|-
 +
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"ausgangsListeNr": [
 +
"77"
 +
],
 +
"druckername": "",
 +
"auftraggeberID": [],
 +
"frachtFuehrerTyp": [],
 +
"erstellDatum": "",
 +
"druckDatum": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"ausgangsListeNr": [
 +
"77"
 +
]
 +
"assoc": {
 +
"":""
 +
},
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"listenDaten": {
 +
"": ""
 +
}
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE ListenNachdruck ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->
  
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
== Frachtführer DFÜ erzeugen (ediabschlussAnfrage) ==
−
<!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- -->
+
Das Gateway sendet die ediabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Frachtführer DFÜ anhand der zusätzlich übergebenen Parameter erzeugt und (falls konfiguriert) an den Frachtführer übertragen. Nur Packstücke, für welche zuvor eine Ausgangsliste erzeugt wurde, werden für eine Frachtführer DFÜ berücksichtigt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Frachtführer DFÜ statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem EDIAbschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
−
<!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- -->
+
<br>
−
== Verlade-Freigabe (verladeVersanddaten) ==
+
{| class="wikitable"
−
HVS32-VerladeVersandDaten zur Ausgangsfreigabe von erzeugten Versandeinheiten<br><br>
+
|-
−
'''Funktion (POST): /hvs32rest/verladeVersanddaten'''<br>
+
|'''Funktion (POST) || /hvs32rest/ediabschlussAnfrage'''
−
;VerladeAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
|-
−
:Anfrage vom Hostsystem zur Ausgangsverladung eines zuvor etikettierten Packstücks.
+
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| hostFreigabeNr || [[#Datentypen|String]] || 20 || - || Hostseitige Freigabenummer die für dieses Packstück gesetzt wird.
+
| auftraggeberID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.
 +
(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)
 +
|-
 +
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird.<br>
 +
(Benötigt Druckerspooler Erweiterungsmodul)
 +
|-
 +
| frachtfuehrerTyp || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.
 +
(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll.
 
|-
 
|-
−
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. <br>
+
| versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.
−
Beim Etikettendruck zuvor muss die gleiche ID übergeben worden sein, damit das HVS32 das zu verladene Packstück eindeutig identifizieren kann.
+
(Option MultiVATagesabschluss muss im HVS32 aktiv sein)
 
|-
 
|-
−
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird.
+
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;VerladeAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer VerladeAnfrage
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs.
 
|-
 
|-
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
Zeile 536: Zeile 1.494:
 
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map.
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE verladeVersandaten ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- versanddatenAnfrage ------------------------------------------------------------------------------- -->
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"auftraggeberID": [
 +
""
 +
],
 +
"druckername": "",
 +
"frachtfuehrerTyp": [
 +
""
 +
],
 +
"packplatz": "",
 +
"versandartID": [
 +
""
 +
],
 +
"wechselbruecke": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"edistatus": [
 +
{
 +
"fehlercode": 0,
 +
"statuscode": "",
 +
"statustext": "",
 +
"fftyp": "",
 +
"dateityp": "",
 +
"auftraggeber": "",
 +
"ffdateinr": ""
 +
}
 +
],
 +
"listenDaten": {}
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
  
−
== Packstück-Verarbeitung (versanddatenAnfrage) ==
+
== Packstückdaten prüfen (versanddatenPruefAnfrage) ==
−
HVS32-VersandDatenAnfrage zum Erzeugen von Versandeinheiten und anschließendem Druck der zugehörigen Etiketten.<br><br>
+
Das Gateway sendet die versanddatenPruefAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine VersandDatenAnfrage simuliert. Dabei werden keine Etiketten gedruckt und das Packstück bzw. das Etikett wird nicht verbucht, jedoch sind alle weiteren Prozesse identisch zur VersandDatenAnfrage (Routenermittlung, Trackingnummer-Ermittlung, Adressprüfung, etc.) Diese Funktion dient dazu im Vorfeld alle Versand-Daten zu validieren.
−
'''Funktion (POST): /hvs32rest/versanddatenAnfrage'''<br>
+
<br>
−
;VersanddatenAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
{| class="wikitable"
−
:Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück.
+
|-
 +
|'''Funktion (POST) || /hvs32rest/versanddatenPruefAnfrage'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 552: Zeile 1.565:
 
|-
 
|-
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
−
|-
 
−
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
 
 
|-
 
|-
 
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
 
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
Zeile 570: Zeile 1.581:
 
|-
 
|-
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
−
|-
 
−
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 
−
|-
 
−
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 
−
|-
 
−
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 
 
|-
 
|-
 
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
 
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
Zeile 582: Zeile 1.587:
 
|-
 
|-
 
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
 
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
−
|-
 
−
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
 
 
|-
 
|-
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
Zeile 597: Zeile 1.600:
 
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 
|-
 
|-
−
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
+
| '''gewicht''' ||[[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
−
|-
 
−
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
 
 
|-
 
|-
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
Zeile 627: Zeile 1.628:
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
+
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
−
|-
 
−
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
 
−
|-
 
−
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
 
−
|-
 
−
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
 
 
|-
 
|-
 
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
|-
 
|-
 
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
−
|-
 
−
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 
 
|-
 
|-
 
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
 
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
Zeile 667: Zeile 1.654:
 
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
 
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
 
|-
 
|-
−
| packStkGes || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
+
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
|-
 
|-
−
| packStkNr || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
+
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
 
|-
 
|-
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
Zeile 702: Zeile 1.689:
 
|-
 
|-
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
−
|-
 
−
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
 
|-
 
|-
 
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
 
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
−
|-
 
−
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
 
 
|-
 
|-
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
Zeile 724: Zeile 1.707:
 
|-
 
|-
 
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
 
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
−
|-
 
−
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
 
|-
 
|-
 
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 
|-
 
|-
 
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
−
|-
 
−
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
 
 
|-
 
|-
 
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
Zeile 759: Zeile 1.738:
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;VersanddatenAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|-
−
|-
 
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
−
|-
 
−
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 
−
|-
 
−
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 
 
|-
 
|-
 
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
Zeile 776: Zeile 1.751:
 
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
|-
 
|-
−
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 
|-
 
|-
−
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
−
|-
 
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
 
−
|-
 
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 
−
|-
 
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 
−
|-
 
−
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
 
−
|-
 
−
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 
−
|-
 
−
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
 
−
|-
 
−
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
 
−
|-
 
−
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
 
−
|-
 
−
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 
−
|-
 
−
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
 
−
|-
 
−
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
 
−
|-
 
−
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
−
|-
 
−
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE versanddatenAnfrage ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"ansprechpartner": "",
 +
"artikelDaten": [
 +
{
 +
"anzahlBuegel": 0,
 +
"anzahlPosEtiketten": 0,
 +
"artikelBTNNr": "",
 +
"artikelEAN": "",
 +
"artikelEinheit": "",
 +
"artikelGewicht": 0,
 +
"artikelGruppe": "",
 +
"artikelMenge": 0,
 +
"artikelServices": "",
 +
"artikelSollMenge": 0,
 +
"artikelText1": "",
 +
"artikelText2": "",
 +
"artikelText3": "",
 +
"artikelText4": "",
 +
"artikelVolumen": 0,
 +
"artikelWaehrung": "",
 +
"artikelWert": 0,
 +
"chargeFlag": "",
 +
"kundenArtikelNr": "",
 +
"kundenBestellNr": "",
 +
"posAuftragNr": "",
 +
"posLieferNr": "",
 +
"positionNr": "",
 +
"serienNr": "",
 +
"ursprungLand": ""
 +
}
 +
],
 +
"auftragNr": "",
 +
"auftraggeberID": "",
 +
"avisHinweis1": "",
 +
"avisHinweis2": "",
 +
"avisZusatz1": "",
 +
"avisZusatz2": "",
 +
"bestellNr": "",
 +
"druckername": "",
 +
"email": "",
 +
"faxNr": "",
 +
"frachtBrief": "",
 +
"frachtfuehrerKdNr": "",
 +
"frankaturKennung": "",
 +
"gefahrgut": [
 +
{
 +
"gefahrgutBefoerdKat": 0,
 +
"gefahrgutBegrenzteMenge": "",
 +
"gefahrgutBezeichnung": "",
 +
"gefahrgutBuchst640": "",
 +
"gefahrgutFFCode": "",
 +
"gefahrgutFaktor": 0,
 +
"gefahrgutFreigestMenge": "",
 +
"gefahrgutKCode": "",
 +
"gefahrgutKlasse": "",
 +
"gefahrgutMenge": 0,
 +
"gefahrgutMengenEinheit": "",
 +
"gefahrgutNebenGefahr": "",
 +
"gefahrgutNettoExplMasse": 0,
 +
"gefahrgutTunnelBCode": "",
 +
"gefahrgutUNNR": "",
 +
"gefahrgutUmweltGef": "",
 +
"gefahrgutVPG": "",
 +
"gefahrgutVerpAnzahl": 0,
 +
"gefahrgutVerpackungsart": ""
 +
}
 +
],
 +
"gewicht": 0,
 +
"ilnNr": "",
 +
"infotext1": "",
 +
"infotext2": "",
 +
"infotext3": "",
 +
"infotext4": "",
 +
"infotext5": "",
 +
"infotext6": "",
 +
"infotext7": "",
 +
"infotext8": "",
 +
"infotext9": "",
 +
"infotext10": "",
 +
"kostenstelle": "",
 +
"kundenNr": "",
 +
"lieferscheinNr": "",
 +
"nachnahme": 0,
 +
"nettoGewicht": 0,
 +
"neutabsenderLKZ": "",
 +
"neutabsenderName1": "",
 +
"neutabsenderName2": "",
 +
"neutabsenderName3": "",
 +
"neutabsenderOrt": "",
 +
"neutabsenderPLZ": "",
 +
"neutabsenderStrasse": "",
 +
"nnVermerk": "",
 +
"nnVerwendung": "",
 +
"nnWaehrung": "",
 +
"packStkGes": 0,
 +
"packStkNr": 0,
 +
"packplatz": "",
 +
"packstueckBreite": 0,
 +
"packstueckHoehe": 0,
 +
"packstueckID": "",
 +
"packstueckLaenge": 0,
 +
"paperlessInvoice": "",
 +
"postLeitcode": "",
 +
"postZielFrachtzent": "",
 +
"rechnungsEmpfLKZ": "",
 +
"rechnungsEmpfName1": "",
 +
"rechnungsEmpfName2": "",
 +
"rechnungsEmpfName3": "",
 +
"rechnungsEmpfOrt": "",
 +
"rechnungsEmpfPLZ": "",
 +
"rechnungsEmpfStrasse": "",
 +
"sendungsinhalt": "",
 +
"sonderdienste": "",
 +
"telefonNr": "",
 +
"terminArt": "",
 +
"terminDatum": "",
 +
"terminZeit": "",
 +
"ustIDNr": "",
 +
"verpackungsart": "",
 +
"versandartID": "",
 +
"versicherungswert": 0,
 +
"vwWaehrung": "",
 +
"warenwert": 0,
 +
"wwWaehrung": "",
 +
"zahlungsbedingung": "",
 +
"zbZoll": "",
 +
"zielAdrBahnhof": "",
 +
"zielAdrLKZ": "",
 +
"zielAdrName1": "",
 +
"zielAdrName2": "",
 +
"zielAdrName3": "",
 +
"zielAdrOrt": "",
 +
"zielAdrPLZ": "",
 +
"zielAdrRegion": "",
 +
"zielAdrStrasse": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"druckDateTime": "",
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- -->
  
−
== Label-Nachdruck (versanddatenNachdruckAnfrage) ==
+
== Packstückdaten aktualisieren (updateVersanddaten) ==
−
Dient dem Nachdruck von Versandetiketten (Schalter in Sektion AutomatikPolling: NachdruckBeiVersanddatenanfrage=“ON“ muss gesetzt sein)<br><br>
+
Die Gatewayfunktion updateVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort die Daten von bestehende Packstücken zu verändern. Diese Anfrage wird zum Beispiel gesendet, wenn der Warenwert für ein Packstück erst zu einem späteren Zeitpunkt bekannt ist. Aktualisiert werden können Daten innerhalb der Tabellen Versandeinheit, Abrechnungseinheit und Lieferung. Dabei wird stets über das Feld PackstueckID und bei Belegung auch über das Feld TrackingNr gesucht. Bei dieser Anfrage werden allerdings die zu aktualisierenden Felder und Inhalte nicht mehr nach den Richtlinien des Frachtführers geprüft (z.B. Gewichtsgrenzen, etc.). Es muss somit vom Vorsystem sichergestellt werden, dass die aktualisierenden Werte mit den Richtlinien des Frachtführers übereinstimmen. Sollte dies nicht möglich sein, kann diese Funktion nicht genutzt werden, sondern das Etikett muss storniert und neu verarbeitet werden. Außerdem können Felder, welche bereits auf einem Etikett angedruckt oder vom Versandsystem HVS32 in einer Frachtführerabwicklung ermittelt wurden (z.B. Adresse, Route, TrackingNr, Sonderdienste, etc.) nicht manipuliert werden. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Update wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.
−
'''Funktion (POST): /hvs32rest/versanddatenNachdruckAnfrage'''<br>
+
<br>
−
;VersanddatenNachdruckAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
+
{| class="wikitable"
−
:Anfrage vom Hostsystem zum Nachdruck eines zuvor erstellten Versandetiketts. Schalter NachdruckBeiVersanddatenanfrage=“ON“ in Sektion AutomatikPolling muss gesetzt sein.
 
−
 
 
−
{| class="wikitable sortable"
 
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
|'''Funktion (POST) || /hvs32rest/updateVersanddaten'''
−
|-
 
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird.
 
 
|-
 
|-
−
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| '''MediaType || text/plain'''<br>
 
|-
 
|-
−
| '''packstueckID''' || [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| '''Charset || UTF-8'''<br>
−
|-
 
−
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
 
 
|}
 
|}
 
<br>
 
<br>
−
;[[#versanddatenAnfrage|VersanddatenAntwort]]. '''[[#Datentypen|Datentyp String]]'''
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
 
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
<div class="mw-collapsible-content">
−
<!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
+
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
−
<!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
 
−
 
 
−
== Daten-Prüfung (versanddatenPruefAnfrage) ==
 
−
HVS32-VersandDatenAnfrage zum Prüfen der Versanddaten.<br><br>
 
−
'''Funktion (POST): /hvs32rest/versanddatenPruefAnfrage'''<br>
 
−
;VersanddatenPruefAnfrage. '''[[#Datentypen|Datentyp String]]'''<br>
 
−
:Anfrage vom Hostsystem zum Drucken eines Versandetiketts für ein Packstück.
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
Zeile 862: Zeile 1.933:
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 
|-
 
|-
−
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] [[#artikelDaten|<ArtikelDaten>]] || - || - || -
+
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
 +
|-
 +
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
 
|-
 
|-
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
Zeile 877: Zeile 1.950:
 
|-
 
|-
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 +
|-
 +
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 +
|-
 +
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
 
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
 
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
Zeile 883: Zeile 1.962:
 
|-
 
|-
 
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
 
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
 +
|-
 +
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
 
|-
 
|-
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
Zeile 894: Zeile 1.975:
 
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 
|-
 
|-
−
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || -
+
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 
|-
 
|-
 
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
 
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
 +
|-
 +
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
 
|-
 
|-
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
Zeile 924: Zeile 2.007:
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
+
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
 +
|-
 +
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
 +
|-
 +
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
 +
|-
 +
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
 
|-
 
|-
 
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
|-
 
|-
 
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 +
|-
 +
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
 +
|-
 +
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 +
|-
 +
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
 +
|-
 +
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
 
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
 
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
Zeile 960: Zeile 2.057:
 
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
 
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
 
|-
 
|-
−
| packstueckID || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
+
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
 
|-
 
|-
 
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
 
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
Zeile 985: Zeile 2.082:
 
|-
 
|-
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 +
|-
 +
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
 
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
 
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
 +
|-
 +
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
 
|-
 
|-
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
Zeile 1.003: Zeile 2.104:
 
|-
 
|-
 
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
 
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
 +
|-
 +
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
 
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 
|-
 
|-
 
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 +
|-
 +
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
 
|-
 
|-
 
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
Zeile 1.034: Zeile 2.139:
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|}
 
|}
 +
</div></div>
 
<br>
 
<br>
−
;VersanddatenPruefAntwort. '''[[#Datentypen|Datentyp String]]'''<br>
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
:Rückmeldung vom HVS32 nach einer sendungsdatenAnfrage.
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|-
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 +
|-
 +
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 
|-
 
|-
 
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
Zeile 1.045: Zeile 2.158:
 
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
 +
|-
 +
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
 +
|-
 +
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 +
|-
 +
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 +
|-
 +
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
 +
|-
 +
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 +
|-
 +
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
 +
|-
 +
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
 +
|-
 +
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
 +
|-
 +
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 +
|-
 +
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
 +
|-
 +
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
 +
|-
 +
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|-
 +
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"ansprechpartner": "",
 +
"anzahlArtikel": 0,
 +
"artikelDaten": [
 +
{
 +
"anzahlBuegel": 0,
 +
"anzahlPosEtiketten": 0,
 +
"artikelBTNNr": "",
 +
"artikelEAN": "",
 +
"artikelEinheit": "",
 +
"artikelGewicht": 0,
 +
"artikelGruppe": "",
 +
"artikelMenge": 0,
 +
"artikelServices": "",
 +
"artikelSollMenge": 0,
 +
"artikelText1": "",
 +
"artikelText2": "",
 +
"artikelText3": "",
 +
"artikelText4": "",
 +
"artikelVolumen": 0,
 +
"artikelWaehrung": "",
 +
"artikelWert": 0,
 +
"chargeFlag": "",
 +
"kundenArtikelNr": "",
 +
"kundenBestellNr": "",
 +
"posAuftragNr": "",
 +
"posLieferNr": "",
 +
"positionNr": "",
 +
"serienNr": "",
 +
"ursprungLand": ""
 +
}
 +
],
 +
"auftragNr": "",
 +
"auftraggeberID": "",
 +
"avisHinweis1": "",
 +
"avisHinweis2": "",
 +
"avisZusatz1": "",
 +
"avisZusatz2": "",
 +
"barcodeID": "",
 +
"barcodeText": "",
 +
"barcodeTyp": "",
 +
"bestellNr": "",
 +
"druckername": "",
 +
"email": "",
 +
"empfMobilfunkNr": "",
 +
"faxNr": "",
 +
"flexZustellungEmailadResponsese": "",
 +
"frachtBrief": "",
 +
"frachtfuehrerKdNr": "",
 +
"frankaturKennung": "",
 +
"gefahrgut": [
 +
{
 +
"gefahrgutBefoerdKat": 0,
 +
"gefahrgutBegrenzteMenge": "",
 +
"gefahrgutBezeichnung": "",
 +
"gefahrgutBuchst640": "",
 +
"gefahrgutFFCode": "",
 +
"gefahrgutFaktor": 0,
 +
"gefahrgutFreigestMenge": "",
 +
"gefahrgutKCode": "",
 +
"gefahrgutKlasse": "",
 +
"gefahrgutMenge": 0,
 +
"gefahrgutMengenEinheit": "",
 +
"gefahrgutNebenGefahr": "",
 +
"gefahrgutNettoExplMasse": 0,
 +
"gefahrgutTunnelBCode": "",
 +
"gefahrgutUNNR": "",
 +
"gefahrgutUmweltGef": "",
 +
"gefahrgutVPG": "",
 +
"gefahrgutVerpAnzahl": 0,
 +
"gefahrgutVerpackungsart": ""
 +
}
 +
],
 +
"gewicht": 0,
 +
"hostTrackingNr": "",
 +
"ilnNr": "",
 +
"infotext1": "",
 +
"infotext2": "",
 +
"infotext3": "",
 +
"infotext4": "",
 +
"infotext5": "",
 +
"infotext6": "",
 +
"infotext7": "",
 +
"infotext8": "",
 +
"infotext9": "",
 +
"infotext10": "",
 +
"kostenstelle": "",
 +
"kundenNr": "",
 +
"lagerkennzeichen": 0,
 +
"letztesPackstueck": "",
 +
"lieferantenID": 0,
 +
"lieferscheinNr": "",
 +
"nachnahme": 0,
 +
"nettoGewicht": 0,
 +
"neutBIC": "",
 +
"neutBankBezeichnung": "",
 +
"neutIBAN": "",
 +
"neutKontoInhaber": "",
 +
"neutabsenderLKZ": "",
 +
"neutabsenderName1": "",
 +
"neutabsenderName2": "",
 +
"neutabsenderName3": "",
 +
"neutabsenderOrt": "",
 +
"neutabsenderPLZ": "",
 +
"neutabsenderStrasse": "",
 +
"nnVermerk": "",
 +
"nnVerwendung": "",
 +
"nnWaehrung": "",
 +
"packStkGes": 0,
 +
"packStkNr": 0,
 +
"packplatz": "",
 +
"packstueckBreite": 0,
 +
"packstueckHoehe": 0,
 +
"packstueckID": "",
 +
"packstueckLaenge": 0,
 +
"paperlessInvoice": "",
 +
"postLeitcode": "",
 +
"postZielFrachtzent": "",
 +
"rechnungsEmpfLKZ": "",
 +
"rechnungsEmpfName1": "",
 +
"rechnungsEmpfName2": "",
 +
"rechnungsEmpfName3": "",
 +
"rechnungsEmpfOrt": "",
 +
"rechnungsEmpfPLZ": "",
 +
"rechnungsEmpfStrasse": "",
 +
"rechnungsNr": "",
 +
"sendungsinhalt": "",
 +
"sonderdienste": "",
 +
"sperrFlag": "",
 +
"telefonNr": "",
 +
"terminArt": "",
 +
"terminDatum": "",
 +
"terminZeit": "",
 +
"ustIDNr": "",
 +
"verpackungsart": "",
 +
"versandartID": "",
 +
"versicherungswert": 0,
 +
"vorpackdatum": "",
 +
"vwWaehrung": "",
 +
"warenwert": 0,
 +
"wechselbruecke": "",
 +
"wwWaehrung": "",
 +
"zahlungsbedingung": "",
 +
"zbZoll": "",
 +
"zielAdrBahnhof": "",
 +
"zielAdrLKZ": "",
 +
"zielAdrName1": "",
 +
"zielAdrName2": "",
 +
"zielAdrName3": "",
 +
"zielAdrName4": "",
 +
"zielAdrOrt": "",
 +
"zielAdrPLZ": "",
 +
"zielAdrRegion": "",
 +
"zielAdrStrasse": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"packstueckID": "",
 +
"trackingNr": "",
 +
"retourTrackingNr": "",
 +
"versandSendungsNr": "",
 +
"druckDateTime": "",
 +
"ausgangDateTime": "",
 +
"gebuehrWaehrung": "",
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": "",
 +
"etikettName": "",
 +
"etikettDaten": "",
 +
"trackingURL": "",
 +
"zusatzfeld1": "",
 +
"zusatzfeld2": "",
 +
"zusatzfeld3": "",
 +
"zusatzfeld4": "",
 +
"zusatzfeld5": "",
 +
"zusatzfeld6": "",
 +
"zusatzfeld7": "",
 +
"zusatzfeld8": "",
 +
"zusatzfeld9": "",
 +
"zusatzfeld10": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
 +
== Packstückdaten anonymisieren (anonymisiereVersandDaten) ==
 +
Das Gateway sendet die anonymisiereVersandDaten an das Automatik-Polling des HVS32. Im HVS32 werden somit Kunden bezogene Daten für den entsprechenden Datensatz gemäß DSGVO anonymisiert. Diese Anonymisierung wird unwiderruflich und endgültig auf der Datenbankebene des Versandsystems durchgeführt. Eine Wiederherstellung der ursprünglichen Daten ist somit nicht mehr möglich. Log-Dateien, Rückmelde-Dateien, bereits übertragene Frachtführer DFÜs etc. sind hiervon nicht betroffen. Es können ausschließlich Packstücke und Sendungen anonymisiert werden, welche bereits Tages abgeschlossen sind.
 +
<br>
 +
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/anonymisiereVersandDaten'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 +
|}
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
 +
|-
 +
| auftragsNr || [[#Datentypen|String]] || 20 || - || -
 +
|-
 +
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
 +
|-
 +
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 +
|-
 +
| packstueckID || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
 +
|-
 +
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
 +
|-
 +
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 +
|}
 +
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"auftragNr": "",
 +
"lieferscheinNr": "",
 +
"packplatz": "",
 +
"packstueckID": "",
 +
"trackingNr": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
  
 +
== Sendungs-Verarbeitung (sendungsdatenAnfrage) ==
 +
sendungsdatenAnfrage – wird zur Laufzeit in einzelne [[#versandDatenAnfragen|versandDatenAnfragen]] unterteilt. Muss bei einer Anfrage für das [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] genutzt werden (requestSPM=TRUE)
 +
<br>
 +
{| class="wikitable"
 +
|-
 +
|'''Funktion (POST) || /hvs32rest/sendungsdatenAnfrage'''
 +
|-
 +
| '''MediaType || text/plain'''<br>
 +
|-
 +
| '''Charset || UTF-8'''<br>
 
|}
 
|}
−
;<big><big>'''[[REST_Beispiel|JSON Beispiele]]'''</big></big>
+
<br>
−
<!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<!-- ------------------------------------------------------------------------------- ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- -->
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
−
 
+
<div class="mw-collapsible-content">
−
= Übersicht der spezial Datentypen =
+
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
−
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer [[#Übersicht der Funktionen|Funktion]] genutzt werden.
 
−
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT UNTERFUNKTIONEN ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- -->
 
−
== packstueckDaten ==
 
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
+
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 +
|-
 +
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 +
|-
 +
| auftragNr || [[#Datentypen|String]] || 20 || - || -
 +
|-
 +
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 +
|-
 +
| ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Ausschluss-Frachtführer für SPM Anfrage
 +
|-
 +
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
 +
|-
 +
| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
 +
|-
 +
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
 +
|-
 +
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
 +
|-
 +
| bestellNr || [[#Datentypen|String]] || 20 || - || -
 +
|-
 +
| email || [[#Datentypen|String]] || 100 || - || Für automatische Mailavisierung
 +
|-
 +
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
 
|-
 
|-
−
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] [[#artikelDaten|<ArtikelDaten>]] || - || - || -
+
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
|-
 
|-
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
| flexZustellungEmailadResponsese || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Email-Adresse
 
|-
 
|-
−
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
 
|-
 
|-
−
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer.
 
|-
 
|-
−
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
+
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
|-
 
|-
−
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] [[#gefahrgut|<Gefahrgut>]] || - || - || -
+
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| '''gewicht''' || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
+
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Falls die Paketnummer aus dem Vorsystem verwendet werden soll.
+
| Lagerkennzeichen || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
 
|-
 
|-
−
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| LieferantenID || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
 
|-
 
|-
−
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
 
|-
 
|-
−
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
+
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| nachnahme || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
+
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
+
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| nnVermerk || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
+
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
|-
 
|-
−
| nnVerwendung || [[#Datentypen|String]] || 1 || - || 'B' = Bar, 'V' = Verrechnungsscheck
+
| [[#packstueckDaten|packstueckDaten]] || [[#Datentypen|Sequence]] [[#packstueckDaten|<PackStueckDaten>]] || - || - || -
 
|-
 
|-
−
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 
|-
 
|-
−
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nummer pro Sendung
+
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
 
|-
 
|-
−
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
+
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
 
|-
 
|-
−
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
+
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
 
|-
 
|-
−
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
+
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
 
|-
 
|-
−
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
+
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
+
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe-Versicherungswert
+
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
+
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
|-
 
|-
−
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
+
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
 
|-
 
|-
−
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
+
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
−
|}
 
−
<!-- ------------------------------------------------------------------------------- ENDE packstueckDaten ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
 
−
== artikelDaten ==
 
−
{| class="wikitable sortable"
 
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
|-
 
|-
−
| anzahlBuegel || [[#Datentypen|Integer]] || - || - || Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist
+
| requestSPM || [[#Datentypen|String]] || 5 || - || T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
 
|-
 
|-
−
| anzahlPosEtiketten || [[#Datentypen|Integer]] || - || - || Anzahl Artikeletiketten, welche gedruckt werden sollen
+
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| artikelBTNNr || [[#Datentypen|String]] || 25 || - || BTN Nummer / Zolltarifnummer
+
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
 
|-
 
|-
−
| artikelEAN || [[#Datentypen|String]] || 20 || - || EAN Nummer
+
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
 
|-
 
|-
−
| artikelEinheit || [[#Datentypen|String]] || 10 || - || Einheit der Artikelmenge
+
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
|-
 
|-
−
| artikelGewicht || [[#Datentypen|Decimal]] || 9 || 3 || Gewicht des Arikels
+
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
 
|-
 
|-
−
| artikelGruppe || [[#Datentypen|String]] || 50 || - || Artikelgruppe
+
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| artikelMenge || [[#Datentypen|Decimal]] || 9 || 3 || Menge des Artikels
+
| terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM
 
|-
 
|-
−
| artikelServices || [[#Datentypen|String]] || 100 || - || Pipe getrennte Services für diesen Artikel
+
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
|-
 
|-
−
| artikelSollMenge || [[#Datentypen|Decimal]] || 9 || 3 || -
+
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
|-
 
|-
−
| artikelText1 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
+
| vorgabeFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Vorgabe-Frachtführer für [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] Anfrage
 
|-
 
|-
−
| artikelText2 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
+
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| artikelText3 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
+
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen werden soll
 
|-
 
|-
−
| artikelText4 || [[#Datentypen|String]] || 100 || - || Artikelbezeichnung
+
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
 
|-
 
|-
−
| artikelVolumen || [[#Datentypen|Decimal]] || 9 || 3 || Volumen des Artikels
+
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
 
|-
 
|-
−
| artikelWaehrung || [[#Datentypen|String]] || 3 || - || Währung in welcher der Wert des Artikels angegeben wird
+
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort des Bahnhofs
 
|-
 
|-
−
| artikelWert || [[#Datentypen|Decimal]] || 18 || 2 || Wert des Artikels
+
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ)
 
|-
 
|-
−
| chargeFlag || [[#Datentypen|String]] || 1 || - ||  
+
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| kundenArtikelNr || [[#Datentypen|String]] || 50 || - || Artikelnummer
+
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| kundenBestellNr || [[#Datentypen|String]] || 50 || - || Bestellnummer
+
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| posAuftragNr || [[#Datentypen|String]] || 50 || - || Auftragsnummer
+
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| posLieferNr || [[#Datentypen|String]] || 40 || - || Lieferscheinnummer
+
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| positionNr || [[#Datentypen|String]] || 50 || - || Laufende Nummer innerhalb des Packstücks
+
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
 
|-
 
|-
−
| serienNr || [[#Datentypen|String]] || 30 || - || Seriennummer
+
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
 
|-
 
|-
−
| ursprungLand || [[#Datentypen|String]] || 2 || - || Ursprungsland des Artikels
+
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|}
 
|}
−
<!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- -->
+
</div></div>
−
<!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- -->
+
<br>
−
== gefahrgut ==
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 +
<div class="mw-collapsible-content">
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| gefahrgutBefoerdKat || [[#Datentypen|Integer]] || 1 || - || Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein.
+
| fehler || [[#Datentypen|String]] || - || - || Wird im Fehlerfall befüllt
 +
|-
 +
| sendungsGebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachkosten
 +
|-
 +
| sendungsGebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 +
|-
 +
| versandSendungsNr || [[#Datentypen|String]] || 20 || - || Sendungsnummer
 +
|}
 +
 
 +
;Packstückdaten
 +
{| class="wikitable sortable"
 +
|-
 +
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
 
|-
 
|-
−
| gefahrgutBegrenzteMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht
+
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
|-
 
|-
−
| gefahrgutBezeichnung || [[#Datentypen|String]] || 100 || - || Pflicht (siehe ADR-Tabelle Spalte (2))
+
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 
|-
 
|-
−
| gefahrgutBuchst640 || [[#Datentypen|String]] || 1 || - || Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6))
+
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 +
|-
 +
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
|-
 
|-
−
| gefahrgutFFCode || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
+
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
 
|-
 
|-
−
| gefahrgutFaktor || [[#Datentypen|Integer]] || 3 || - || Bewertungsfaktor für Punktesummation auf dem Beförderungspapier,  (kann 0, 1, 3, 50 oder 999 sein), eigentlich Pflicht, kann aber eindeutig aus der Beförderungskategorie geschlossen werden, daher muss es nicht unbedingt belegt sein
+
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
 
|-
 
|-
−
| gefahrgutFreigestMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht
+
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
 
|-
 
|-
−
| gefahrgutKCode || [[#Datentypen|String]] || 10 || - || Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b))
+
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
 
|-
 
|-
−
| gefahrgutKlasse || [[#Datentypen|String]] || 100 || - || Pflicht (siehe ADR-Tabelle Spalte (3a))
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 
|-
 
|-
−
| gefahrgutMenge || [[#Datentypen|Decimal]] || 8 || 3 || Stoff-Menge an Gefahrgut, die ADR-technisch zu deklarieren ist ( in Litern bei Flüssigkeiten und verdichteten Gasen, sonst in kg, bei LQ-Gefahrgut immer kg )
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
 
|-
 
|-
−
| gefahrgutMengenEinheit || [[#Datentypen|String]] || 2 || - || Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg
+
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
 
|-
 
|-
−
| gefahrgutNebenGefahr || [[#Datentypen|String]] || 10 || - || bedingte Pflicht bei Stoffen, bei denen neben der Hauptgefahr-Klasse/Zettelnummer noch Nebengefahr-Zettelnummern vorhanden sind (siehe ADR-Tabelle Spalte (5), wenn dort z.B. 3+6.1+8 eingetragen ist, sind 6.1 und 8 die Nebengefahr-Zettelnummern und als (6.1)(8) im Feld Nebengefahr zu übermitteln )
+
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 
|-
 
|-
−
| gefahrgutNettoExplMasse || [[#Datentypen|Decimal]] || 8 || 3 || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
+
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
 
|-
 
|-
−
| gefahrgutTunnelBCode || [[#Datentypen|String]] || 10 || - || Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15))
+
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
 
|-
 
|-
−
| gefahrgutUNNR || [[#Datentypen|String]] || 10 || - || Pflicht (siehe ADR-Tabelle Spalte (1))
+
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
 
|-
 
|-
−
| gefahrgutUmweltGef || [[#Datentypen|String]] || 1 || - || T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen
+
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
 
|-
 
|-
−
| gefahrgutVPG || [[#Datentypen|String]] || 3 || - || Verpackungsgruppe, bedingt Pflicht bei den Stoffen, bei denen diese in der ADR-Tabelle belegt ist, kann I,II oder III sein oder gar nicht belegt (letzteres z.B. bei Klasse 2)) (siehe ADR-Tabelle Spalte (4))
+
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
 
|-
 
|-
−
| gefahrgutVerpAnzahl || [[#Datentypen|Integer]] || 4 || - || Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart)
+
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| gefahrgutVerpackungsart || [[#Datentypen|String]] || 5 || - || ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes
+
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
|}
 
−
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- -->
 
−
== edistatus ==
 
−
{| class="wikitable sortable"
 
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| statuscode || [[#Datentypen|String]] || 2 || - ||
+
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
01 = FFDatei wurde erzeugt.<br>
 
−
02 = FFDatei wurde geschrieben.<br>
 
−
03 = FFDatei wurde verschickt.<br>
 
−
11 = FFDatei konnte nicht erzeugt werden!<br>
 
−
12 = FFDatei konnte nicht geschrieben werden!<br>
 
−
13 = FFDatei konnte nicht verschickt werden!<br>
 
−
 
 
−
Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration.<br>
 
−
D.h. solange kein Status „1x“ enthalten ist, wurde mit der FFDatei gemäß der HVS32 Konfiguration verfahren.
 
 
|-
 
|-
−
| statustext || [[#Datentypen|String]] || 200 || - || Klartext des Statuscodes
+
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| fftyp || [[#Datentypen|String]] || 50 || - || Frachtführertyp (z.B. UPS, GLS, DPD)
+
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| dateityp || [[#Datentypen|String]] || 50 || - || FFDateityp (z.B.: Standard, Express, etc.)
+
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| auftraggeber || [[#Datentypen|String]] || 10 || - || Auftraggebernummer ('''ACHTUNG!''' Nicht die AuftraggeberID)
+
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| ffdateinr || [[#Datentypen|String]] || 10 || - || Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)
+
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|}
 
|}
−
<!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- -->
+
</div></div>
 +
<br>
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 +
<div class="mw-collapsible-content">
 +
;Request
 +
<source lang="json">
 +
{
 +
"ansprechpartner": "",
 +
"assoc": {
 +
"":""
 +
},
 +
"auftragNr": "",
 +
"auftraggeberID": "",
 +
"ausschlussFrachtfuehrer": "",
 +
"avisHinweis1": "",
 +
"avisHinweis2": "",
 +
"avisZusatz1": "",
 +
"avisZusatz2": "",
 +
"bestellNr": "",
 +
"email": "",
 +
"empfMobilfunkNr": "",
 +
"faxNr": "",
 +
"flexZustellungEmailadResponsese": "",
 +
"frachtBrief": "",
 +
"frachtfuehrerKdNr": "",
 +
"frankaturKennung": "",
 +
"ilnNr": "",
 +
"kostenstelle": "",
 +
"kundenNr": "",
 +
"Lagerkennzeichen": 0,
 +
"LieferantenID": 0,
 +
"lieferscheinNr": "",
 +
"neutBIC": "",
 +
"neutBankBezeichnung": "",
 +
"neutIBAN": "",
 +
"neutKontoInhaber": "",
 +
"neutabsenderLKZ": "",
 +
"neutabsenderName1": "",
 +
"neutabsenderName2": "",
 +
"neutabsenderName3": "",
 +
"neutabsenderOrt": "",
 +
"neutabsenderPLZ": "",
 +
"neutabsenderStrasse": "",
 +
"packStkGes": 0,
 +
"packStueckDaten": [
 +
{
 +
"anzahlArtikel": 0,
 +
"assoc": {
 +
"":""
 +
},
 +
"artikelDaten": [
 +
{
 +
"anzahlBuegel": 0,
 +
"anzahlPosEtiketten": 0,
 +
"artikelBTNNr": "",
 +
"artikelEAN": "",
 +
"artikelEinheit": "",
 +
"artikelGewicht": 0,
 +
"artikelGruppe": "",
 +
"artikelMenge": 0,
 +
"artikelServices": "",
 +
"artikelSollMenge": 0,
 +
"artikelText1": "",
 +
"artikelText2": "",
 +
"artikelText3": "",
 +
"artikelText4": "",
 +
"artikelVolumen": 0,
 +
"artikelWaehrung": "",
 +
"artikelWert": 0,
 +
"chargeFlag": "",
 +
"kundenArtikelNr": "",
 +
"kundenBestellNr": "",
 +
"posAuftragNr": "",
 +
"posLieferNr": "",
 +
"positionNr": "",
 +
"serienNr": "",
 +
"ursprungLand": ""
 +
}
 +
],
 +
"barcodeID": "",
 +
"barcodeText": "",
 +
"barcodeTyp": "",
 +
"druckername": "",
 +
"gefahrgut": [
 +
{
 +
"gefahrgutBefoerdKat": 0,
 +
"gefahrgutBegrenzteMenge": "",
 +
"gefahrgutBezeichnung": "",
 +
"gefahrgutBuchst640": "",
 +
"gefahrgutFFCode": "",
 +
"gefahrgutFaktor": 0,
 +
"gefahrgutFreigestMenge": "",
 +
"gefahrgutKCode": "",
 +
"gefahrgutKlasse": "",
 +
"gefahrgutMenge": 0,
 +
"gefahrgutMengenEinheit": "",
 +
"gefahrgutNebenGefahr": "",
 +
"gefahrgutNettoExplMasse": 0,
 +
"gefahrgutTunnelBCode": "",
 +
"gefahrgutUNNR": "",
 +
"gefahrgutUmweltGef": "",
 +
"gefahrgutVPG": "",
 +
"gefahrgutVerpAnzahl": 0,
 +
"gefahrgutVerpackungsart": ""
 +
}
 +
],
 +
"gewicht": 0,
 +
"hostTrackingNr": "",
 +
"infotext1": "",
 +
"infotext10": "",
 +
"infotext2": "",
 +
"infotext3": "",
 +
"infotext4": "",
 +
"infotext5": "",
 +
"infotext6": "",
 +
"infotext7": "",
 +
"infotext8": "",
 +
"infotext9": "",
 +
"letztesPackstueck": "",
 +
"nachnahme": 0,
 +
"nettoGewicht": 0,
 +
"nnVermerk": "",
 +
"nnVerwendung": "",
 +
"nnWaehrung": "",
 +
"packStkNr": 0,
 +
"packstueckBreite": 0,
 +
"packstueckHoehe": 0,
 +
"packstueckID": "",
 +
"packstueckLaenge": 0,
 +
"verpackungsart": "",
 +
"versicherungswert": 0,
 +
"vwWaehrung": "",
 +
"warenwert": 0,
 +
"wwWaehrung": ""
 +
}
 +
],
 +
"packplatz": "",
 +
"paperlessInvoice": "",
 +
"postLeitcode": "",
 +
"postZielFrachtzent": "",
 +
"rechnungsEmpfLKZ": "",
 +
"rechnungsEmpfName1": "",
 +
"rechnungsEmpfName2": "",
 +
"rechnungsEmpfName3": "",
 +
"rechnungsEmpfOrt": "",
 +
"rechnungsEmpfPLZ": "",
 +
"rechnungsEmpfStrasse": "",
 +
"rechnungsNr": "",
 +
"RequestuestSPM": "",
 +
"sendungsinhalt": "",
 +
"sonderdienste": "",
 +
"sperrFlag": "",
 +
"telefonNr": "",
 +
"terminArt": "",
 +
"terminDatum": "",
 +
"terminZeit": "",
 +
"ustIDNr": "",
 +
"versandartID": "",
 +
"vorgabeFrachtfuehrer": "",
 +
"vorpackdatum": "",
 +
"wechselbruecke": "",
 +
"zahlungsbedingung": "",
 +
"zbZoll": "",
 +
"zielAdrBahnhof": "",
 +
"zielAdrLKZ": "",
 +
"zielAdrName1": "",
 +
"zielAdrName2": "",
 +
"zielAdrName3": "",
 +
"zielAdrName4": "",
 +
"zielAdrOrt": "",
 +
"zielAdrPLZ": "",
 +
"zielAdrRegion": "",
 +
"zielAdrStrasse": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"versandSendungsNr": "",
 +
"sendungsGebuehrWaehrung": "",
 +
"fehler": "",
 +
"packStueckDaten": [
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"packstueckID": "",
 +
"trackingNr": "",
 +
"retourTrackingNr": "",
 +
"druckDateTime": "",
 +
"gebuehrWaehrung": "",
 +
"fehlertext1": "",
 +
"fehlertext2": "",
 +
"etikettName": "",
 +
"etikettDaten": "",
 +
"zusatzEtikettenDaten": {
 +
"": ""
 +
},
 +
"trackingURL": "",
 +
"zusatzfeld1": "",
 +
"zusatzfeld2": "",
 +
"zusatzfeld3": "",
 +
"zusatzfeld4": "",
 +
"zusatzfeld5": "",
 +
"zusatzfeld6": "",
 +
"zusatzfeld7": "",
 +
"zusatzfeld8": "",
 +
"zusatzfeld9": "",
 +
"zusatzfeld10": "",
 +
"ausgangDateTime": ""
 +
}
 +
]
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
 +
 
 +
= Beispiele =
 +
Alle JSON Beispiele finden Sie auch hier: [[REST_Beispiel|REST SERVER JSON Beispiele]]

Version vom 25. November 2021, 16:22 Uhr


Voraussetzungen

DGS-Version 3.7.0.646 oder höher
DGS-Plugins HVS32Client, REST Server

Funktionsbeschreibung

Bei der REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST Server mit folgenden Funktionen zur Verfügung. Dieser ist in der Standardkonfiguration unter http://<Servername>:<Port>/hvs32rest erreichbar. Dabei wird der Port 8081 verwendet, welcher bei Bedarf geändert werden kann.

Datentypen

Integer - Zahl mit ausschließlich numerischen Zeichen (0-9).
Decimal - Zahl mit Nachkommastellen
Calendar - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)
String - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.
Binary - Base64 kodierte Binärdaten
Sequence - Eine Liste von Elementen
Map - Key/Value Map

Zusätzliche Datentypen

Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer Funktion genutzt werden.

artikelDaten

Artikel-Daten
Feldname Typ Max Länge Dezimalstellen Belegung
anzahlBuegel Integer - - Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist
anzahlPosEtiketten Integer - - Anzahl Artikeletiketten, welche gedruckt werden sollen
artikelBTNNr String 25 - BTN Nummer / Zolltarifnummer
artikelEAN String 20 - EAN Nummer
artikelEinheit String 10 - Einheit der Artikelmenge
artikelGewicht Decimal 9 3 Gewicht des Arikels
artikelGruppe String 50 - Artikelgruppe
artikelMenge Decimal 9 3 Menge des Artikels
artikelServices String 100 - Pipe getrennte Services für diesen Artikel
artikelSollMenge Decimal 9 3 -
artikelText1 String 100 - Artikelbezeichnung
artikelText2 String 100 - Artikelbezeichnung
artikelText3 String 100 - Artikelbezeichnung
artikelText4 String 100 - Artikelbezeichnung
artikelVolumen Decimal 9 3 Volumen des Artikels
artikelWaehrung String 3 - Währung in welcher der Wert des Artikels angegeben wird
artikelWert Decimal 18 2 Wert des Artikels
chargeFlag String 1 -
kundenArtikelNr String 50 - Artikelnummer
kundenBestellNr String 50 - Bestellnummer
posAuftragNr String 50 - Auftragsnummer
posLieferNr String 40 - Lieferscheinnummer
positionNr String 50 - Laufende Nummer innerhalb des Packstücks
serienNr String 30 - Seriennummer
ursprungLand String 2 - Ursprungsland des Artikels

gefahrgut

Gefahrgut-Daten
Feldname Typ Max Länge Dezimalstellen Belegung
gefahrgutBefoerdKat Integer 1 - Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein.
gefahrgutBegrenzteMenge String 1 - T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht
gefahrgutBezeichnung String 110 - Pflicht (siehe ADR-Tabelle Spalte (2))
gefahrgutBuchst640 String 1 - Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6))
gefahrgutFFCode String
gefahrgutFaktor Integer 3 - Bewertungsfaktor für Punktesummation auf dem Beförderungspapier, (kann 0, 1, 3, 50 oder 999 sein), eigentlich Pflicht, kann aber eindeutig aus der Beförderungskategorie geschlossen werden, daher muss es nicht unbedingt belegt sein
gefahrgutFreigestMenge String 1 - T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht
gefahrgutID String 8 - Eindeutige Suchnummer für Gefahrgut-Stammdaten
gefahrgutKCode String 10 - Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b))
gefahrgutKlasse String 100 - Pflicht (siehe ADR-Tabelle Spalte (3a))
gefahrgutMenge Decimal 8 3 Stoff-Menge an Gefahrgut, die ADR-technisch zu deklarieren ist ( in Litern bei Flüssigkeiten und verdichteten Gasen, sonst in kg, bei LQ-Gefahrgut immer kg )
gefahrgutMengenEinheit String 2 - Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg
gefahrgutNebenGefahr String 10 - bedingte Pflicht bei Stoffen, bei denen neben der Hauptgefahr-Klasse/Zettelnummer noch Nebengefahr-Zettelnummern vorhanden sind (siehe ADR-Tabelle Spalte (5), wenn dort z.B. 3+6.1+8 eingetragen ist, sind 6.1 und 8 die Nebengefahr-Zettelnummern und als (6.1)(8) im Feld Nebengefahr zu übermitteln )
gefahrgutNettoExplMasse Decimal 8 3 Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
gefahrgutPositionNr Integer - - Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
gefahrgutTechBenennung String 150 - bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet)
gefahrgutTunnelBCode String 10 - Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15))
gefahrgutUNNR String 10 - Pflicht (siehe ADR-Tabelle Spalte (1))
gefahrgutUmweltGef String 1 - T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen
gefahrgutVPG String 3 - Verpackungsgruppe, bedingt Pflicht bei den Stoffen, bei denen diese in der ADR-Tabelle belegt ist, kann I,II oder III sein oder gar nicht belegt (letzteres z.B. bei Klasse 2)) (siehe ADR-Tabelle Spalte (4))
gefahrgutVerpAnzahl Integer 4 - Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart)
gefahrgutVerpackungsart String 5 - ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes

edistatus

EDIStatus
Feldname Typ Max Länge Dezimalstellen Belegung
fehlercode Integer - - 0 = Erfolgreich
statuscode String 2 -

01 = FFDatei wurde erzeugt.
02 = FFDatei wurde geschrieben.
03 = FFDatei wurde verschickt.
11 = FFDatei konnte nicht erzeugt werden!
12 = FFDatei konnte nicht geschrieben werden!
13 = FFDatei konnte nicht verschickt werden!

Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration.
D.h. solange kein Status „1x“ enthalten ist, wurde mit der FFDatei gemäß der HVS32 Konfiguration verfahren.

statustext String 200 - Klartext des Statuscodes
fftyp String 50 - Frachtführertyp (z.B. UPS, GLS, DPD)
dateityp String 50 - FFDateityp (z.B.: Standard, Express, etc.)
auftraggeber String 10 - Auftraggebernummer (ACHTUNG! Nicht die AuftraggeberID)
ffdateinr String 10 - Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)

packstueckDaten

Packstückdaten
Feldname Typ Max Länge Dezimalstellen Belegung
anzahlArtikel Integer 6 - Anzahl Artikel (Druck auf Etikett)
artikelDaten Sequence <ArtikelDaten> - - Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n)
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
barcodeID String - - Zusatzfeld für evtl. Erweiterungen
barcodeText String - - Zusatzfeld für evtl. Erweiterungen
barcodeTyp String - - Zusatzfeld für evtl. Erweiterungen
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
gefahrgut Sequence <Gefahrgut> - - Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n)
gewicht Decimal 8 3 Bruttogewicht in KG
hostTrackingNr String 35 - Falls die Paketnummer aus dem Vorsystem verwendet werden soll.
infotext1 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext2 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext3 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext4 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext5 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext6 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext7 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext8 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext9 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext10 String 150 - Zusatzfeld für evtl. Erweiterungen
letztesPackstueck String 1 - T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
nachnahme String 3 - Warenwert - ISO-Währungscode
nettoGewicht Decimal 8 3 Nettogewicht in KG
nnVermerk String 3 - Nachnahme - ISO-Währungscode
nnVerwendung String 1 - 'B' = Bar, 'V' = Verrechnungsscheck
nnWaehrung String 3 - Nachnahme - ISO-Währungscode
packStkNr Integer - - Laufende Nummer pro Sendung
packstueckBreite Integer - - Breite in cm
packstueckHoehe Integer - - Höhe in cm
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
packstueckLaenge Integer - - Länge in cm
verpackungsart String 6 - -
versicherungswert Decimal 18 2 Höhe-Versicherungswert
vwWaehrung String 3 - Versicherungswert - ISO-Währungscode
warenwert Decimal 18 2 -
wwWaehrung String 3 - Warenwert - ISO-Währungscode

Übersicht der Funktionen

Schnittstelle testen (echo)

Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.

Funktion (GET): /hvs32rest/echo/<Nachricht>

<Nachricht> wird zurück gegeben.

Packstück-Verarbeitung (versanddatenAnfrage)

Die Gatewayfunktion versanddatenAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück zu erzeugen und verbuchen. Ein Etikett wird für alle weiteren Funktionen wir Storno, Verladefreigabe, etc. anhand der hostseitigen Packstück-ID identifiziert. Diese wird im Feld PackstueckID übergeben und muss dementsprechend innerhalb des Versandsystems eindeutig sein.

Funktion (POST) /hvs32rest/versanddatenAnfrage
MediaType text/plain
Charset UTF-8



Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
absenderAdresseID String 10 - Eindeutige ID um eine Neutrale-Absenderadresse aus dem HVS32 zu verwenden
ansprechpartner String 20 - Empfänger Ansprechpartner
anzahlArtikel Integer 6 - Anzahl Artikel (Druck auf Etikett)
artikelDaten Sequence <ArtikelDaten> - - Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n)
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
auftragNr String 20 - -
auftraggeberID String 10 - Mandantenkennung aus dem HVS32
avisHinweis1 String 30 - -
avisHinweis2 String 30 - -
avisZusatz1 String 20 - Zusatz zu Fest-AVIS-Schlüssel 1
avisZusatz2 String 20 - Zusatz zu Fest-AVIS-Schlüssel 2
barcodeID String - - Zusatzfeld für evtl. Erweiterungen
barcodeText String - - Zusatzfeld für evtl. Erweiterungen
barcodeTyp String - - Zusatzfeld für evtl. Erweiterungen
bestellNr String 20 - Metro-Bestellnr (Metro-Versand)
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
email String 100 - E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
empfMobilfunkNr String 20 - Mobilfunknummer des Empfängers
faxNr String 20 - Faxnummer des Empfängers
flexZustellungEmailadresse String 80 - Flex-Zustellung Emailadresse
frachtBrief String 20 - Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
frachtfuehrerKdNr String 10 - Kundennummer des Frachtzahlers beim Frachtführer
freiAvis1 String - - -
freiAvis2 String - - -
frankaturKennung String 10 - -
gefahrgut Sequence <Gefahrgut> - - Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n)
gewicht Decimal 8 3 Bruttogewicht in KG
hostTrackingNr String 35 - Paketnummer aus dem Hostsystem
ilnNr String 20 - ILN des Empfängers (Pflicht bei Metro-Versand)
infotext1 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext2 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext3 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext4 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext5 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext6 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext7 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext8 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext9 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext10 String 150 - Zusatzfeld für evtl. Erweiterungen
kostenstelle String 30 - -
kundenNr String 20 - Kundennummer des Empfängers beim Versender
lagerkennzeichen Integer - - -
letztesPackstueck String 1 - T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
lieferantenID Integer - - -
lieferscheinNr String 40 - Wird im HVS32 als Such-Nummer verwendet
nachnahme Decimal 18 2 -
nettoGewicht Decimal 8 3 Nettogewicht in KG
neutBIC String 11 - Nur bei Neutral-Absendern belegt
neutBankBezeichnung String 40 - Nur bei Neutral-Absendern belegt
neutIBAN String 31 - Nur bei Neutral-Absendern belegt
neutKontoInhaber String 40 - Nur bei Neutral-Absendern belegt
neutabsenderLKZ String 3 - Nur bei Neutral-Absendern belegt
neutabsenderName1 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName2 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName3 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderOrt String 50 - Nur bei Neutral-Absendern belegt
neutabsenderPLZ String 10 - Nur bei Neutral-Absendern belegt
neutabsenderStrasse String 50 - Nur bei Neutral-Absendern belegt
nnVermerk String 1 - B': Bar / 'V': Verrechnungsscheck
nnVerwendung String 30 - Nachnahme Verwendungszweck
nnWaehrung String 3 - Nachnahme - ISO-Währungscode
packStkGes Integer - - Gesamt-Anzahl Colli der Sendung
packStkNr Integer - - Laufende Nr pro Sendung
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
packstueckBreite Integer - - Breite in cm
packstueckHoehe Integer - - Höhe in cm
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
packstueckLaenge Integer - - Länge in cm
paperlessInvoice String 1 - Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
postLeitcode String 15 - -
postZielFrachtzent String 5 - -
rechnungsEmpfLKZ String 5 - Rechnungsadresse
rechnungsEmpfName1 String 50 - Rechnungsempfänger
rechnungsEmpfName2 String 50 - Rechnungsempfänger
rechnungsEmpfName3 String 50 - Rechnungsempfänger
rechnungsEmpfOrt String 50 - Rechnungsadresse
rechnungsEmpfPLZ String 10 - Rechnungsadresse
rechnungsEmpfStrasse String 50 - Rechnungsadresse
rechnungsNr String 20 - Rechnungsnummer
sendungsinhalt String 30 - -
sonderdienste String 30 - Versandart-spezifisch belegt
sperrFlag String 1 - T/F: T=Sperren, sonst nicht sperren
telefonNr String 20 - Telefonnummer des Empfängers
terminArt String 1 - 'A' = ab diesem Tag liefern

'B' = bis zu diesem Tag liefern

'F' = an diesem Tag liefern

terminDatum String 10 - TT.MM.JJJJ
terminZeit Calendar 5 - HH:MM
ustIDNr String 20 - UmsatzsteuerNr des Empfängers
verpackungsart String 6 - -
versandartID String 10 - Versandartkennung aus dem HVS32
versicherungswert Decimal 18 2 Höhe Versicherungswert
vorpackdatum String 10 - TT.MM.JJJJ
vwWaehrung String 3 - Versicherungswert - ISO-Währungscode
warenwert Decimal 18 2 -
wechselbruecke String 20 - Wechselbrücke, die diesem Packstück zugewiesen wird
wwWaehrung String 3 - Warenwert - ISO-Währungscode
zahlungsbedingung String 10 - 'S' = Sender, 'R' = Empfänger
zbZoll String 1 - Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
zielAdrBahnhof String 30 - PLZ und Ort
zielAdrLKZ String 5 - Lieferadresse
zielAdrName1 String 50 - Lieferadresse
zielAdrName2 String 50 - Lieferadresse
zielAdrName3 String 50 - Lieferadresse
zielAdrName4 String 50 - Lieferadresse
zielAdrOrt String 50 - Lieferadresse
zielAdrPLZ String 10 - Lieferadresse
zielAdrRegion String 20 - Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
zielAdrStrasse String 50 - Lieferadresse


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
ausgangDateTime Calendar 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
ausgangDateTimeString String 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
druckDateTime Calendar 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
druckDateTimeString String 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
etikettDaten String - - Binärdaten des Etiketts
etikettName String - - Vorlagenname des Etiketts
fehlercode Integer - - 0 wenn Erfolgreich
fehlertext1 String 200 - Wird im Fehlerfall befüllt
fehlertext2 String 200 - Wird im Fehlerfall befüllt
gebuehr Decimal 18 2 Frachtkosten
gebuehrWaehrung String 3 - Frachkosten ISO-Währungscode
packstueckID String 20 - PackstueckID aus der Anfrage
retourTrackingNr String 50 - Paketnummer für die Retoure
trackingNr String 35 - Paketnummer
trackingURL String 255 - URL des Trackinglinks zur Sendungsverfolgung
versandSendungsNr String - - -
zusatzEtikettenDaten Map (String, String) - - Name und Binärdaten der Zusatzetiketten als Key/Value Map
zusatzfeld1 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld2 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld3 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld4 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld5 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld6 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld7 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld8 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld9 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld10 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden


Beispiele
Request
{
	"absenderAdresseID": "",
	"ansprechpartner": "",
	"assoc": {
		"":""
	},
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"freiAvis1": "",
	"freiAvis2": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vwWaehrung": "",
	"warenwert": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
Response
{
	"assoc": {
		"":""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

Etikett nachdrucken (versanddatenNachdruckAnfrage)

Die Gatewayfunktion versanddatenNachdruckAnfrage wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort ein Etikett für ein Packstück nachzudrucken. Ein Etikett wird anhand der hostseitigen Packstück-ID nachgedruckt. Diese wird im Feld PackstueckID übergeben. Bei manchen Frachtführern (z.B. DPD) werden beim Nachdruck neue Trackingnummern vergeben. Somit ist die alte Trackingnummer nicht mehr gültig und das alte Versandetikett muss vernichtet werden. Die neue Trackingnummer kann in der Rückmeldung zurückgemeldet werden.

Funktion (POST) /hvs32rest/versanddatenNachdruckAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird.
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
packstueckID String 30 - Eindeutige Nummer für das Paket im Vorsystem.
trackingNr String 35 - Paketnummer


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
ausgangDateTime Calendar 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
ausgangDateTimeString String 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
druckDateTime Calendar 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
druckDateTimeString String 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
etikettDaten String - - Binärdaten des Etiketts
etikettName String - - Vorlagenname des Etiketts
fehlercode Integer - - 0 wenn Erfolgreich
fehlertext1 String 200 - Wird im Fehlerfall befüllt
fehlertext2 String 200 - Wird im Fehlerfall befüllt
gebuehr Decimal 18 2 Frachtkosten
gebuehrWaehrung String 3 - Frachkosten ISO-Währungscode
packstueckID String 20 - PackstueckID aus der Anfrage
retourTrackingNr String 50 - Paketnummer für die Retoure
trackingNr String 35 - Paketnummer
trackingURL String 255 - URL des Trackinglinks zur Sendungsverfolgung
versandSendungsNr String - - -
zusatzEtikettenDaten Map (String, String) - - Name und Binärdaten der Zusatzetiketten als Key/Value Map
zusatzfeld1 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld2 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld3 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld4 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld5 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld6 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld7 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld8 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld9 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld10 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden


Beispiele
Request
{
	"druckername": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
Response
{
	"assoc": {
		"":""
	},
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehr": 0,
	"gebuehrWaehrung": "",
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"zusatzEtikettenDaten": {
		"": ""
	},
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

Packstück stornieren (stornoVersanddaten)

Die Gatewayfunktion stornoVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort bestehende Packstücke zu stornieren, die noch nicht auf einer Ausgangsliste sind. In der Regel wird ein Packstück anhand der hostseitigen Packstück-ID storniert. Diese wird im Feld PackstueckID übergeben. Zusätzlich zur hostseitigen Packstück-ID kann auch die TrackingNr zur Identifikation des Packstücks beitragen, für den Fall, dass die hostseitige Packstück-ID keine Eindeutigkeit garantieren kann. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Storno wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/stornoVersanddaten
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
packstueckID String 30 - Eindeutige Nummer für das Paket im Vorsystem.
trackingNr String 35 - Paketnummer


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext2 String 200 - -


Beispiele
Request
{
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
Response
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

Packstück verladen / freigeben (verladeVersanddaten)

Die Gatewayfunktion verladeVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang frei zu geben. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Freigabe wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/verladeVersanddaten
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
hostFreigabeNr String 20 - Hostseitige Freigabenummer die für dieses Packstück gesetzt wird.
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem.

Beim Etikettendruck zuvor muss die gleiche ID übergeben worden sein, damit das HVS32 das zu verladene Packstück eindeutig identifizieren kann.

wechselbruecke String 20 - Wechselbrücke, die diesem Packstück zugewiesen wird.


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext1 String 200 - -


Beispiele
Request
{
	"hostFreigabeNr": "",
	"packplatz": "",
	"packstueckID": "",
	"wechselbruecke": ""
}
Response
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

Packstück sperren (sperreVersanddaten)

Die Gatewayfunktion sperreVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort Packstücke für den Ausgang zu sperren. Gesperrte Packstücke, werden für den Tagesabschluss nicht berücksichtigt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreicher Sperrung wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/sperreVersanddaten
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem.


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext2 String 200 - -


Beispiele
Request
{
	"packplatz": "",
	"packstueckID": ""
}
Response
{
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": ""
}

Tagesabschluss (tagesabschluss)

Das Gateway sendet die tagesabschluss-Anfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit ein Tagesabschluss anhand der zusätzlich übergebenen Parameter ausgelöst. Der Tagesabschluss setzt sich aus den Punkten Ausgangsliste erzeugen und Frachtführer DFÜ erzeugen zusammen. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Tagesabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Ausführen des Tagesabschluss statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Tagesabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/tagesabschluss
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
auftraggeberID Sequence<String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.

(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)

druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.

(Benötigt Druckerspooler Erweiterungsmodul)

frachtfuehrerTyp Sequence<String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.

(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)

packplatz String 10 - HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
versandartID Sequence<String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.

(Option MultiVATagesabschluss muss im HVS32 aktiv sein)

wechselbruecke String 10 - Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
edistatus Sequence <EDIStatus> - - -
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext2 String 200 - -
listenDaten Map (String, String) - - Name und Binärdaten der Listen als Key/Value Map.
etikettenDaten Map (String, String) - - Name und Binärdaten der Etiketten als Key/Value Map.
ausgangsListeNr Sequence<String> - - Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).


Beispiele
Request
{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
Response
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {},
	"ausgangsListeNr": [
		"75"
	]
}

Ausgangsliste erzeugen (listenabschlussAnfrage)

Das Gateway sendet die listenabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Ausgangsliste anhand der zusätzlich übergebenen Parameter erzeugt. Nur Packstücke, welche für den Ausgang freigegeben wurden, werden für den Listenabschluss berücksichtigt. Standardmäßig sind alle Packstücke freigegeben, außer sie wurden durch das Erweiterungsmodul Ausgangsscannung gesperrt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Ausgangsliste statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/listenabschlussAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
auftraggeberID String 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.

(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)

druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.

(Benötigt Druckerspooler Erweiterungsmodul)

frachtfuehrerTyp String 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.

(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)

packplatz String 10 - HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
versandartID String 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.

(Option MultiVATagesabschluss muss im HVS32 aktiv sein)

wechselbruecke String 10 - Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext2 String 200 - -
listenDaten Map (String, String) - - Name und Binärdaten der Listen als Key/Value Map.
etikettenDaten Map (String, String) - - Name und Binärdaten der Etiketten als Key/Value Map.
ausgangsListeNr Sequence<String> - - Ausgangslisten-Nummer(n) der erzeugten Ausgangsliste(n).


Beispiele
Request
{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
Response
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	},
	"ausgangsListeNr": [
		"75"
	]
}

Ausgangsliste nachdrucken (listenNachdruckAnfrage)

Das Gateway sendet die listenNachdruckAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine bereits erstellte Ausgangsliste anhand der übergebenen ausgangsListeNr anchgedruckt. Eine Liste kann nur nachgedruckt werden, wenn diese bereits über die Funktionen tagesabschluss, listenabschlussAnfrage oder manuell über die HVS32 Maske erzeugt wurde. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Listenabschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/listenNachdruckAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
ausgangsListeNr Sequence<String> - - Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt werden sollen.
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.

(Benötigt Druckerspooler Erweiterungsmodul)

auftraggeberID Sequence<String> - - Liste der Auftraggerber-ID's, für welche die Listen nachgedruckt werden sollen.
frachtFuehrerTyp Sequence<String> - - Liste der Frachtführertypen, für welche die Listen nachgedruckt werden sollen.
erstellDatum String 10 - Erstelldatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001
druckDatum String 10 - Druckdatum der Ausgangslisten, die nachgedruckt werden sollen. Im Format "dd.mm.yyyy", z.B. 01.01.2001 oder null wenn nur Listen nachgedruckt werden sollen, die noch nicht gedruckt wurden


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
ausgangsListeNr Sequence<String> - - Liste der Ausgangslisten-Nr. der Listen, die nachgedruckt wurden.
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
fehlertext2 String 200 - -
listenDaten Map (String, String) - - Name und Binärdaten der Listen als Key/Value Map.
etikettenDaten Map (String, String) - - Name und Binärdaten der Etiketten als Key/Value Map.


Beispiele
Request
{
	"ausgangsListeNr": [
		"77"
	],
	"druckername": "",
	"auftraggeberID": [], 
	"frachtFuehrerTyp": [], 
	"erstellDatum": "", 
	"druckDatum": ""
}
Response
{
	"ausgangsListeNr": [
		"77"
	]
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"listenDaten": {
		"": ""
	}
}

Frachtführer DFÜ erzeugen (ediabschlussAnfrage)

Das Gateway sendet die ediabschlussAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine Frachtführer DFÜ anhand der zusätzlich übergebenen Parameter erzeugt und (falls konfiguriert) an den Frachtführer übertragen. Nur Packstücke, für welche zuvor eine Ausgangsliste erzeugt wurde, werden für eine Frachtführer DFÜ berücksichtigt. Die Rückmeldung im HVS32 findet nach dem Erzeugen der Frachtführer DFÜ statt. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem EDIAbschluss wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/ediabschlussAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
auftraggeberID Sequence <String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Auftraggebern mitgegeben werden. Es können n-Auftraggeber abgeschlossen werden.

(Option MultiAGTagesabschluss muss im HVS32 aktiv sein)

druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird.

(Benötigt Druckerspooler Erweiterungsmodul)

frachtfuehrerTyp Sequence <String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Frachführern mitgegeben werden. Es können n-Frachtführer abgeschlossen werden.

(Option MultiFFTagesabschluss muss im HVS32 aktiv sein)

packplatz String 10 - HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll.
versandartID Sequence <String> 255 - Hier kann eine Semikolon separierte Liste mit den abzuschließenden Versandarten mitgegeben werden. Es können n-Versandarten abgeschlossen werden.

(Option MultiVATagesabschluss muss im HVS32 aktiv sein)

wechselbruecke String 10 - Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
edistatus Sequence <EDIStatus> - - Liste mit Statusinformationen für EDIs.
fehlercode Integer - - 0 = Erfolgreich
fehlertext1 String 200 - -
listenDaten Map (String, String) - - Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map.


Beispiele
Request
{
	"auftraggeberID": [
		""
	],
	"druckername": "",
	"frachtfuehrerTyp": [
		""
	],
	"packplatz": "",
	"versandartID": [
		""
	],
	"wechselbruecke": ""
}
Response
{
	"assoc": {
		"":""
	},
	"fehlercode": 0,
	"fehlertext1": "",
	"edistatus": [
		{
			"fehlercode": 0,
			"statuscode": "",
			"statustext": "",
			"fftyp": "",
			"dateityp": "",
			"auftraggeber": "",
			"ffdateinr": ""
		}
	],
	"listenDaten": {}
}

Packstückdaten prüfen (versanddatenPruefAnfrage)

Das Gateway sendet die versanddatenPruefAnfrage an das Automatik-Polling des HVS32. Im HVS32 wird somit eine VersandDatenAnfrage simuliert. Dabei werden keine Etiketten gedruckt und das Packstück bzw. das Etikett wird nicht verbucht, jedoch sind alle weiteren Prozesse identisch zur VersandDatenAnfrage (Routenermittlung, Trackingnummer-Ermittlung, Adressprüfung, etc.) Diese Funktion dient dazu im Vorfeld alle Versand-Daten zu validieren.

Funktion (POST) /hvs32rest/versanddatenPruefAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
ansprechpartner String 20 - Empfänger Ansprechpartner
artikelDaten Sequence <ArtikelDaten> - - Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n)
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
auftragNr String 20 - -
auftraggeberID String 10 - Mandantenkennung aus dem HVS32
avisHinweis1 String 30 - -
avisHinweis2 String 30 - -
avisZusatz1 String 20 - Zusatz zu Fest-AVIS-Schlüssel 1
avisZusatz2 String 20 - Zusatz zu Fest-AVIS-Schlüssel 2
bestellNr String 20 - Metro-Bestellnr (Metro-Versand)
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
email String 100 - E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
faxNr String 20 - Faxnummer des Empfängers
flexZustellungEmailadresse String 80 - Flex-Zustellung Emailadresse
frachtBrief String 20 - Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
frachtfuehrerKdNr String 10 - Kundennummer des Frachtzahlers beim Frachtführer
frankaturKennung String 10 - -
gefahrgut Sequence <Gefahrgut> - - Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n)
gewicht Decimal 8 3 Bruttogewicht in KG
ilnNr String 20 - ILN des Empfängers (Pflicht bei Metro-Versand)
infotext1 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext2 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext3 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext4 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext5 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext6 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext7 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext8 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext9 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext10 String 150 - Zusatzfeld für evtl. Erweiterungen
kostenstelle String 30 - -
kundenNr String 20 - Kundennummer des Empfängers beim Versender
lieferscheinNr String 40 - Wird im HVS32 als Such-Nummer verwendet
nachnahme Decimal 18 2 -
nettoGewicht Decimal 8 3 Nettogewicht in KG
neutabsenderLKZ String 3 - Nur bei Neutral-Absendern belegt
neutabsenderName1 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName2 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName3 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderOrt String 50 - Nur bei Neutral-Absendern belegt
neutabsenderPLZ String 10 - Nur bei Neutral-Absendern belegt
neutabsenderStrasse String 50 - Nur bei Neutral-Absendern belegt
nnVermerk String 1 - B': Bar / 'V': Verrechnungsscheck
nnVerwendung String 30 - Nachnahme Verwendungszweck
nnWaehrung String 3 - Nachnahme - ISO-Währungscode
packStkGes Integer - - Gesamt-Anzahl Colli der Sendung
packStkNr Integer - - Laufende Nr pro Sendung
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
packstueckBreite Integer - - Breite in cm
packstueckHoehe Integer - - Höhe in cm
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
packstueckLaenge Integer - - Länge in cm
paperlessInvoice String 1 - Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
postLeitcode String 15 - -
postZielFrachtzent String 5 - -
rechnungsEmpfLKZ String 5 - Rechnungsadresse
rechnungsEmpfName1 String 50 - Rechnungsempfänger
rechnungsEmpfName2 String 50 - Rechnungsempfänger
rechnungsEmpfName3 String 50 - Rechnungsempfänger
rechnungsEmpfOrt String 50 - Rechnungsadresse
rechnungsEmpfPLZ String 10 - Rechnungsadresse
rechnungsEmpfStrasse String 50 - Rechnungsadresse
rechnungsNr String 20 - Rechnungsnummer
sonderdienste String 30 - Versandart-spezifisch belegt
telefonNr String 20 - Telefonnummer des Empfängers
terminArt String 1 - 'A'b / 'B'is / 'F'ix
terminDatum String 10 - TT.MM.JJJJ
terminZeit Calendar 5 - HH:MM
ustIDNr String 20 - UmsatzsteuerNr des Empfängers
verpackungsart String 6 - -
versandartID String 10 - Versandartkennung aus dem HVS32
versicherungswert Decimal 18 2 Höhe Versicherungswert
vwWaehrung String 3 - Versicherungswert - ISO-Währungscode
warenwert Decimal 18 2 -
wwWaehrung String 3 - Warenwert - ISO-Währungscode
zahlungsbedingung String 10 - 'S' = Sender, 'R' = Empfänger
zbZoll String 1 - Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
zielAdrBahnhof String 30 - PLZ und Ort
zielAdrLKZ String 5 - Lieferadresse
zielAdrName1 String 50 - Lieferadresse
zielAdrName2 String 50 - Lieferadresse
zielAdrName3 String 50 - Lieferadresse
zielAdrName4 String 50 - Lieferadresse
zielAdrOrt String 50 - Lieferadresse
zielAdrPLZ String 10 - Lieferadresse
zielAdrRegion String 20 - Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
zielAdrStrasse String 50 - Lieferadresse


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen -
druckDateTime Calendar 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
druckDateTimeString String 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
fehlertext1 String 200 - -
fehlertext2 String 200 - -


Beispiele
Request
{
	"ansprechpartner": "",
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"faxNr": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vwWaehrung": "",
	"warenwert": 0,
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
Response
{
	"druckDateTime": "",
	"fehlertext1": "",
	"fehlertext2": ""
}

Packstückdaten aktualisieren (updateVersanddaten)

Die Gatewayfunktion updateVersanddaten wird vom Data-Gateway-Server im Automatik-Polling Modus an das HVS32 gesendet, um dort die Daten von bestehende Packstücken zu verändern. Diese Anfrage wird zum Beispiel gesendet, wenn der Warenwert für ein Packstück erst zu einem späteren Zeitpunkt bekannt ist. Aktualisiert werden können Daten innerhalb der Tabellen Versandeinheit, Abrechnungseinheit und Lieferung. Dabei wird stets über das Feld PackstueckID und bei Belegung auch über das Feld TrackingNr gesucht. Bei dieser Anfrage werden allerdings die zu aktualisierenden Felder und Inhalte nicht mehr nach den Richtlinien des Frachtführers geprüft (z.B. Gewichtsgrenzen, etc.). Es muss somit vom Vorsystem sichergestellt werden, dass die aktualisierenden Werte mit den Richtlinien des Frachtführers übereinstimmen. Sollte dies nicht möglich sein, kann diese Funktion nicht genutzt werden, sondern das Etikett muss storniert und neu verarbeitet werden. Außerdem können Felder, welche bereits auf einem Etikett angedruckt oder vom Versandsystem HVS32 in einer Frachtführerabwicklung ermittelt wurden (z.B. Adresse, Route, TrackingNr, Sonderdienste, etc.) nicht manipuliert werden. Es stehen keine Packstück-/Sendungs-Daten für die Rückmeldung zur Verfügung. Nach erfolgreichem Update wird lediglich das Feld Fehler mit Wert 0 zurückgemeldet - bzw. im Fehlerfall wird Fehler mit dem Wert 1 sowie der Fehlertext1 zurückgemeldet.

Funktion (POST) /hvs32rest/updateVersanddaten
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
ansprechpartner String 20 - Empfänger Ansprechpartner
anzahlArtikel Integer 6 - Anzahl Artikel (Druck auf Etikett)
artikelDaten Sequence <ArtikelDaten> - - Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n)
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
auftragNr String 20 - -
auftraggeberID String 10 - Mandantenkennung aus dem HVS32
avisHinweis1 String 30 - -
avisHinweis2 String 30 - -
avisZusatz1 String 20 - Zusatz zu Fest-AVIS-Schlüssel 1
avisZusatz2 String 20 - Zusatz zu Fest-AVIS-Schlüssel 2
barcodeID String - - Zusatzfeld für evtl. Erweiterungen
barcodeText String - - Zusatzfeld für evtl. Erweiterungen
barcodeTyp String - - Zusatzfeld für evtl. Erweiterungen
bestellNr String 20 - Metro-Bestellnr (Metro-Versand)
druckername String 30 - Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
email String 100 - E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
empfMobilfunkNr String 20 - Mobilfunknummer des Empfängers
faxNr String 20 - Faxnummer des Empfängers
flexZustellungEmailadresse String 80 - Flex-Zustellung Emailadresse
frachtBrief String 20 - Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
frachtfuehrerKdNr String 10 - Kundennummer des Frachtzahlers beim Frachtführer
frankaturKennung String 10 - -
gefahrgut Sequence <Gefahrgut> - - Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n)
gewicht Decimal 8 3 Bruttogewicht in KG
hostTrackingNr String 35 - Paketnummer aus dem Hostsystem
ilnNr String 20 - ILN des Empfängers (Pflicht bei Metro-Versand)
infotext1 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext2 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext3 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext4 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext5 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext6 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext7 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext8 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext9 String 150 - Zusatzfeld für evtl. Erweiterungen
infotext10 String 150 - Zusatzfeld für evtl. Erweiterungen
kostenstelle String 30 - -
kundenNr String 20 - Kundennummer des Empfängers beim Versender
lagerkennzeichen Integer - - -
letztesPackstueck String 1 - T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
lieferantenID Integer - - -
lieferscheinNr String 40 - Wird im HVS32 als Such-Nummer verwendet
nachnahme Decimal 18 2 -
nettoGewicht Decimal 8 3 Nettogewicht in KG
neutBIC String 11 - Nur bei Neutral-Absendern belegt
neutBankBezeichnung String 40 - Nur bei Neutral-Absendern belegt
neutIBAN String 31 - Nur bei Neutral-Absendern belegt
neutKontoInhaber String 40 - Nur bei Neutral-Absendern belegt
neutabsenderLKZ String 3 - Nur bei Neutral-Absendern belegt
neutabsenderName1 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName2 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName3 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderOrt String 50 - Nur bei Neutral-Absendern belegt
neutabsenderPLZ String 10 - Nur bei Neutral-Absendern belegt
neutabsenderStrasse String 50 - Nur bei Neutral-Absendern belegt
nnVermerk String 1 - B': Bar / 'V': Verrechnungsscheck
nnVerwendung String 30 - Nachnahme Verwendungszweck
nnWaehrung String 3 - Nachnahme - ISO-Währungscode
packStkGes Integer - - Gesamt-Anzahl Colli der Sendung
packStkNr Integer - - Laufende Nr pro Sendung
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
packstueckBreite Integer - - Breite in cm
packstueckHoehe Integer - - Höhe in cm
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen.
packstueckLaenge Integer - - Länge in cm
paperlessInvoice String 1 - Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
postLeitcode String 15 - -
postZielFrachtzent String 5 - -
rechnungsEmpfLKZ String 5 - Rechnungsadresse
rechnungsEmpfName1 String 50 - Rechnungsempfänger
rechnungsEmpfName2 String 50 - Rechnungsempfänger
rechnungsEmpfName3 String 50 - Rechnungsempfänger
rechnungsEmpfOrt String 50 - Rechnungsadresse
rechnungsEmpfPLZ String 10 - Rechnungsadresse
rechnungsEmpfStrasse String 50 - Rechnungsadresse
rechnungsNr String 20 - Rechnungsnummer
sendungsinhalt String 30 - -
sonderdienste String 30 - Versandart-spezifisch belegt
sperrFlag String 1 - T/F: T=Sperren, sonst nicht sperren
telefonNr String 20 - Telefonnummer des Empfängers
terminArt String 1 - 'A'b / 'B'is / 'F'ix
terminDatum String 10 - TT.MM.JJJJ
terminZeit Calendar 5 - HH:MM
ustIDNr String 20 - UmsatzsteuerNr des Empfängers
verpackungsart String 6 - -
versandartID String 10 - Versandartkennung aus dem HVS32
versicherungswert Decimal 18 2 Höhe Versicherungswert
vorpackdatum String 10 - TT.MM.JJJJ
vwWaehrung String 3 - Versicherungswert - ISO-Währungscode
warenwert Decimal 18 2 -
wechselbruecke String 20 - Wechselbrücke, die diesem Packstück zugewiesen wird
wwWaehrung String 3 - Warenwert - ISO-Währungscode
zahlungsbedingung String 10 - 'S' = Sender, 'R' = Empfänger
zbZoll String 1 - Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
zielAdrBahnhof String 30 - PLZ und Ort
zielAdrLKZ String 5 - Lieferadresse
zielAdrName1 String 50 - Lieferadresse
zielAdrName2 String 50 - Lieferadresse
zielAdrName3 String 50 - Lieferadresse
zielAdrName4 String 50 - Lieferadresse
zielAdrOrt String 50 - Lieferadresse
zielAdrPLZ String 10 - Lieferadresse
zielAdrRegion String 20 - Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
zielAdrStrasse String 50 - Lieferadresse


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
ausgangDateTime Calendar 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
ausgangDateTimeString String 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
druckDateTime Calendar 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
druckDateTimeString String 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
etikettDaten String - - Binärdaten des Etiketts
etikettName String - - Vorlagenname des Etiketts
fehlercode Integer - - 0 wenn Erfolgreich
fehlertext1 String 200 - Wird im Fehlerfall befüllt
fehlertext2 String 200 - Wird im Fehlerfall befüllt
gebuehr Decimal 18 2 Frachtkosten
gebuehrWaehrung String 3 - Frachkosten ISO-Währungscode
packstueckID String 20 - PackstueckID aus der Anfrage
retourTrackingNr String 50 - Paketnummer für die Retoure
trackingNr String 35 - Paketnummer
trackingURL String 255 - URL des Trackinglinks zur Sendungsverfolgung
versandSendungsNr String - - -
zusatzEtikettenDaten Map (String, String) - - Name und Binärdaten der Zusatzetiketten als Key/Value Map
zusatzfeld1 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld2 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld3 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld4 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld5 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld6 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld7 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld8 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld9 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld10 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden


Beispiele
Request
{
	"ansprechpartner": "",
	"anzahlArtikel": 0,
	"artikelDaten": [
		{
			"anzahlBuegel": 0,
			"anzahlPosEtiketten": 0,
			"artikelBTNNr": "",
			"artikelEAN": "",
			"artikelEinheit": "",
			"artikelGewicht": 0,
			"artikelGruppe": "",
			"artikelMenge": 0,
			"artikelServices": "",
			"artikelSollMenge": 0,
			"artikelText1": "",
			"artikelText2": "",
			"artikelText3": "",
			"artikelText4": "",
			"artikelVolumen": 0,
			"artikelWaehrung": "",
			"artikelWert": 0,
			"chargeFlag": "",
			"kundenArtikelNr": "",
			"kundenBestellNr": "",
			"posAuftragNr": "",
			"posLieferNr": "",
			"positionNr": "",
			"serienNr": "",
			"ursprungLand": ""
		}
	],
	"auftragNr": "",
	"auftraggeberID": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"barcodeID": "",
	"barcodeText": "",
	"barcodeTyp": "",
	"bestellNr": "",
	"druckername": "",
	"email": "",
	"empfMobilfunkNr": "",
	"faxNr": "",
	"flexZustellungEmailadResponsese": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"gefahrgut": [
		{
			"gefahrgutBefoerdKat": 0,
			"gefahrgutBegrenzteMenge": "",
			"gefahrgutBezeichnung": "",
			"gefahrgutBuchst640": "",
			"gefahrgutFFCode": "",
			"gefahrgutFaktor": 0,
			"gefahrgutFreigestMenge": "",
			"gefahrgutKCode": "",
			"gefahrgutKlasse": "",
			"gefahrgutMenge": 0,
			"gefahrgutMengenEinheit": "",
			"gefahrgutNebenGefahr": "",
			"gefahrgutNettoExplMasse": 0,
			"gefahrgutTunnelBCode": "",
			"gefahrgutUNNR": "",
			"gefahrgutUmweltGef": "",
			"gefahrgutVPG": "",
			"gefahrgutVerpAnzahl": 0,
			"gefahrgutVerpackungsart": ""
		}
	],
	"gewicht": 0,
	"hostTrackingNr": "",
	"ilnNr": "",
	"infotext1": "",
	"infotext2": "",
	"infotext3": "",
	"infotext4": "",
	"infotext5": "",
	"infotext6": "",
	"infotext7": "",
	"infotext8": "",
	"infotext9": "",
	"infotext10": "",
	"kostenstelle": "",
	"kundenNr": "",
	"lagerkennzeichen": 0,
	"letztesPackstueck": "",
	"lieferantenID": 0,
	"lieferscheinNr": "",
	"nachnahme": 0,
	"nettoGewicht": 0,
	"neutBIC": "",
	"neutBankBezeichnung": "",
	"neutIBAN": "",
	"neutKontoInhaber": "",
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"nnVermerk": "",
	"nnVerwendung": "",
	"nnWaehrung": "",
	"packStkGes": 0,
	"packStkNr": 0,
	"packplatz": "",
	"packstueckBreite": 0,
	"packstueckHoehe": 0,
	"packstueckID": "",
	"packstueckLaenge": 0,
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"rechnungsNr": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"sperrFlag": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"verpackungsart": "",
	"versandartID": "",
	"versicherungswert": 0,
	"vorpackdatum": "",
	"vwWaehrung": "",
	"warenwert": 0,
	"wechselbruecke": "",
	"wwWaehrung": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrName4": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
Response
{
	"packstueckID": "",
	"trackingNr": "",
	"retourTrackingNr": "",
	"versandSendungsNr": "",
	"druckDateTime": "",
	"ausgangDateTime": "",
	"gebuehrWaehrung": "",
	"fehlercode": 0,
	"fehlertext1": "",
	"fehlertext2": "",
	"etikettName": "",
	"etikettDaten": "",
	"trackingURL": "",
	"zusatzfeld1": "",
	"zusatzfeld2": "",
	"zusatzfeld3": "",
	"zusatzfeld4": "",
	"zusatzfeld5": "",
	"zusatzfeld6": "",
	"zusatzfeld7": "",
	"zusatzfeld8": "",
	"zusatzfeld9": "",
	"zusatzfeld10": ""
}

Packstückdaten anonymisieren (anonymisiereVersandDaten)

Das Gateway sendet die anonymisiereVersandDaten an das Automatik-Polling des HVS32. Im HVS32 werden somit Kunden bezogene Daten für den entsprechenden Datensatz gemäß DSGVO anonymisiert. Diese Anonymisierung wird unwiderruflich und endgültig auf der Datenbankebene des Versandsystems durchgeführt. Eine Wiederherstellung der ursprünglichen Daten ist somit nicht mehr möglich. Log-Dateien, Rückmelde-Dateien, bereits übertragene Frachtführer DFÜs etc. sind hiervon nicht betroffen. Es können ausschließlich Packstücke und Sendungen anonymisiert werden, welche bereits Tages abgeschlossen sind.

Funktion (POST) /hvs32rest/anonymisiereVersandDaten
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Nachkommastellen Belegung
auftragsNr String 20 - -
lieferscheinNr String 40 - Wird im HVS32 als Such-Nummer verwendet.
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
packstueckID String 20 - Eindeutige Nummer für das Paket im Vorsystem.
trackingNr String 35 - Paketnummer


Rückgabe Parameter
Feldname Typ Max Länge Nachkommastellen Belegung
fehlertext1 String 200 - Wird im Fehlerfall befüllt
fehlertext2 String 200 - Wird im Fehlerfall befüllt


Beispiele
Request
{
	"auftragNr": "",
	"lieferscheinNr": "",
	"packplatz": "",
	"packstueckID": "",
	"trackingNr": ""
}
Response
{
	"fehlertext1": "",
	"fehlertext2": ""
}

Sendungs-Verarbeitung (sendungsdatenAnfrage)

sendungsdatenAnfrage – wird zur Laufzeit in einzelne versandDatenAnfragen unterteilt. Muss bei einer Anfrage für das SPM genutzt werden (requestSPM=TRUE)

Funktion (POST) /hvs32rest/sendungsdatenAnfrage
MediaType text/plain
Charset UTF-8


Übergabe Parameter

Fett dargestellte Felder müssen IMMER belegt sein

Feldname Typ Max Länge Dezimalstellen Belegung
ansprechpartner String 20 - Empfänger Ansprechpartner
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
auftragNr String 20 - -
auftraggeberID String 10 - Mandantenkennung aus dem HVS32
ausschlussFrachtfuehrer String 20 - Ausschluss-Frachtführer für SPM Anfrage
avisHinweis1 String 30 - -
avisHinweis2 String 30 - -
avisZusatz1 String 20 - Zusatz zu Fest-AVIS-Schlüssel 1
avisZusatz2 String 20 - Zusatz zu Fest-AVIS-Schlüssel 2
bestellNr String 20 - -
email String 100 - Für automatische Mailavisierung
empfMobilfunkNr String 20 - Mobilfunknummer des Empfängers
faxNr String 20 - Faxnummer des Empfängers
flexZustellungEmailadResponsese String 80 - Flex-Zustellung Email-Adresse
frachtBrief String 20 - Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
frachtfuehrerKdNr String 10 - Kundennummer des Frachtzahlers beim Frachtführer.
frankaturKennung String 10 - -
ilnNr String 20 - ILN des Empfängers (Pflicht bei Metro-Versand)
kostenstelle String 30 - -
kundenNr String 20 - Kundennummer des Empfängers beim Versender
Lagerkennzeichen String
LieferantenID String
lieferscheinNr String 40 - Wird im HVS32 als Such-Nummer verwendet.
neutBIC String 11 - Nur bei Neutral-Absendern belegt
neutBankBezeichnung String 40 - Nur bei Neutral-Absendern belegt
neutIBAN String 31 - Nur bei Neutral-Absendern belegt
neutKontoInhaber String 40 - Nur bei Neutral-Absendern belegt
neutabsenderLKZ String 3 - Nur bei Neutral-Absendern belegt
neutabsenderName1 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName2 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderName3 String 50 - Nur bei Neutral-Absendern belegt
neutabsenderOrt String 50 - Nur bei Neutral-Absendern belegt
neutabsenderPLZ String 10 - Nur bei Neutral-Absendern belegt
neutabsenderStrasse String 50 - Nur bei Neutral-Absendern belegt
packStkGes Integer - - Gesamt-Anzahl Colli der Sendung
packstueckDaten Sequence <PackStueckDaten> - - -
packplatz String 10 - HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
paperlessInvoice String 1 - Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
postLeitcode String 15 - -
postZielFrachtzent String 5 - -
rechnungsEmpfLKZ String 5 - Rechnungsadresse
rechnungsEmpfName1 String 50 - Rechnungsempfänger
rechnungsEmpfName2 String 50 - Rechnungsempfänger
rechnungsEmpfName3 String 50 - Rechnungsempfänger
rechnungsEmpfOrt String 50 - Rechnungsadresse
rechnungsEmpfPLZ String 10 - Rechnungsadresse
rechnungsEmpfStrasse String 50 - Rechnungsadresse
rechnungsNr String 20 - Rechnungsnummer
requestSPM String 5 - T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
sendungsinhalt String 30 - -
sonderdienste String 30 - Versandart-spezifisch belegt
sperrFlag String 1 - T/F: T=Sperren, sonst nicht sperren
telefonNr String 20 - Telefonnummer des Empfängers
terminArt String 1 - 'A'b / 'B'is / 'F'ix
terminDatum String 10 - TT.MM.JJJJ
terminZeit String 5 - HH:MM
ustIDNr String 20 - UmsatzsteuerNr des Empfängers
versandartID String 10 - Versandartkennung aus dem HVS32
vorgabeFrachtfuehrer String 20 - Vorgabe-Frachtführer für SPM Anfrage
vorpackdatum String 10 - TT.MM.JJJJ
wechselbruecke String 20 - Wechselbrücke, die diesem Packstück zugewiesen werden soll
zahlungsbedingung String 10 - 'S' = Sender, 'R' = Empfänger
zbZoll String 1 - Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
zielAdrBahnhof String 30 - PLZ und Ort des Bahnhofs
zielAdrLKZ String 5 - Länderkennzeichen (LKZ)
zielAdrName1 String 50 - Lieferadresse
zielAdrName2 String 50 - Lieferadresse
zielAdrName3 String 50 - Lieferadresse
zielAdrName4 String 50 - Lieferadresse
zielAdrOrt String 50 - Lieferadresse
zielAdrPLZ String 10 - Lieferadresse
zielAdrRegion String 20 - Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
zielAdrStrasse String 50 - Lieferadresse


Rückgabe Parameter
Feldname Typ Max Länge Dezimalstellen Belegung
fehler String - - Wird im Fehlerfall befüllt
sendungsGebuehr Decimal 18 2 Frachkosten
sendungsGebuehrWaehrung String 3 - Frachkosten ISO-Währungscode
versandSendungsNr String 20 - Sendungsnummer
Packstückdaten
Feldname Typ Max Länge Dezimalstellen
assoc Map (String, String) - - Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
ausgangDateTime Calendar 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
ausgangDateTimeString String 10 - Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
druckDateTime Calendar 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
druckDateTimeString String 19 - Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
etikettDaten String - - Binärdaten des Etiketts
etikettName String - - Vorlagenname des Etiketts
fehlercode Integer - - 0 wenn Erfolgreich
fehlertext1 String 200 - Wird im Fehlerfall befüllt
fehlertext2 String 200 - Wird im Fehlerfall befüllt
gebuehr Decimal 18 2 Frachtkosten
gebuehrWaehrung String 3 - Frachkosten ISO-Währungscode
packstueckID String 20 - PackstueckID aus der Anfrage
retourTrackingNr String 50 - Paketnummer für die Retoure
trackingNr String 35 - Paketnummer
trackingURL String 255 - URL des Trackinglinks zur Sendungsverfolgung
zusatzEtikettenDaten Map (String, String) - - Name und Binärdaten der Zusatzetiketten als Key/Value Map
zusatzfeld1 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld2 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld3 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld4 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld5 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld6 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld7 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld8 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld9 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
zusatzfeld10 String 200 - Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden


Beispiele
Request
{
	"ansprechpartner": "",
	"assoc": {
		"":""
	},
	"auftragNr": "",
	"auftraggeberID": "",
	"ausschlussFrachtfuehrer": "",
	"avisHinweis1": "",
	"avisHinweis2": "",
	"avisZusatz1": "",
	"avisZusatz2": "",
	"bestellNr": "",
	"email": "",
	"empfMobilfunkNr": "",
	"faxNr": "",
	"flexZustellungEmailadResponsese": "",
	"frachtBrief": "",
	"frachtfuehrerKdNr": "",
	"frankaturKennung": "",
	"ilnNr": "",
	"kostenstelle": "",
	"kundenNr": "",
	"Lagerkennzeichen": 0,
	"LieferantenID": 0,
	"lieferscheinNr": "",
	"neutBIC": "",
	"neutBankBezeichnung": "",
	"neutIBAN": "",
	"neutKontoInhaber": "",
	"neutabsenderLKZ": "",
	"neutabsenderName1": "",
	"neutabsenderName2": "",
	"neutabsenderName3": "",
	"neutabsenderOrt": "",
	"neutabsenderPLZ": "",
	"neutabsenderStrasse": "",
	"packStkGes": 0,
	"packStueckDaten": [
		{
			"anzahlArtikel": 0,
			"assoc": {
				"":""
			},
			"artikelDaten": [
				{
					"anzahlBuegel": 0,
					"anzahlPosEtiketten": 0,
					"artikelBTNNr": "",
					"artikelEAN": "",
					"artikelEinheit": "",
					"artikelGewicht": 0,
					"artikelGruppe": "",
					"artikelMenge": 0,
					"artikelServices": "",
					"artikelSollMenge": 0,
					"artikelText1": "",
					"artikelText2": "",
					"artikelText3": "",
					"artikelText4": "",
					"artikelVolumen": 0,
					"artikelWaehrung": "",
					"artikelWert": 0,
					"chargeFlag": "",
					"kundenArtikelNr": "",
					"kundenBestellNr": "",
					"posAuftragNr": "",
					"posLieferNr": "",
					"positionNr": "",
					"serienNr": "",
					"ursprungLand": ""
				}
			],
			"barcodeID": "",
			"barcodeText": "",
			"barcodeTyp": "",
			"druckername": "",
			"gefahrgut": [
				{
					"gefahrgutBefoerdKat": 0,
					"gefahrgutBegrenzteMenge": "",
					"gefahrgutBezeichnung": "",
					"gefahrgutBuchst640": "",
					"gefahrgutFFCode": "",
					"gefahrgutFaktor": 0,
					"gefahrgutFreigestMenge": "",
					"gefahrgutKCode": "",
					"gefahrgutKlasse": "",
					"gefahrgutMenge": 0,
					"gefahrgutMengenEinheit": "",
					"gefahrgutNebenGefahr": "",
					"gefahrgutNettoExplMasse": 0,
					"gefahrgutTunnelBCode": "",
					"gefahrgutUNNR": "",
					"gefahrgutUmweltGef": "",
					"gefahrgutVPG": "",
					"gefahrgutVerpAnzahl": 0,
					"gefahrgutVerpackungsart": ""
				}
			],
			"gewicht": 0,
			"hostTrackingNr": "",
			"infotext1": "",
			"infotext10": "",
			"infotext2": "",
			"infotext3": "",
			"infotext4": "",
			"infotext5": "",
			"infotext6": "",
			"infotext7": "",
			"infotext8": "",
			"infotext9": "",
			"letztesPackstueck": "",
			"nachnahme": 0,
			"nettoGewicht": 0,
			"nnVermerk": "",
			"nnVerwendung": "",
			"nnWaehrung": "",
			"packStkNr": 0,
			"packstueckBreite": 0,
			"packstueckHoehe": 0,
			"packstueckID": "",
			"packstueckLaenge": 0,
			"verpackungsart": "",
			"versicherungswert": 0,
			"vwWaehrung": "",
			"warenwert": 0,
			"wwWaehrung": ""
		}
	],
	"packplatz": "",
	"paperlessInvoice": "",
	"postLeitcode": "",
	"postZielFrachtzent": "",
	"rechnungsEmpfLKZ": "",
	"rechnungsEmpfName1": "",
	"rechnungsEmpfName2": "",
	"rechnungsEmpfName3": "",
	"rechnungsEmpfOrt": "",
	"rechnungsEmpfPLZ": "",
	"rechnungsEmpfStrasse": "",
	"rechnungsNr": "",
	"RequestuestSPM": "",
	"sendungsinhalt": "",
	"sonderdienste": "",
	"sperrFlag": "",
	"telefonNr": "",
	"terminArt": "",
	"terminDatum": "",
	"terminZeit": "",
	"ustIDNr": "",
	"versandartID": "",
	"vorgabeFrachtfuehrer": "",
	"vorpackdatum": "",
	"wechselbruecke": "",
	"zahlungsbedingung": "",
	"zbZoll": "",
	"zielAdrBahnhof": "",
	"zielAdrLKZ": "",
	"zielAdrName1": "",
	"zielAdrName2": "",
	"zielAdrName3": "",
	"zielAdrName4": "",
	"zielAdrOrt": "",
	"zielAdrPLZ": "",
	"zielAdrRegion": "",
	"zielAdrStrasse": ""
}
Response
{
	"versandSendungsNr": "",
	"sendungsGebuehrWaehrung": "",
	"fehler": "",
	"packStueckDaten": [
		{
			"assoc": {
				"":""
			},
			"packstueckID": "",
			"trackingNr": "",
			"retourTrackingNr": "",
			"druckDateTime": "",
			"gebuehrWaehrung": "",
			"fehlertext1": "",
			"fehlertext2": "",
			"etikettName": "",
			"etikettDaten": "",
			"zusatzEtikettenDaten": {
				"": ""
			},
			"trackingURL": "",
			"zusatzfeld1": "",
			"zusatzfeld2": "",
			"zusatzfeld3": "",
			"zusatzfeld4": "",
			"zusatzfeld5": "",
			"zusatzfeld6": "",
			"zusatzfeld7": "",
			"zusatzfeld8": "",
			"zusatzfeld9": "",
			"zusatzfeld10": "",
			"ausgangDateTime": ""
		}
	]
}

Beispiele

Alle JSON Beispiele finden Sie auch hier: REST SERVER JSON Beispiele

Abgerufen von „https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_REST_Schnittstelle_(Automatik-Polling)&oldid=3868“