HVS32 Standard Datei Schnittstelle: Unterschied zwischen den Versionen

Aus Wiki - Heidler Strichcode GmbH
Zur Navigation springen Zur Suche springen
 
(62 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
 
= 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.
+
Die Dateischnittstelle ist sehr flexibel und kann an nahezu alle Eingangsdaten angepasst werden. Es ist möglich mehrere Datensätze in einer Datei zu übergeben, aber auch ein Datensatz pro Datei ist möglich.
−
<!-- ------------------------------------------------------------------------------- ENDE Funktionsbeschreibung ------------------------------------------------------------------------------- -->
+
In der Regel belegt ein Packstück eine Zeile, eventuell gefolgt von Zusatzinformationen wie Artikeldaten oder Gefahrgutsätzen.
−
<!-- ------------------------------------------------------------------------------- DATENTYPEN ------------------------------------------------------------------------------- -->
+
<br>
 +
Die einzelnen Felder sind unter [[HVS32_Standard_Datei_Tabellenbeschreibung|Standard Datei Tabellenbeschreibung (CSV, SDF, etc.)]] beschrieben.
 +
 
 +
= Übersicht der Funktionen =
 +
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- -->
 +
== Packstück-Verarbeitung ==
 +
Ein neues Packstück wird durch eine Zeile gekennzeichnet die mit der Kennung "IMP" beginnt.
  
−
= Datentypen =
+
Die weiteren Felder sind in der [[HVS32_Standard_Datei_Tabellenbeschreibung|Standardschnittstelle]] beschrieben.
−
'''Integer''' - Zahl mit ausschließlich numerischen Zeichen (0-9).<br>
 
−
'''Decimal''' - Zahl mit Nachkommastellen<br>
 
−
'''Calendar''' - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)<br>
 
−
'''String''' - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.<br>
 
−
'''Binary''' - Base64 kodierte Binärdaten<br>
 
−
'''Sequence''' - Eine Liste von Elementen<br>
 
−
'''Map''' - Key/Value Map<br>
 
−
<!-- ------------------------------------------------------------------------------- ENDE DATENTYPEN ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->
 
  
−
= Zusätzliche Datentypen =
+
== Etikett nachdrucken ==
−
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer [[#Übersicht der Funktionen|Funktion]] genutzt werden.
 
−
<!-- ------------------------------------------------------------------------------- artikelDaten ------------------------------------------------------------------------------- -->
 
−
== artikelDaten ==
 
  
−
Nr, Feldname, Von, Bis, Typ, Länge, Dez, Pflicht, HVS-Feld, Belegung, Feldname
+
Ein Nachdruck wird ausgelöst indem ein bereits übergebener Satz erneut erfasst wird. Je nach Einstellungen kann es dabei zu einer Warnung oder einer Verhinderung des Nachdrucks kommen - die zugehörigen Wahlmöglichkeiten befinden sich im Allgemein-Konfigurator, Bereich "Lieferschein-Verarbeitung".
  
 +
== Packstück stornieren ==
 +
<!--
 +
Text anpassen
 +
<br>
 +
<br>
 +
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">Artikel-Daten</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
 +
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Nr !! Feldname !! Von !! Bis !! Typ !! Länge !! Dezimalstellen !! Pflicht !! HVS-Feld !! Belegung !! Feldname
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| 1 || Satz-Kennung || 1 || 3 || A || 3 ||  ||
+
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
 
|-
 
|-
−
| 2 || Lieferschein-Nr || 4 || 13 || A || 10 ||  ||
+
| '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
−
| 3 || Packstück-Nr || 14 || 16 || N || 3 ||  ||
 
 
|-
 
|-
−
| 4 || Positions-Nr || 17 || 26 || N || 10 || 0 ||
+
| 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"
 
|-
 
|-
−
| 5 || Artikel-Nr || 27 || 76 || A || 50 || ||
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| 6 || Artikel-Bezeichnung1 || 77 || 176 || A || 100 || ||
+
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
|-
 
|-
−
| 7 || Artikel-Bezeichnung2 || 177 || 276 || A || 100 || ||
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 
|-
 
|-
−
| 8 || Artikel-Netto-Gewicht (je Maßeinheit) || 277 || 285 || N || 9 || 3 ||
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
−
|-
+
|}
−
| 9 || BTN-Nummer || 286 || 310 || A || 25 ||  ||
+
</div></div>
−
|-
+
<br>
−
| 10 || Artikel-Anzahl (je Maßeinheit) || 311 || 319 || N || 9 || 0 ||
 
−
|-
 
−
| 11 || Ursprungsland || 320 || 321 || A || 2 ||  ||
 
−
|-
 
−
| 12 || Artikel-Wert (je Maßeinheit) || 322 || 330 || N || 9 || 2 ||
 
−
|-
 
−
| 13 || Artikelwert-Währung || 331 || 333 || A || 3 ||  ||
 
−
|-
 
−
| 14 || Artikel-Maßeinheit || 334 || 343 || A || 10 ||  ||
 
−
|-
 
−
| 15 || Artikel-BestellNr || 344 || 393 || A || 50 ||  ||
 
−
|-
 
−
| 16 || Artikel-Volumen || 394 || 402 || N || 9 || 3 ||
 
−
|-
 
−
| 17 || Artikel-Services || 403 || 452 || A || 50 ||  ||
 
−
|-
 
−
| 18 || Artikel-Gruppe || 453 || 502 || A || 50 ||  ||
 
−
|-
 
−
| 19 || CR/LF || 503 || 504 ||  || 2 ||  ||  ||
 
−
|-
 
−
| 20 || kundenBestellNr || [[#Datentypen|String]] || 50 || - || Bestellnummer
 
−
|-
 
−
| 21 || posAuftragNr || [[#Datentypen|String]] || 50 || - || Auftragsnummer
 
−
|-
 
−
| 22 || posLieferNr || [[#Datentypen|String]] || 40 || - || Lieferscheinnummer
 
−
|-
 
−
| 23 || positionNr || [[#Datentypen|String]] || 50 || - || Laufende Nummer innerhalb des Packstücks
 
−
|-
 
−
| 24 || serienNr || [[#Datentypen|String]] || 30 || - || Seriennummer
 
−
|-
 
−
| 25 || ursprungLand || [[#Datentypen|String]] || 2 || - || Ursprungsland des Artikels
 
−
|}
 
−
</div></div>
 
−
<!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- -->
 
−
 
 
−
== gefahrgut ==
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">Gefahrgut-Daten</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
{| class="wikitable sortable"
+
;Request
−
|-
+
<source lang="json">
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
{
−
|-
+
"packplatz": "",
−
| gefahrgutBefoerdKat || [[#Datentypen|Integer]] || 1 || - || Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein.
+
"packstueckID": "",
 +
"trackingNr": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": ""
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE stornoversanddaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- verladeVersandaten ------------------------------------------------------------------------------- -->
 +
 
 +
== Ausgangsliste erzeugen ==
 +
<!--
 +
Text anpassen
 +
<br>
 +
<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"
 
|-
 
|-
−
| gefahrgutBegrenzteMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| gefahrgutBezeichnung || [[#Datentypen|String]] || 100 || - || Pflicht (siehe ADR-Tabelle Spalte (2))
+
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
 +
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.
 
|-
 
|-
−
| gefahrgutBuchst640 || [[#Datentypen|String]] || 1 || - || Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6))
+
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
 +
(Benötigt Druckerspooler Erweiterungsmodul)
 
|-
 
|-
−
| gefahrgutFFCode || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
+
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
 +
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.
 
|-
 
|-
−
| 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
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
 
|-
 
|-
−
| gefahrgutFreigestMenge || [[#Datentypen|String]] || 1 || - || T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht
+
| versandartID || [[#Datentypen|String]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
 +
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
|-
 
|-
−
| gefahrgutID || [[#Datentypen|String]] || 8 || - || Eindeutige Suchnummer für Gefahrgut-Stammdaten
+
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
−
|-
 
−
| 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
 
−
|-
 
−
| 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 )
 
−
|-
 
−
| gefahrgutNettoExplMasse || [[#Datentypen|Decimal]] || 8 || 3 || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
 
−
|-
 
−
| gefahrgutPositionNr || [[#Datentypen|Integer]] || - || - || Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1
 
−
|-
 
−
| gefahrgutTechBenennung || [[#Datentypen|String]] || 150 || - || bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet)
 
−
|-
 
−
| gefahrgutTunnelBCode || [[#Datentypen|String]] || 10 || - || Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15))
 
−
|-
 
−
| gefahrgutUNNR || [[#Datentypen|String]] || 10 || - || Pflicht (siehe ADR-Tabelle Spalte (1))
 
−
|-
 
−
| gefahrgutUmweltGef || [[#Datentypen|String]] || 1 || - || T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen
 
−
|-
 
−
| 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))
 
−
|-
 
−
| gefahrgutVerpAnzahl || [[#Datentypen|Integer]] || 4 || - || Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart)
 
−
|-
 
−
| gefahrgutVerpackungsart || [[#Datentypen|String]] || 5 || - || ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes
 
 
|}
 
|}
 
</div></div>
 
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- -->
 
−
 
 
−
== edistatus ==
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">EDIStatus</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 
<div class="mw-collapsible-content">
 
<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)
 
|-
 
|-
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
|-
 
|-
−
| statuscode || [[#Datentypen|String]] || 2 || - ||
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
−
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
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
 
|-
 
|-
−
| fftyp || [[#Datentypen|String]] || 50 || - || Frachtführertyp (z.B. UPS, GLS, DPD)
+
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
 
|-
 
|-
−
| dateityp || [[#Datentypen|String]] || 50 || - || FFDateityp (z.B.: Standard, Express, etc.)
+
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
−
|-
 
−
| auftraggeber || [[#Datentypen|String]] || 10 || - || Auftraggebernummer ('''ACHTUNG!''' Nicht die AuftraggeberID)
 
−
|-
 
−
| ffdateinr || [[#Datentypen|String]] || 10 || - || Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)
 
 
|}
 
|}
 
</div></div>
 
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- -->
+
<br>
−
<!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- -->
 
−
== packstueckDaten ==
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">Packstückdaten</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
{| class="wikitable sortable"
+
;Request
−
|-
+
<source lang="json">
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
{
−
|-
+
"auftraggeberID": [
−
| 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)
+
"druckername": "",
−
|-
+
"frachtfuehrerTyp": [
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
""
−
|-
+
],
−
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
"packplatz": "",
−
|-
+
"versandartID": [
−
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
""
 +
],
 +
"wechselbruecke": ""
 +
}
 +
</source>
 +
;Response
 +
<source lang="json">
 +
{
 +
"assoc": {
 +
"":""
 +
},
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"listenDaten": {
 +
"": ""
 +
}
 +
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->
 +
 
 +
== Frachtführer DFÜ erzeugen ==
 +
<!--
 +
Text anpassen
 +
<br>
 +
<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"
 
|-
 
|-
−
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
+
| auftraggeberID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
 +
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.
 
|-
 
|-
−
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
+
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den z.B. die UPS Summary gedruckt wird.<br>
 +
(Benötigt Druckerspooler Erweiterungsmodul)
 
|-
 
|-
−
| '''gewicht''' || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
+
| frachtfuehrerTyp || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".<br>
 +
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.
 
|-
 
|-
−
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Falls die Paketnummer aus dem Vorsystem verwendet werden soll.
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Tagesabschluss ausführen soll.
 
|-
 
|-
−
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.<br>
 +
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
 
|-
 
|-
−
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 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"
 
|-
 
|-
−
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
 
|-
 
|-
−
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
|-
 
|-
−
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs.
 
|-
 
|-
−
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
|-
 
|-
−
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
 
|-
 
|-
−
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der EDI-Listen (z.B. UPS Summary) als Key/Value Map.
−
|-
+
|}
−
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
</div></div>
−
|-
+
<br>
−
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
|-
+
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
−
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
+
<div class="mw-collapsible-content">
−
|-
+
;Request
−
| nachnahme || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
+
<source lang="json">
−
|-
+
{
−
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
+
"auftraggeberID": [
−
|-
+
""
−
| nnVermerk || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
+
],
−
|-
+
"druckername": "",
−
| nnVerwendung || [[#Datentypen|String]] || 1 || - || 'B' = Bar, 'V' = Verrechnungsscheck
+
"frachtfuehrerTyp": [
−
|-
+
""
−
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
+
],
−
|-
+
"packplatz": "",
−
| '''packStkNr''' || [[#Datentypen|Integer]] || - || - || Laufende Nummer pro Sendung
+
"versandartID": [
−
|-
+
""
−
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
+
],
−
|-
+
"wechselbruecke": ""
−
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
+
}
−
|-
+
</source>
−
| '''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.
+
;Response
−
|-
+
<source lang="json">
−
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
+
{
−
|-
+
"assoc": {
−
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
+
"":""
−
|-
+
},
−
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe-Versicherungswert
+
"fehlercode": 0,
−
|-
+
"fehlertext1": "",
−
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
+
"edistatus": [
−
|-
+
{
−
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
+
"fehlercode": 0,
−
|-
+
"statuscode": "",
−
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
+
"statustext": "",
−
|}
+
"fftyp": "",
 +
"dateityp": "",
 +
"auftraggeber": "",
 +
"ffdateinr": ""
 +
}
 +
],
 +
"listenDaten": {}
 +
}
 +
</source>
 
</div></div>
 
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE packstueckDaten ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT spezial Datentypen ------------------------------------------------------------------------------- -->
+
<!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
−
<!-- ------------------------------------------------------------------------------- ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
 
  
−
= Übersicht der Funktionen =
+
== Packstückdaten aktualisieren ==
−
<!-- ------------------------------------------------------------------------------- echo ------------------------------------------------------------------------------- -->
+
<!--
−
== Schnittstelle testen (echo) ==
+
Text anpassen
−
Zum Testen der REST-Schnittstelle. Liefert die übergebene Nachricht unverändert zurück.<br><br>
 
−
'''Funktion (GET): /hvs32rest/echo/<Nachricht>'''<br>
 
−
<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>
 
<br>
 
<br>
 
<br>
−
'''Funktion (POST): /hvs32rest/versanddatenAnfrage'''<br>
 
−
'''MediaType: text/plain'''<br>
 
 
<br>
 
<br>
−
<!-- ------------------------------------------------------------------------------- Request ------------------------------------------------------------------------------- -->
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
Zeile 283: Zeile 283:
 
|-
 
|-
 
| 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 294: Zeile 292:
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 
|-
 
|-
−
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 
|-
 
|-
−
| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 
|-
 
|-
 
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
 
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
 
|-
 
|-
 
| 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 313: Zeile 305:
 
|-
 
|-
 
| 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 326: Zeile 316:
 
| 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)
+
| [[#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 358: Zeile 346:
 
| 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 408: Zeile 382:
 
| 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 433: Zeile 407:
 
|-
 
|-
 
| 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 455: Zeile 425:
 
|-
 
|-
 
| 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 491: Zeile 457:
 
|}
 
|}
 
</div></div>
 
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE Request ------------------------------------------------------------------------------- -->
 
 
<br>
 
<br>
−
<!-- ------------------------------------------------------------------------------- Response ------------------------------------------------------------------------------- -->
 
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
Zeile 499: Zeile 463:
 
{| 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 511: Zeile 469:
 
| 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
+
</div></div>
−
|-
+
<br>
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
|-
+
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
<div class="mw-collapsible-content">
−
|-
+
;Request
−
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
+
<source lang="json">
−
|-
+
{
−
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
+
"ansprechpartner": "",
−
|-
+
"artikelDaten": [
−
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
+
{
−
|-
+
"anzahlBuegel": 0,
−
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
+
"anzahlPosEtiketten": 0,
−
|-
+
"artikelBTNNr": "",
−
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
+
"artikelEAN": "",
−
|-
+
"artikelEinheit": "",
−
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
+
"artikelGewicht": 0,
−
|-
+
"artikelGruppe": "",
−
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
+
"artikelMenge": 0,
−
|-
+
"artikelServices": "",
−
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
+
"artikelSollMenge": 0,
−
|-
+
"artikelText1": "",
−
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"artikelText2": "",
−
|-
+
"artikelText3": "",
−
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"artikelText4": "",
−
|-
+
"artikelVolumen": 0,
−
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"artikelWaehrung": "",
−
|-
+
"artikelWert": 0,
−
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"chargeFlag": "",
−
|-
+
"kundenArtikelNr": "",
−
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"kundenBestellNr": "",
−
|-
+
"posAuftragNr": "",
−
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"posLieferNr": "",
−
|-
+
"positionNr": "",
−
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"serienNr": "",
−
|-
+
"ursprungLand": ""
−
| 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
+
"auftragNr": "",
−
|-
+
"auftraggeberID": "",
−
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
"avisHinweis1": "",
−
|}
+
"avisHinweis2": "",
−
</div></div>
+
"avisZusatz1": "",
−
<!-- ------------------------------------------------------------------------------- ENDE Response ------------------------------------------------------------------------------- -->
+
"avisZusatz2": "",
−
<br>
+
"bestellNr": "",
−
<!-- ------------------------------------------------------------------------------- Beispiel ------------------------------------------------------------------------------- -->
+
"druckername": "",
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"email": "",
−
<div style="font-weight:bold;line-height:1.6;">Beispiele</div>
+
"faxNr": "",
−
<div class="mw-collapsible-content">
+
"frachtBrief": "",
−
;Request
+
"frachtfuehrerKdNr": "",
−
<source lang="json">
+
"frankaturKennung": "",
−
{
+
"gefahrgut": [
−
"ansprechpartner": "",
 
−
"assoc": {
 
−
"":""
 
−
},
 
−
"artikelDaten": [
 
 
{
 
{
−
"anzahlBuegel": 0,
+
"gefahrgutBefoerdKat": 0,
−
"anzahlPosEtiketten": 0,
+
"gefahrgutBegrenzteMenge": "",
−
"artikelBTNNr": "",
+
"gefahrgutBezeichnung": "",
−
"artikelEAN": "",
+
"gefahrgutBuchst640": "",
−
"artikelEinheit": "",
+
"gefahrgutFFCode": "",
−
"artikelGewicht": 0,
+
"gefahrgutFaktor": 0,
−
"artikelGruppe": "",
+
"gefahrgutFreigestMenge": "",
−
"artikelMenge": 0,
+
"gefahrgutKCode": "",
−
"artikelServices": "",
+
"gefahrgutKlasse": "",
−
"artikelSollMenge": 0,
+
"gefahrgutMenge": 0,
−
"artikelText1": "",
+
"gefahrgutMengenEinheit": "",
−
"artikelText2": "",
+
"gefahrgutNebenGefahr": "",
−
"artikelText3": "",
+
"gefahrgutNettoExplMasse": 0,
−
"artikelText4": "",
+
"gefahrgutTunnelBCode": "",
−
"artikelVolumen": 0,
+
"gefahrgutUNNR": "",
−
"artikelWaehrung": "",
+
"gefahrgutUmweltGef": "",
−
"artikelWert": 0,
+
"gefahrgutVPG": "",
−
"chargeFlag": "",
+
"gefahrgutVerpAnzahl": 0,
−
"kundenArtikelNr": "",
+
"gefahrgutVerpackungsart": ""
−
"kundenBestellNr": "",
 
−
"posAuftragNr": "",
 
−
"posLieferNr": "",
 
−
"positionNr": "",
 
−
"serienNr": "",
 
−
"ursprungLand": ""
 
 
}
 
}
 
],
 
],
−
"auftragNr": "",
+
"gewicht": 0,
−
"auftraggeberID": "",
+
"ilnNr": "",
−
"avisHinweis1": "",
+
"infotext1": "",
−
"avisHinweis2": "",
+
"infotext2": "",
−
"avisZusatz1": "",
+
"infotext3": "",
−
"avisZusatz2": "",
+
"infotext4": "",
−
"bestellNr": "",
+
"infotext5": "",
−
"druckername": "",
+
"infotext6": "",
−
"email": "",
+
"infotext7": "",
−
"faxNr": "",
+
"infotext8": "",
−
"frachtBrief": "",
+
"infotext9": "",
−
"frachtfuehrerKdNr": "",
+
"infotext10": "",
−
"frankaturKennung": "",
+
"kostenstelle": "",
−
"gefahrgut": [
+
"kundenNr": "",
−
{
+
"lieferscheinNr": "",
−
"gefahrgutBefoerdKat": 0,
+
"nachnahme": 0,
−
"gefahrgutBegrenzteMenge": "",
+
"nettoGewicht": 0,
−
"gefahrgutBezeichnung": "",
+
"neutabsenderLKZ": "",
−
"gefahrgutBuchst640": "",
+
"neutabsenderName1": "",
−
"gefahrgutFFCode": "",
+
"neutabsenderName2": "",
−
"gefahrgutFaktor": 0,
+
"neutabsenderName3": "",
−
"gefahrgutFreigestMenge": "",
+
"neutabsenderOrt": "",
−
"gefahrgutKCode": "",
+
"neutabsenderPLZ": "",
−
"gefahrgutKlasse": "",
+
"neutabsenderStrasse": "",
−
"gefahrgutMenge": 0,
+
"nnVermerk": "",
−
"gefahrgutMengenEinheit": "",
+
"nnVerwendung": "",
−
"gefahrgutNebenGefahr": "",
+
"nnWaehrung": "",
−
"gefahrgutNettoExplMasse": 0,
+
"packStkGes": 0,
−
"gefahrgutTunnelBCode": "",
+
"packStkNr": 0,
−
"gefahrgutUNNR": "",
+
"packplatz": "",
−
"gefahrgutUmweltGef": "",
+
"packstueckBreite": 0,
−
"gefahrgutVPG": "",
+
"packstueckHoehe": 0,
−
"gefahrgutVerpAnzahl": 0,
+
"packstueckID": "",
−
"gefahrgutVerpackungsart": ""
+
"packstueckLaenge": 0,
−
}
+
"paperlessInvoice": "",
−
],
+
"postLeitcode": "",
−
"gewicht": 0,
+
"postZielFrachtzent": "",
−
"ilnNr": "",
+
"rechnungsEmpfLKZ": "",
−
"infotext1": "",
+
"rechnungsEmpfName1": "",
−
"infotext2": "",
+
"rechnungsEmpfName2": "",
−
"infotext3": "",
+
"rechnungsEmpfName3": "",
−
"infotext4": "",
+
"rechnungsEmpfOrt": "",
−
"infotext5": "",
+
"rechnungsEmpfPLZ": "",
−
"infotext6": "",
+
"rechnungsEmpfStrasse": "",
−
"infotext7": "",
+
"sendungsinhalt": "",
−
"infotext8": "",
+
"sonderdienste": "",
−
"infotext9": "",
+
"telefonNr": "",
−
"infotext10": "",
+
"terminArt": "",
−
"kostenstelle": "",
+
"terminDatum": "",
−
"kundenNr": "",
+
"terminZeit": "",
−
"lieferscheinNr": "",
+
"ustIDNr": "",
−
"nachnahme": 0,
+
"verpackungsart": "",
−
"nettoGewicht": 0,
+
"versandartID": "",
−
"neutabsenderLKZ": "",
+
"versicherungswert": 0,
−
"neutabsenderName1": "",
+
"vwWaehrung": "",
−
"neutabsenderName2": "",
+
"warenwert": 0,
−
"neutabsenderName3": "",
+
"wwWaehrung": "",
−
"neutabsenderOrt": "",
+
"zahlungsbedingung": "",
−
"neutabsenderPLZ": "",
+
"zbZoll": "",
−
"neutabsenderStrasse": "",
+
"zielAdrBahnhof": "",
−
"nnVermerk": "",
+
"zielAdrLKZ": "",
−
"nnVerwendung": "",
+
"zielAdrName1": "",
−
"nnWaehrung": "",
+
"zielAdrName2": "",
−
"packStkGes": 0,
+
"zielAdrName3": "",
−
"packStkNr": 0,
+
"zielAdrOrt": "",
−
"packplatz": "",
+
"zielAdrPLZ": "",
−
"packstueckBreite": 0,
+
"zielAdrRegion": "",
−
"packstueckHoehe": 0,
+
"zielAdrStrasse": ""
−
"packstueckID": "",
+
}
−
"packstueckLaenge": 0,
+
</source>
−
"paperlessInvoice": "",
+
;Response
−
"postLeitcode": "",
+
<source lang="json">
−
"postZielFrachtzent": "",
+
{
−
"rechnungsEmpfLKZ": "",
+
"druckDateTime": "",
−
"rechnungsEmpfName1": "",
+
"fehlertext1": "",
−
"rechnungsEmpfName2": "",
+
"fehlertext2": ""
−
"rechnungsEmpfName3": "",
+
}
−
"rechnungsEmpfOrt": "",
+
</source>
−
"rechnungsEmpfPLZ": "",
+
</div></div>
−
"rechnungsEmpfStrasse": "",
+
<!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
−
"sendungsinhalt": "",
+
<!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- -->
−
"sonderdienste": "",
+
 
−
"telefonNr": "",
+
== Packstückdaten aktualisieren ==
−
"terminArt": "",
+
<!--
−
"terminDatum": "",
+
Text anpassen
−
"terminZeit": "",
+
<br>
−
"ustIDNr": "",
+
<br>
−
"verpackungsart": "",
+
<br>
−
"versandartID": "",
+
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
"versicherungswert": 0,
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
−
"vwWaehrung": "",
+
<div class="mw-collapsible-content">
−
"warenwert": 0,
+
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
−
"wwWaehrung": "",
+
{| class="wikitable sortable"
−
"zahlungsbedingung": "",
+
|-
−
"zbZoll": "",
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
−
"zielAdrBahnhof": "",
+
|-
−
"zielAdrLKZ": "",
+
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
−
"zielAdrName1": "",
+
|-
−
"zielAdrName2": "",
+
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
−
"zielAdrName3": "",
+
|-
−
"zielAdrOrt": "",
+
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
−
"zielAdrPLZ": "",
+
|-
−
"zielAdrRegion": "",
+
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
−
"zielAdrStrasse": ""
+
|-
−
}
+
| auftragNr || [[#Datentypen|String]] || 20 || - || -
−
</source>
+
|-
−
;Response
+
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
−
<source lang="json">
+
|-
−
{
+
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
−
"assoc": {
+
|-
−
"":""
+
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
−
},
+
|-
−
"packstueckID": "",
+
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
−
"trackingNr": "",
+
|-
−
"retourTrackingNr": "",
+
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
−
"versandSendungsNr": "",
+
|-
−
"druckDateTime": "",
+
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
−
"ausgangDateTime": "",
+
|-
−
"gebuehr": 0,
+
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
−
"gebuehrWaehrung": "",
+
|-
−
"fehlertext1": "",
+
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
−
"fehlertext2": "",
+
|-
−
"etikettName": "",
+
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
−
"etikettDaten": "",
+
|-
−
"zusatzEtikettenDaten": {
+
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
−
"": ""
+
|-
−
},
+
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
−
"trackingURL": "",
+
|-
−
"zusatzfeld1": "",
+
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
−
"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>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/versanddatenNachdruckAnfrage'''<br>
 
−
'''MediaType: text/plain'''<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
+
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird.
+
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
 
|-
 
|-
−
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
 
|-
 
|-
−
| '''packstueckID''' || [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
 
|-
 
|-
−
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
+
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
−
|}
 
−
</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|
+
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
 
|-
 
|-
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
 
|-
 
|-
−
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
+
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
 
|-
 
|-
−
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
+
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
|-
 
|-
−
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
+
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
+
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
+
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
+
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
+
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
+
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
+
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
+
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
+
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
 
|-
 
|-
−
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
+
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
+
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
+
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
 
|-
 
|-
−
| versandSendungsNr || [[#Datentypen|String]] || - || - || -
+
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
 
|-
 
|-
−
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
+
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
 
|-
 
|-
−
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
 
|-
 
|-
−
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
 
|-
 
|-
−
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
 
|-
 
|-
−
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| 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
 +
|-
 +
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 +
|-
 +
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
+
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
−
|}
+
|-
−
</div></div>
+
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
−
<br>
+
|-
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
−
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
+
|-
−
<div class="mw-collapsible-content">
+
| packStkGes || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
−
;Request
+
|-
−
<source lang="json">
+
| packStkNr || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
−
{
+
|-
−
"druckername": "",
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
−
"packplatz": "",
+
|-
−
"packstueckID": "",
+
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
−
"trackingNr": ""
+
|-
−
}
+
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
−
</source>
+
|-
−
;Response
+
| '''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.
−
<source lang="json">
+
|-
−
{
+
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
−
"assoc": {
+
|-
−
"":""
+
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
−
},
+
|-
−
"packstueckID": "",
+
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
−
"trackingNr": "",
+
|-
−
"retourTrackingNr": "",
+
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
−
"versandSendungsNr": "",
+
|-
−
"druckDateTime": "",
+
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
−
"ausgangDateTime": "",
+
|-
−
"gebuehr": 0,
+
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
−
"gebuehrWaehrung": "",
+
|-
−
"fehlertext1": "",
+
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
−
"fehlertext2": "",
+
|-
−
"etikettName": "",
+
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
−
"etikettDaten": "",
+
|-
−
"zusatzEtikettenDaten": {
+
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
−
"": ""
+
|-
−
},
+
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
−
"trackingURL": "",
 
−
"zusatzfeld1": "",
 
−
"zusatzfeld2": "",
 
−
"zusatzfeld3": "",
 
−
"zusatzfeld4": "",
 
−
"zusatzfeld5": "",
 
−
"zusatzfeld6": "",
 
−
"zusatzfeld7": "",
 
−
"zusatzfeld8": "",
 
−
"zusatzfeld9": "",
 
−
"zusatzfeld10": ""
 
−
}
 
−
</source>
 
−
</div></div>
 
−
<!-- ------------------------------------------------------------------------------- ENDE versanddatenNachdruckAnfrage ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- stornoVersanddaten ------------------------------------------------------------------------------- -->
 
−
 
 
−
== 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.
 
−
<br>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/stornoVersanddaten'''<br>
 
−
'''MediaType: text/plain'''<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
+
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
|-
 
|-
−
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
|-
 
|-
−
| '''packstueckID'''|| [[#Datentypen|String]] || 30 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| trackingNr|| [[#Datentypen|String]] || 35 || - || Paketnummer
+
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
−
|}
+
|-
−
</div></div>
+
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
−
<br>
+
|-
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
−
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
+
|-
−
<div class="mw-collapsible-content">
+
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
−
{| class="wikitable sortable"
+
|-
 +
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 +
|-
 +
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
−
|}
 
−
</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">
 
−
{
 
−
"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>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/verladeVersanddaten'''<br>
 
−
'''MediaType: text/plain'''<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
+
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| hostFreigabeNr || [[#Datentypen|String]] || 20 || - || Hostseitige Freigabenummer die für dieses Packstück gesetzt wird.
+
| vwWaehrung || [[#Datentypen|String]] || 3 || - || Versicherungswert - ISO-Währungscode
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| warenwert || [[#Datentypen|Decimal]] || 18 || 2 || -
 
|-
 
|-
−
| '''packstueckID''' || [[#Datentypen|String]] || 20 || - || Eindeutige Nummer für das Paket im Vorsystem. <br>
+
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen wird
−
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.
+
| wwWaehrung || [[#Datentypen|String]] || 3 || - || Warenwert - ISO-Währungscode
 +
|-
 +
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || '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
 +
|-
 +
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
 +
|-
 +
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 +
|-
 +
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 +
|-
 +
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 +
|-
 +
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 +
|-
 +
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 +
|-
 +
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
 +
|-
 +
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
 +
|-
 +
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|}
 
|}
 
</div></div>
 
</div></div>
Zeile 976: Zeile 858:
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung|
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| ausgangDateTime || [[#Datentypen|Calendar]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| ausgangDateTimeString || [[#Datentypen|String]] || 10 || - || Datum, wann das Etikett an den Frachtführer übermittelt worden ist (TT.MM.JJJJ)
−
|}
+
|-
−
</div></div>
+
| druckDateTime || [[#Datentypen|Calendar]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
−
<br>
+
|-
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
| druckDateTimeString || [[#Datentypen|String]] || 19 || - || Datum, wann das Etikett im HVS32 gedruckt worden ist (TT.MM.JJJJ HH:mm:SS)
−
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
+
|-
−
<div class="mw-collapsible-content">
+
| etikettDaten || [[#Datentypen|String]] || - || - || Binärdaten des Etiketts
−
;Request
+
|-
−
<source lang="json">
+
| etikettName || [[#Datentypen|String]] || - || - || Vorlagenname des Etiketts
−
{
+
|-
−
"hostFreigabeNr": "",
+
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 wenn Erfolgreich
−
"packplatz": "",
+
|-
−
"packstueckID": "",
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
"wechselbruecke": ""
+
|-
−
}
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
</source>
+
|-
−
;Response
+
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
−
<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>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/sperreVersanddaten'''<br>
 
−
'''MediaType: text/plain'''<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
+
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
 
|-
 
|-
−
| packplatz|| [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
+
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
 
|-
 
|-
−
| '''packstueckID'''|| [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
+
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
−
|}
 
−
</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
+
| 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
 
|-
 
|-
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
 
|}
 
|}
 
</div></div>
 
</div></div>
Zeile 1.052: Zeile 924:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
"packplatz": "",
+
"ansprechpartner": "",
−
"packstueckID": ""
+
"anzahlArtikel": 0,
−
}
+
"artikelDaten": [
−
</source>
+
{
−
;Response
+
"anzahlBuegel": 0,
−
<source lang="json">
+
"anzahlPosEtiketten": 0,
−
{
+
"artikelBTNNr": "",
−
"fehlercode": 0,
+
"artikelEAN": "",
−
"fehlertext1": "",
+
"artikelEinheit": "",
−
"fehlertext2": ""
+
"artikelGewicht": 0,
−
}
+
"artikelGruppe": "",
−
</source>
+
"artikelMenge": 0,
−
</div></div>
+
"artikelServices": "",
−
<!-- ------------------------------------------------------------------------------- ENDE sperreversanddaten ------------------------------------------------------------------------------- -->
+
"artikelSollMenge": 0,
−
<!-- ------------------------------------------------------------------------------- tagesabschluss ------------------------------------------------------------------------------- -->
+
"artikelText1": "",
−
 
+
"artikelText2": "",
−
== Tagesabschluss (tagesabschluss) ==
+
"artikelText3": "",
−
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.
+
"artikelText4": "",
−
<br>
+
"artikelVolumen": 0,
−
<br>
+
"artikelWaehrung": "",
−
'''Funktion (POST): /hvs32rest/tagesabschluss'''<br>
+
"artikelWert": 0,
−
'''MediaType: text/plain'''<br>
+
"chargeFlag": "",
−
<br>
+
"kundenArtikelNr": "",
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"kundenBestellNr": "",
−
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
+
"posAuftragNr": "",
−
<div class="mw-collapsible-content">
+
"posLieferNr": "",
−
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
+
"positionNr": "",
−
{| class="wikitable sortable"
+
"serienNr": "",
−
|-
+
"ursprungLand": ""
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
}
−
|-
+
],
−
| auftraggeberID || [[#Datentypen|Sequence<String>]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
"auftragNr": "",
−
Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br>
+
"auftraggeberID": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"avisHinweis1": "",
−
|-
+
"avisHinweis2": "",
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
+
"avisZusatz1": "",
−
(Benötigt Druckerspooler Erweiterungsmodul)
+
"avisZusatz2": "",
−
|-
+
"barcodeID": "",
−
| frachtfuehrerTyp || [[#Datentypen|Sequence<String>]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
+
"barcodeText": "",
−
Wenn leer, werden alle Frachtführer abgeschlossen.<br>
+
"barcodeTyp": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"bestellNr": "",
−
|-
+
"druckername": "",
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
+
"email": "",
−
|-
+
"empfMobilfunkNr": "",
−
| versandartID || [[#Datentypen|Sequence<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
+
"faxNr": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"flexZustellungEmailadResponsese": "",
−
|-
+
"frachtBrief": "",
−
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
+
"frachtfuehrerKdNr": "",
−
|}
+
"frankaturKennung": "",
−
</div></div>
+
"gefahrgut": [
−
<br>
+
{
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"gefahrgutBefoerdKat": 0,
−
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
+
"gefahrgutBegrenzteMenge": "",
−
<div class="mw-collapsible-content">
+
"gefahrgutBezeichnung": "",
−
{| class="wikitable sortable"
+
"gefahrgutBuchst640": "",
−
|-
+
"gefahrgutFFCode": "",
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
"gefahrgutFaktor": 0,
−
|-
+
"gefahrgutFreigestMenge": "",
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
"gefahrgutKCode": "",
−
|-
+
"gefahrgutKlasse": "",
−
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] '''[[#Sequence|<EDIStatus>]]''' || - || - || -
+
"gefahrgutMenge": 0,
−
|-
+
"gefahrgutMengenEinheit": "",
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
"gefahrgutNebenGefahr": "",
−
|-
+
"gefahrgutNettoExplMasse": 0,
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
"gefahrgutTunnelBCode": "",
−
|-
+
"gefahrgutUNNR": "",
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
"gefahrgutUmweltGef": "",
−
|-
+
"gefahrgutVPG": "",
−
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
+
"gefahrgutVerpAnzahl": 0,
−
|-
+
"gefahrgutVerpackungsart": ""
−
| 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">
 
−
{
 
−
"auftraggeberID": [
 
−
""
 
 
],
 
],
−
"druckername": "",
+
"gewicht": 0,
−
"frachtfuehrerTyp": [
+
"hostTrackingNr": "",
−
""
+
"ilnNr": "",
−
],
+
"infotext1": "",
−
"packplatz": "",
+
"infotext2": "",
−
"versandartID": [
+
"infotext3": "",
−
""
+
"infotext4": "",
−
],
+
"infotext5": "",
−
"wechselbruecke": ""
+
"infotext6": "",
−
}
+
"infotext7": "",
−
</source>
+
"infotext8": "",
−
;Response
+
"infotext9": "",
−
<source lang="json">
+
"infotext10": "",
−
{
+
"kostenstelle": "",
−
"assoc": {
+
"kundenNr": "",
−
"":""
+
"lagerkennzeichen": 0,
−
},
+
"letztesPackstueck": "",
−
"fehlercode": 0,
+
"lieferantenID": 0,
−
"fehlertext1": "",
+
"lieferscheinNr": "",
−
"edistatus": [
+
"nachnahme": 0,
−
{
+
"nettoGewicht": 0,
−
"fehlercode": 0,
+
"neutBIC": "",
−
"statuscode": "",
+
"neutBankBezeichnung": "",
−
"statustext": "",
+
"neutIBAN": "",
−
"fftyp": "",
+
"neutKontoInhaber": "",
−
"dateityp": "",
+
"neutabsenderLKZ": "",
−
"auftraggeber": "",
+
"neutabsenderName1": "",
−
"ffdateinr": ""
+
"neutabsenderName2": "",
−
}
+
"neutabsenderName3": "",
−
],
+
"neutabsenderOrt": "",
−
"listenDaten": {}
+
"neutabsenderPLZ": "",
−
}
+
"neutabsenderStrasse": "",
−
</source>
+
"nnVermerk": "",
−
</div></div>
+
"nnVerwendung": "",
−
<!-- ------------------------------------------------------------------------------- ENDE tagesabschluss ------------------------------------------------------------------------------- -->
+
"nnWaehrung": "",
−
<!-- ------------------------------------------------------------------------------- listenabschlussAnfrage ------------------------------------------------------------------------------- -->
+
"packStkGes": 0,
−
 
+
"packStkNr": 0,
−
== Ausgangsliste erzeugen (listenabschlussAnfrage) ==
+
"packplatz": "",
−
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.
+
"packstueckBreite": 0,
−
<br>
+
"packstueckHoehe": 0,
−
<br>
+
"packstueckID": "",
−
'''Funktion (POST): /hvs32rest/listenabschlussAnfrage'''<br>
+
"packstueckLaenge": 0,
−
'''MediaType: text/plain'''<br>
+
"paperlessInvoice": "",
−
<br>
+
"postLeitcode": "",
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"postZielFrachtzent": "",
−
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
+
"rechnungsEmpfLKZ": "",
−
<div class="mw-collapsible-content">
+
"rechnungsEmpfName1": "",
−
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
+
"rechnungsEmpfName2": "",
−
{| class="wikitable sortable"
+
"rechnungsEmpfName3": "",
−
|-
+
"rechnungsEmpfOrt": "",
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
"rechnungsEmpfPLZ": "",
−
|-
+
"rechnungsEmpfStrasse": "",
−
| auftraggeberID || [[#Datentypen|String]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
"rechnungsNr": "",
−
Wenn leer, werden alle Auftraggeber abgeschlossen, welche am betreffenden Packplatz freigegeben sind.<br>
+
"sendungsinhalt": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiAGTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"sonderdienste": "",
−
|-
+
"sperrFlag": "",
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den die Listen gedruckt werden sollen.
+
"telefonNr": "",
−
(Benötigt Druckerspooler Erweiterungsmodul)
+
"terminArt": "",
−
|-
+
"terminDatum": "",
−
| frachtfuehrerTyp || [[#Datentypen|String]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".
+
"terminZeit": "",
−
Wenn leer, werden alle Frachtführer abgeschlossen.<br>
+
"ustIDNr": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiFFTagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"verpackungsart": "",
−
|-
+
"versandartID": "",
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Listenabschluss ausführen soll.
+
"versicherungswert": 0,
−
|-
+
"vorpackdatum": "",
−
| versandartID || [[#Datentypen|String]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.
+
"vwWaehrung": "",
−
Bei Nutzung muss zusätzlich der HVS32-Schalter 'MultiVATagesabschluss' in der Sektion 'AutomatikPolling' auf 'ON' gesetzt sein.
+
"warenwert": 0,
−
|-
+
"wechselbruecke": "",
−
| wechselbruecke|| [[#Datentypen|String]] || 10 || - || Kennzeichen der abzuschließenden Wechselbrücke. Hiermit können nur bestimmte Sendungen abgeschlossen werden.
+
"wwWaehrung": "",
−
|}
+
"zahlungsbedingung": "",
−
</div></div>
+
"zbZoll": "",
−
<br>
+
"zielAdrBahnhof": "",
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"zielAdrLKZ": "",
−
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
+
"zielAdrName1": "",
−
<div class="mw-collapsible-content">
+
"zielAdrName2": "",
−
{| class="wikitable sortable"
+
"zielAdrName3": "",
−
|-
+
"zielAdrName4": "",
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
"zielAdrOrt": "",
−
|-
+
"zielAdrPLZ": "",
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
"zielAdrRegion": "",
−
|-
+
"zielAdrStrasse": ""
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
+
}
−
|-
+
</source>
−
| fehlertext1 || [[#Datentypen|String]] || 200 || - || -
+
;Response
−
|-
+
<source lang="json">
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
{
−
|-
+
"packstueckID": "",
−
| listenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Listen als Key/Value Map.
+
"trackingNr": "",
−
|-
+
"retourTrackingNr": "",
−
| etikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Etiketten als Key/Value Map.
+
"versandSendungsNr": "",
−
|}
+
"druckDateTime": "",
 +
"ausgangDateTime": "",
 +
"gebuehrWaehrung": "",
 +
"fehlercode": 0,
 +
"fehlertext1": "",
 +
"fehlertext2": "",
 +
"etikettName": "",
 +
"etikettDaten": "",
 +
"trackingURL": "",
 +
"zusatzfeld1": "",
 +
"zusatzfeld2": "",
 +
"zusatzfeld3": "",
 +
"zusatzfeld4": "",
 +
"zusatzfeld5": "",
 +
"zusatzfeld6": "",
 +
"zusatzfeld7": "",
 +
"zusatzfeld8": "",
 +
"zusatzfeld9": "",
 +
"zusatzfeld10": ""
 +
}
 +
</source>
 
</div></div>
 
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
 +
 +
== Packstückdaten anonymisieren ==
 +
<!--
 +
Text anpassen
 +
<br>
 +
<br>
 
<br>
 
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
 
<div class="mw-collapsible-content">
 
<div class="mw-collapsible-content">
−
;Request
+
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
−
<source lang="json">
+
{| class="wikitable sortable"
−
{
+
|-
−
"auftraggeberID": [
+
! Feldname !! Typ !! Max Länge !! Nachkommastellen !! Belegung
−
""
+
|-
−
],
+
| auftragsNr || [[#Datentypen|String]] || 20 || - || -
−
"druckername": "",
+
|-
−
"frachtfuehrerTyp": [
+
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
−
""
+
|-
−
],
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeiten soll.
−
"packplatz": "",
+
|-
−
"versandartID": [
+
| packstueckID || [[#Datentypen|String]] || 20 || - || '''Eindeutige''' Nummer für das Paket im Vorsystem.
−
""
+
|-
−
],
+
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
−
"wechselbruecke": ""
+
|}
−
}
 
−
</source>
 
−
;Response
 
−
<source lang="json">
 
−
{
 
−
"assoc": {
 
−
"":""
 
−
},
 
−
"fehlercode": 0,
 
−
"fehlertext1": "",
 
−
"listenDaten": {
 
−
"": ""
 
−
}
 
−
}
 
−
</source>
 
 
</div></div>
 
</div></div>
−
<!-- ------------------------------------------------------------------------------- ENDE Listenabschluss ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->
 
−
 
−
== 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.
 
−
<br>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/ediabschlussAnfrage'''<br>
 
−
'''MediaType: text/plain'''<br>
 
 
<br>
 
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
−
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
+
<div style="font-weight:bold;line-height:1.6;">'''Rückgabe Parameter'''</div>
 
<div class="mw-collapsible-content">
 
<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 !! Nachkommastellen !! Belegung
 
|-
 
|-
−
| auftraggeberID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Auftraggeber für die der Tagesabschluss durchgeführt wird.<br>
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
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>
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
(Benötigt Druckerspooler Erweiterungsmodul)
 
−
|-
 
−
| frachtfuehrerTyp || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste mit Name des Frachtführertyps. Z.B.: "DPD", "GLS", etc. oder "ALLE".<br>
 
−
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.
 
−
|-
 
−
| versandartID || [[#Datentypen|Sequence]] [[#Datentypen|<String>]] || 255 || - || Liste der Versandarten für die ein Tagesabschluss durchgeführt wird.<br>
 
−
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.
 
−
|}
 
−
</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)
 
−
|-
 
−
| [[#edistatus|edistatus]] || [[#Datentypen|Sequence]] [[#edistatus|<EDIStatus>]] || - || - || Liste mit Statusinformationen für EDIs.
 
−
|-
 
−
| fehlercode || [[#Datentypen|Integer]] || - || - || 0 = Erfolgreich
 
−
|-
 
−
| 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.
 
 
|}
 
|}
 
</div></div>
 
</div></div>
Zeile 1.325: Zeile 1.156:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
"auftraggeberID": [
+
"auftragNr": "",
−
""
+
"lieferscheinNr": "",
−
],
 
−
"druckername": "",
 
−
"frachtfuehrerTyp": [
 
−
""
 
−
],
 
 
"packplatz": "",
 
"packplatz": "",
−
"versandartID": [
+
"packstueckID": "",
−
""
+
"trackingNr": ""
−
],
 
−
"wechselbruecke": ""
 
 
}
 
}
 
</source>
 
</source>
Zeile 1.342: Zeile 1.166:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
"assoc": {
 
−
"":""
 
−
},
 
−
"fehlercode": 0,
 
 
"fehlertext1": "",
 
"fehlertext1": "",
−
"edistatus": [
+
"fehlertext2": ""
−
{
+
}
−
"fehlercode": 0,
+
</source>
−
"statuscode": "",
+
</div></div>
−
"statustext": "",
+
<!-- ------------------------------------------------------------------------------- ENDE anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
−
"fftyp": "",
+
<!-- ------------------------------------------------------------------------------- sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
−
"dateityp": "",
 
−
"auftraggeber": "",
 
−
"ffdateinr": ""
 
−
}
 
−
],
 
−
"listenDaten": {}
 
−
}
 
−
</source>
 
−
</div></div>
 
−
<!-- ------------------------------------------------------------------------------- ENDE ediabschlussAnfrage ------------------------------------------------------------------------------- -->
 
−
<!-- ------------------------------------------------------------------------------- versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
 
  
−
== Packstückdaten aktualisieren (versanddatenPruefAnfrage) ==
+
== Sendungs-Verarbeitung ==
−
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.
+
<!--
 +
Text anpassen
 
<br>
 
<br>
 
<br>
 
<br>
−
'''Funktion (POST): /hvs32rest/versanddatenPruefAnfrage'''<br>
 
−
'''MediaType: text/plain'''<br>
 
 
<br>
 
<br>
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
Zeile 1.381: Zeile 1.189:
 
|-
 
|-
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
 
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
−
|-
 
−
| [[#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 1.390: Zeile 1.196:
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
 
|-
 
|-
−
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+
| ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Ausschluss-Frachtführer für SPM Anfrage
 +
|-
 +
| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 
|-
 
|-
−
| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+
| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 
|-
 
|-
 
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
 
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
Zeile 1.398: Zeile 1.206:
 
| 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 || - || Metro-Bestellnr (Metro-Versand)
+
| bestellNr || [[#Datentypen|String]] || 20 || - || -
 
|-
 
|-
−
| 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
 
|-
 
|-
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
|-
 
|-
−
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
+
| flexZustellungEmailadResponsese || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Email-Adresse
 
|-
 
|-
−
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
+
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
 
|-
 
|-
−
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
+
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer.
 
|-
 
|-
 
| 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)
+
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
|-
 
|-
−
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
+
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
+
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
|-
 
|-
−
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
 
 
|-
 
|-
−
| 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
 
|-
 
|-
−
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
+
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
+
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| lieferscheinNr || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
+
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
|-
 
|-
−
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
+
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
|-
 
|-
−
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
+
| [[#packstueckDaten|packstueckDaten]] || [[#Datentypen|Sequence]] [[#packstueckDaten|<PackStueckDaten>]] || - || - || -
 
|-
 
|-
−
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
+
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 
|-
 
|-
−
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
 
|-
 
|-
−
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
 
|-
 
|-
−
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
 
|-
 
|-
−
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
 
|-
 
|-
−
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
+
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| nnVermerk || [[#Datentypen|String]] || 1 || - || B': Bar / 'V': Verrechnungsscheck
+
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
|-
 
|-
−
| nnVerwendung || [[#Datentypen|String]] || 30 || - || Nachnahme Verwendungszweck
+
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
|-
 
|-
−
| nnWaehrung || [[#Datentypen|String]] || 3 || - || Nachnahme - ISO-Währungscode
+
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
 
|-
 
|-
−
| packStkGes || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
+
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
|-
 
|-
−
| packStkNr || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
+
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
|-
 
|-
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
+
| requestSPM || [[#Datentypen|String]] || 5 || - || T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
 
|-
 
|-
−
| packstueckBreite || [[#Datentypen|Integer]] || - || - || Breite in cm
+
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
|-
 
|-
−
| packstueckHoehe || [[#Datentypen|Integer]] || - || - || Höhe in cm
+
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
 
|-
 
|-
−
| 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.
+
| sperrFlag || [[#Datentypen|String]] || 1 || - || T/F: T=Sperren, sonst nicht sperren
 
|-
 
|-
−
| packstueckLaenge || [[#Datentypen|Integer]] || - || - || Länge in cm
+
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
 
|-
 
|-
−
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
+
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
 
|-
 
|-
−
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
+
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
+
| terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM
 
|-
 
|-
−
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
+
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
|-
 
|-
−
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
+
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
|-
 
|-
−
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
+
| vorgabeFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Vorgabe-Frachtführer für [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] Anfrage
 
|-
 
|-
−
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
+
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
|-
 
|-
−
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
+
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen werden soll
 
|-
 
|-
−
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
+
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || 'S' = Sender, 'R' = Empfänger
 
|-
 
|-
−
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
+
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
 
|-
 
|-
−
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
+
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort des Bahnhofs
 
|-
 
|-
−
| sonderdienste || [[#Datentypen|String]] || 30 || - || Versandart-spezifisch belegt
+
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ)
 
|-
 
|-
−
| telefonNr || [[#Datentypen|String]] || 20 || - || Telefonnummer des Empfängers
+
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
|-
 
|-
−
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
+
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
−
|-
 
−
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
−
|-
 
−
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
 
−
|-
 
−
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
−
|-
 
−
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
 
−
|-
 
−
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
−
|-
 
−
| 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
 
−
|-
 
−
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || '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
 
−
|-
 
−
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
 
|-
 
|-
 
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
Zeile 1.561: Zeile 1.339:
 
{| 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
 +
|-
 +
| 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|
 +
|-
 +
| 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.567: Zeile 1.365:
 
| 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
 
|-
 
|-
−
| fehlertext2 || [[#Datentypen|String]] || 200 || - || -
+
| fehlertext1 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
|}
+
|-
−
</div></div>
+
| fehlertext2 || [[#Datentypen|String]] || 200 || - || Wird im Fehlerfall befüllt
−
<br>
+
|-
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
| gebuehr || [[#Datentypen|Decimal]] || 18 || 2 || Frachtkosten
−
<div style="font-weight:bold;line-height:1.6;">'''Beispiele'''</div>
+
|-
−
<div class="mw-collapsible-content">
+
| gebuehrWaehrung || [[#Datentypen|String]] || 3 || - || Frachkosten ISO-Währungscode
−
;Request
+
|-
−
<source lang="json">
+
| packstueckID || [[#Datentypen|String]] || 20 || - || PackstueckID aus der Anfrage
−
{
+
|-
−
"ansprechpartner": "",
+
| retourTrackingNr || [[#Datentypen|String]] || 50 || - || Paketnummer für die Retoure
−
"artikelDaten": [
+
|-
−
{
+
| trackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer
−
"anzahlBuegel": 0,
+
|-
−
"anzahlPosEtiketten": 0,
+
| trackingURL || [[#Datentypen|String]] || 255 || - || URL des Trackinglinks zur Sendungsverfolgung
−
"artikelBTNNr": "",
+
|-
−
"artikelEAN": "",
+
| zusatzEtikettenDaten || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Name und Binärdaten der Zusatzetiketten als Key/Value Map
−
"artikelEinheit": "",
+
|-
−
"artikelGewicht": 0,
+
| zusatzfeld1 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelGruppe": "",
+
|-
−
"artikelMenge": 0,
+
| zusatzfeld2 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelServices": "",
+
|-
−
"artikelSollMenge": 0,
+
| zusatzfeld3 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelText1": "",
+
|-
−
"artikelText2": "",
+
| zusatzfeld4 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelText3": "",
+
|-
−
"artikelText4": "",
+
| zusatzfeld5 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelVolumen": 0,
+
|-
−
"artikelWaehrung": "",
+
| zusatzfeld6 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"artikelWert": 0,
+
|-
−
"chargeFlag": "",
+
| zusatzfeld7 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"kundenArtikelNr": "",
+
|-
−
"kundenBestellNr": "",
+
| zusatzfeld8 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"posAuftragNr": "",
+
|-
−
"posLieferNr": "",
+
| zusatzfeld9 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"positionNr": "",
+
|-
−
"serienNr": "",
+
| zusatzfeld10 || [[#Datentypen|String]] || 200 || - || Zusatzfeld – kann optional im HVS32 gemapped werden um zusätzliche Informationen zurück zu melden
−
"ursprungLand": ""
+
|}
−
}
+
</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": "",
 
"auftragNr": "",
 
"auftraggeberID": "",
 
"auftraggeberID": "",
 +
"ausschlussFrachtfuehrer": "",
 
"avisHinweis1": "",
 
"avisHinweis1": "",
 
"avisHinweis2": "",
 
"avisHinweis2": "",
Zeile 1.616: Zeile 1.429:
 
"avisZusatz2": "",
 
"avisZusatz2": "",
 
"bestellNr": "",
 
"bestellNr": "",
−
"druckername": "",
 
 
"email": "",
 
"email": "",
 +
"empfMobilfunkNr": "",
 
"faxNr": "",
 
"faxNr": "",
 +
"flexZustellungEmailadResponsese": "",
 
"frachtBrief": "",
 
"frachtBrief": "",
 
"frachtfuehrerKdNr": "",
 
"frachtfuehrerKdNr": "",
 
"frankaturKennung": "",
 
"frankaturKennung": "",
−
"gefahrgut": [
+
"ilnNr": "",
 +
"kostenstelle": "",
 +
"kundenNr": "",
 +
"Lagerkennzeichen": 0,
 +
"LieferantenID": 0,
 +
"lieferscheinNr": "",
 +
"neutBIC": "",
 +
"neutBankBezeichnung": "",
 +
"neutIBAN": "",
 +
"neutKontoInhaber": "",
 +
"neutabsenderLKZ": "",
 +
"neutabsenderName1": "",
 +
"neutabsenderName2": "",
 +
"neutabsenderName3": "",
 +
"neutabsenderOrt": "",
 +
"neutabsenderPLZ": "",
 +
"neutabsenderStrasse": "",
 +
"packStkGes": 0,
 +
"packStueckDaten": [
 
{
 
{
−
"gefahrgutBefoerdKat": 0,
+
"anzahlArtikel": 0,
−
"gefahrgutBegrenzteMenge": "",
+
"assoc": {
−
"gefahrgutBezeichnung": "",
+
"":""
−
"gefahrgutBuchst640": "",
+
},
−
"gefahrgutFFCode": "",
+
"artikelDaten": [
−
"gefahrgutFaktor": 0,
+
{
−
"gefahrgutFreigestMenge": "",
+
"anzahlBuegel": 0,
−
"gefahrgutKCode": "",
+
"anzahlPosEtiketten": 0,
−
"gefahrgutKlasse": "",
+
"artikelBTNNr": "",
−
"gefahrgutMenge": 0,
+
"artikelEAN": "",
−
"gefahrgutMengenEinheit": "",
+
"artikelEinheit": "",
−
"gefahrgutNebenGefahr": "",
+
"artikelGewicht": 0,
−
"gefahrgutNettoExplMasse": 0,
+
"artikelGruppe": "",
−
"gefahrgutTunnelBCode": "",
+
"artikelMenge": 0,
−
"gefahrgutUNNR": "",
+
"artikelServices": "",
−
"gefahrgutUmweltGef": "",
+
"artikelSollMenge": 0,
−
"gefahrgutVPG": "",
+
"artikelText1": "",
−
"gefahrgutVerpAnzahl": 0,
+
"artikelText2": "",
−
"gefahrgutVerpackungsart": ""
+
"artikelText3": "",
−
}
+
"artikelText4": "",
−
],
+
"artikelVolumen": 0,
−
"gewicht": 0,
+
"artikelWaehrung": "",
−
"ilnNr": "",
+
"artikelWert": 0,
−
"infotext1": "",
+
"chargeFlag": "",
−
"infotext2": "",
+
"kundenArtikelNr": "",
−
"infotext3": "",
+
"kundenBestellNr": "",
−
"infotext4": "",
+
"posAuftragNr": "",
−
"infotext5": "",
+
"posLieferNr": "",
−
"infotext6": "",
+
"positionNr": "",
−
"infotext7": "",
+
"serienNr": "",
−
"infotext8": "",
+
"ursprungLand": ""
−
"infotext9": "",
+
}
−
"infotext10": "",
+
],
−
"kostenstelle": "",
+
"barcodeID": "",
−
"kundenNr": "",
+
"barcodeText": "",
−
"lieferscheinNr": "",
+
"barcodeTyp": "",
−
"nachnahme": 0,
+
"druckername": "",
−
"nettoGewicht": 0,
+
"gefahrgut": [
−
"neutabsenderLKZ": "",
+
{
−
"neutabsenderName1": "",
+
"gefahrgutBefoerdKat": 0,
−
"neutabsenderName2": "",
+
"gefahrgutBegrenzteMenge": "",
−
"neutabsenderName3": "",
+
"gefahrgutBezeichnung": "",
−
"neutabsenderOrt": "",
+
"gefahrgutBuchst640": "",
−
"neutabsenderPLZ": "",
+
"gefahrgutFFCode": "",
−
"neutabsenderStrasse": "",
+
"gefahrgutFaktor": 0,
−
"nnVermerk": "",
+
"gefahrgutFreigestMenge": "",
−
"nnVerwendung": "",
+
"gefahrgutKCode": "",
−
"nnWaehrung": "",
+
"gefahrgutKlasse": "",
−
"packStkGes": 0,
+
"gefahrgutMenge": 0,
−
"packStkNr": 0,
+
"gefahrgutMengenEinheit": "",
−
"packplatz": "",
+
"gefahrgutNebenGefahr": "",
−
"packstueckBreite": 0,
+
"gefahrgutNettoExplMasse": 0,
−
"packstueckHoehe": 0,
+
"gefahrgutTunnelBCode": "",
−
"packstueckID": "",
+
"gefahrgutUNNR": "",
−
"packstueckLaenge": 0,
+
"gefahrgutUmweltGef": "",
−
"paperlessInvoice": "",
+
"gefahrgutVPG": "",
−
"postLeitcode": "",
+
"gefahrgutVerpAnzahl": 0,
−
"postZielFrachtzent": "",
+
"gefahrgutVerpackungsart": ""
−
"rechnungsEmpfLKZ": "",
+
}
−
"rechnungsEmpfName1": "",
+
],
−
"rechnungsEmpfName2": "",
+
"gewicht": 0,
−
"rechnungsEmpfName3": "",
+
"hostTrackingNr": "",
−
"rechnungsEmpfOrt": "",
+
"infotext1": "",
−
"rechnungsEmpfPLZ": "",
+
"infotext10": "",
−
"rechnungsEmpfStrasse": "",
+
"infotext2": "",
−
"sendungsinhalt": "",
+
"infotext3": "",
−
"sonderdienste": "",
+
"infotext4": "",
−
"telefonNr": "",
+
"infotext5": "",
−
"terminArt": "",
+
"infotext6": "",
−
"terminDatum": "",
+
"infotext7": "",
−
"terminZeit": "",
+
"infotext8": "",
−
"ustIDNr": "",
+
"infotext9": "",
−
"verpackungsart": "",
+
"letztesPackstueck": "",
−
"versandartID": "",
+
"nachnahme": 0,
−
"versicherungswert": 0,
+
"nettoGewicht": 0,
−
"vwWaehrung": "",
+
"nnVermerk": "",
−
"warenwert": 0,
+
"nnVerwendung": "",
−
"wwWaehrung": "",
+
"nnWaehrung": "",
−
"zahlungsbedingung": "",
+
"packStkNr": 0,
−
"zbZoll": "",
+
"packstueckBreite": 0,
−
"zielAdrBahnhof": "",
+
"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": "",
 
"zielAdrLKZ": "",
 
"zielAdrName1": "",
 
"zielAdrName1": "",
 
"zielAdrName2": "",
 
"zielAdrName2": "",
 
"zielAdrName3": "",
 
"zielAdrName3": "",
 +
"zielAdrName4": "",
 
"zielAdrOrt": "",
 
"zielAdrOrt": "",
 
"zielAdrPLZ": "",
 
"zielAdrPLZ": "",
Zeile 1.718: Zeile 1.588:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
"druckDateTime": "",
+
"versandSendungsNr": "",
−
"fehlertext1": "",
+
"sendungsGebuehrWaehrung": "",
−
"fehlertext2": ""
+
"fehler": "",
−
}
+
"packStueckDaten": [
−
</source>
+
{
−
</div></div>
+
"assoc": {
−
<!-- ------------------------------------------------------------------------------- ENDE versanddatenPruefAnfrage ------------------------------------------------------------------------------- -->
+
"":""
−
<!-- ------------------------------------------------------------------------------- updateVersanddaten ------------------------------------------------------------------------------- -->
+
},
−
 
+
"packstueckID": "",
−
== Packstückdaten aktualisieren (updateVersanddaten) ==
+
"trackingNr": "",
−
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.
+
"retourTrackingNr": "",
−
<br>
+
"druckDateTime": "",
−
<br>
+
"gebuehrWaehrung": "",
−
'''Funktion (POST): /hvs32rest/updateVersanddaten'''<br>
+
"fehlertext1": "",
−
'''MediaType: text/plain'''<br>
+
"fehlertext2": "",
−
<br>
+
"etikettName": "",
−
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
+
"etikettDaten": "",
−
<div style="font-weight:bold;line-height:1.6;">'''Übergabe Parameter'''</div>
+
"zusatzEtikettenDaten": {
−
<div class="mw-collapsible-content">
+
"": ""
−
<small>'''Fett''' dargestellte Felder müssen IMMER belegt sein</small>
+
},
−
{| class="wikitable sortable"
+
"trackingURL": "",
−
|-
+
"zusatzfeld1": "",
−
! Feldname !! Typ !! Max Länge !! Dezimalstellen !! Belegung
+
"zusatzfeld2": "",
−
|-
+
"zusatzfeld3": "",
−
| ansprechpartner || [[#Datentypen|String]] || 20 || - || Empfänger Ansprechpartner
+
"zusatzfeld4": "",
−
|-
+
"zusatzfeld5": "",
−
| anzahlArtikel || [[#Datentypen|Integer]] || 6 || - || Anzahl Artikel (Druck auf Etikett)
+
"zusatzfeld6": "",
−
|-
+
"zusatzfeld7": "",
−
| [[#artikelDaten|artikelDaten]] || [[#Datentypen|Sequence]] '''[[#artikelDaten|<ArtikelDaten>]]''' || - || - || Eine Liste der [[#artikelDaten|Packstück-Artikel]] vom Typ '''[[#artikelDaten|ArtikelDaten]]''' (1:n)
+
"zusatzfeld8": "",
−
|-
+
"zusatzfeld9": "",
−
| assoc || [[#Datentypen|Map]] ([[#Datentypen|String]], [[#Datentypen|String]]) || - || - || Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert)
+
"zusatzfeld10": "",
−
|-
+
"ausgangDateTime": ""
−
| auftragNr || [[#Datentypen|String]] || 20 || - || -
+
}
−
|-
+
]
−
| '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Mandantenkennung aus dem HVS32
+
}
 +
</source>
 +
</div></div>
 +
<!-- ------------------------------------------------------------------------------- ENDE sendungsdatenAnfrage ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- ENDE ÜBERSICHT DER FUNTKIONEN ------------------------------------------------------------------------------- -->
 +
 
 +
= Zusätzliche Datentypen =
 +
Je nach Frachtführer und Einsatzzweck kann es notwendig werden weitere Informationen zur Sendung zu übergeben.  
 +
HVS verarbeitet spezielle Kennungen für Daten von im Packstück enthaltenen Artikel oder Gefahrgütern. In beiden Fällen ist es möglich mehrere Zusatzdaten pro Packstück zu übergeben, zum Beispiel wenn mehrere Artikel in einem Packstück enthalten sind.
 +
 
 +
== ArtikelDaten ==
 +
 
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">Artikel-Daten</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 
|-
 
|-
−
| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+
! Nr !! Feldname !! Von !! Bis !! Typ !! Länge !! Dezimalstellen !! Pflicht !! HVS-Feld !! Belegung !! Feldname
 
|-
 
|-
−
| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+
| 1 || Satz-Kennung || 1 || 3 || A || 3 ||  || M ||  || Festeintrag "ART" || Satz-Kennung
 
|-
 
|-
−
| avisZusatz1 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 1
+
| 2 || Lieferschein-Nr || 4 || 13 || A || 10 || || M || ||  || Lieferschein-Nr
 
|-
 
|-
−
| avisZusatz2 || [[#Datentypen|String]] || 20 || - || Zusatz zu Fest-AVIS-Schlüssel 2
+
| 3 || Packstück-Nr || 14 || 16 || N || 3 || || C || || Pflicht bei AutomatikPolling || Packstück-Nr
 
|-
 
|-
−
| barcodeID || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| 4 || Positions-Nr || 17 || 26 || N || 10 || 0 || M ||  || || Positions-Nr
 
|-
 
|-
−
| barcodeText || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| 5 || Artikel-Nr || 27 || 76 || A || 50 || || O ||  || || Artikel-Nr
 
|-
 
|-
−
| barcodeTyp || [[#Datentypen|String]] || - || - || Zusatzfeld für evtl. Erweiterungen
+
| 6 || Artikel-Bezeichnung1 || 77 || 176 || A || 100 || || M ||  || || Artikel-Bezeichnung1
 
|-
 
|-
−
| bestellNr || [[#Datentypen|String]] || 20 || - || Metro-Bestellnr (Metro-Versand)
+
| 7 || Artikel-Bezeichnung2 || 177 || 276 || A || 100 || || O ||  || || Artikel-Bezeichnung2
 
|-
 
|-
−
| druckername || [[#Datentypen|String]] || 30 || - || Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul)
+
| 8 || Artikel-Netto-Gewicht (je Maßeinheit) || 277 || 285 || N || 9 || 3 || M || || || Artikel-Netto-Gewicht (je Maßeinheit)
 
|-
 
|-
−
| email || [[#Datentypen|String]] || 100 || - || E-Mail Adresse des Empfängers (z.B.: für die Automatische E-Mail Avisierung)
+
| 9 || BTN-Nummer || 286 || 310 || A || 25 || || O ||  || || BTN-Nummer
 
|-
 
|-
−
| empfMobilfunkNr || [[#Datentypen|String]] || 20 || - || Mobilfunknummer des Empfängers
+
| 10 || Artikel-Anzahl (je Maßeinheit) || 311 || 319 || N || 9 || 0 || M ||  || || Artikel-Anzahl (je Maßeinheit)
 
|-
 
|-
−
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
+
| 11 || Ursprungsland || 320 || 321 || A || 2 ||  || O ||  || || Ursprungsland
 
|-
 
|-
−
| flexZustellungEmailadresse || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Emailadresse
+
| 12 || Artikel-Wert (je Maßeinheit) || 322 || 330 || N || 9 || 2 || O ||  || || Artikel-Wert (je Maßeinheit)
 
|-
 
|-
−
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer falls Frachtbrief durch Vorsystem gedruckt werden soll
+
| 13 || Artikelwert-Währung || 331 || 333 || A || 3 ||  || O ||  || ISO-Währung z.B. 'EUR' || Artikelwert-Währung
 
|-
 
|-
−
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer
+
| 14 || Artikel-Maßeinheit || 334 || 343 || A || 10 || || O ||  || || Artikel-Maßeinheit
 
|-
 
|-
−
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
+
| 15 || Artikel-BestellNr || 344 || 393 || A || 50 ||  || M ||  || || Artikel-BestellNr
 
|-
 
|-
−
| [[#gefahrgut|gefahrgut]] || [[#Datentypen|Sequence]] '''[[#gefahrgut|<Gefahrgut>]]''' || - || - || Eine Liste der [[#gefahrgut|Gefahrgüter]] vom Typ '''[[#gefahrgut|Gefahrgut]]''' (1:n)
+
| 16 || Artikel-Volumen || 394 || 402 || N || 9 || 3 || M || || || Artikel-Volumen
 
|-
 
|-
−
| gewicht || [[#Datentypen|Decimal]] || 8 || 3 || Bruttogewicht in KG
+
| 17 || Artikel-Services || 403 || 452 || A || 50 ||  || O ||  || || Artikel-Services
 
|-
 
|-
−
| hostTrackingNr || [[#Datentypen|String]] || 35 || - || Paketnummer aus dem Hostsystem
+
| 18 || Artikel-Gruppe || 453 || 502 || A || 50 || || O ||  || || Artikel-Gruppe
 
|-
 
|-
−
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
+
|}
 +
M = Muss eingetragen werden, O = Optimal einzutragen, C = Conditional abhängig von anderen Feldern
 +
 
 +
</div></div>
 +
 
 +
Bitte klären Sie die übergebenen Parameter unbedingt im Vorfeld mit Ihrem Ansprechpartner bei Heidler Strichcode GmbH da diese stark von den verwendeten Frachtführern abhängen.
 +
<!-- ------------------------------------------------------------------------------- ENDE artikelDaten ------------------------------------------------------------------------------- -->
 +
<!-- ------------------------------------------------------------------------------- gefahrgut ------------------------------------------------------------------------------- -->
 +
 
 +
== Gefahrgut ==
 +
<div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">
 +
<div style="font-weight:bold;line-height:1.6;">Gefahrgut-Daten</div>
 +
<div class="mw-collapsible-content">
 +
{| class="wikitable sortable"
 
|-
 
|-
−
| infotext1 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
! Nr !! Name !! Feldname !! Von !! Bis !! Länge !! Dezimalstellen !! Typ !! Belegung !! Wichtig bei LQ
 
|-
 
|-
−
| infotext2 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 1 || Satzkennung || || 1 || 3 || 3 || || A || Fest 'GEF' ||
 
|-
 
|-
−
| infotext3 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 2 || Gefahrgut-UNNR || GefahrgutUNNr || 4 || 7 || 4 || || A || || X
 
|-
 
|-
−
| infotext4 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 3 || Gefahrgut-Klasse || GefahrgutKlasse || 8 || 11 || 4 || || A || || X
 
|-
 
|-
−
| infotext5 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 4 || GG-Verpackungsgruppe || GefahrgutVPG || 12 || 14 || 3 || || A || I,II,III bzw. leer ||
 
|-
 
|-
−
| infotext6 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 5 || GG-Klassifizierungscode || GefahrgutKCODE || 15 || 18 || 4 || || A || Pflicht bei Klasse 2 ||
 
|-
 
|-
−
| infotext7 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 6 || Gefahrgut-Bezeichnung || GefahrgutBezeichnung || 19 || 128 || 110 || || A || Stoffbezeichnung It. ADR-Tabelle || X
 
|-
 
|-
−
| infotext8 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 7 || Gefahrgut-Stoffmenge || GefahrgutMenge || 129 || 139 || 11 || 3 || N || || X
 
|-
 
|-
−
| infotext9 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 8 || Kennung 'Begrenze Menge' || GefahrgutBegrenzteMenge || 140 || 140 || 1 || || A || '*' oder 'T': Status 'Begrenzte Menge' || X
 
|-
 
|-
−
| infotext10 || [[#Datentypen|String]] || 150 || - || Zusatzfeld für evtl. Erweiterungen
+
| 9 || Anzahl Versandstücke GG || GefahrgutVerpAnzahl || 141 || 143 || 3 || || N || || X
 
|-
 
|-
−
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
+
| 10 || Versandstück-Art || GefahrgutVerpackungsart || 144 || 151 || 8 || || A || GG-konform, z.B. '4G', '6HG2' usw. || X
 
|-
 
|-
−
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
+
| 11 || GG-ID || GefahrgutID || 152 || 159 || 8 || || A || Eindeutige Suchnummer für Gefahrgut-Stammdaten ||
 
|-
 
|-
−
| lagerkennzeichen || [[#Datentypen|Integer]] || - || - || -
+
| 12 || GG-Nebengefahrklasse(n) || GefahrgutNebengefahr || 160 || 171 || 12 || || A || GG-Nebengefahrklasse(n) ||
 
|-
 
|-
−
| letztesPackstueck || [[#Datentypen|String]] || 1 || - || T/F: T=letztes Packstüeck der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt)
+
| 13 || Buchst. Bei Sondervorschr. 640 || GefahrgutBuchst640 || 172 || 172 || 1 || || A || Buchst. Bei Sondervorschr. 640 (A-L) ||
 
|-
 
|-
−
| lieferantenID || [[#Datentypen|Integer]] || - || - || -
+
| 14 || Maßeinheit GG-Stoffmenge || GefahrgutMengeneinheit || 173 || 173 || 1 || || A || 0' bzw. Blank: Kilogramm; "1": Liter || X
 
|-
 
|-
−
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet
+
| 15 || Beförderungskategorie || GefahrgutBefoerdKat || 174 || 174 || 1 || || N || 0-4 It. ADR 1.1.3.6 || X
 
|-
 
|-
−
| nachnahme || [[#Datentypen|Decimal]] || 18 || 2 || -
+
| 16 || GG-Faktor || GefahrgutFaktor || 175 || 178 || 4 || || N || Gewichtungsfaktor It. ADR 1.1.3.6 ||
 
|-
 
|-
−
| nettoGewicht || [[#Datentypen|Decimal]] || 8 || 3 || Nettogewicht in KG
+
| 17 || Netto-Explosivmasse in kg || GefahrgutNettoExpiMasse || 179 || 189 || 11 || 3 || N || Nur bei Klasse 1, dann aber Pflicht ||
 
|-
 
|-
−
| neutBIC || [[#Datentypen|String]] || 11 || - || Nur bei Neutral-Absendern belegt
+
| 18 || Tunnel-Beschränkungscode || GefahrgutTunnelBCode || 190 || 199 || 10 || || A || ab ADR 2009 Pflicht, incl. Klammerung, z.B. (C/E) ||
 
|-
 
|-
−
| neutBankBezeichnung || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
+
| 19 || Kennung 'Freigestellte Menge' || GefahrgutFreigestMenge || 200 || 200 || 1 || || A || '*' oder 'T': Status 'Freigestellte Menge' (überstimmt Feld 8) ||
 
|-
 
|-
−
| neutIBAN || [[#Datentypen|String]] || 31 || - || Nur bei Neutral-Absendern belegt
+
| 20 || Kennung 'Umweltgefährdend' || GefahrgutUmweltgef || 201 || 201 || 1 || || A || '*' oder 'T': Status 'Umweltgefährdend' ||
 
|-
 
|-
−
| neutKontoInhaber || [[#Datentypen|String]] || 40 || - || Nur bei Neutral-Absendern belegt
+
| 21 || Gefahrgut-Techn. Benennung || GefahrgutTechBenennung || 202 || 301 || 100 || || A || Gefahrauslöser/tech. Benennung bei N.A.G.-Gefahrgut ||
 
|-
 
|-
−
| neutabsenderLKZ || [[#Datentypen|String]] || 3 || - || Nur bei Neutral-Absendern belegt
+
|}
−
|-
+
</div></div>
−
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
Bitte klären Sie die übergebenen Parameter unbedingt im Vorfeld mit Ihrem Ansprechpartner bei Heidler Strichcode GmbH da diese stark von den verwendeten Frachtführern abhängen.
−
|-
+
<!-- ------------------------------------------------------------------------------- ENDE gefahrgut ------------------------------------------------------------------------------- -->
−
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
+
<!-- ------------------------------------------------------------------------------- edistatus ------------------------------------------------------------------------------- -->
−
|-
 
−
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || 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
 
−
|-
 
−
| packStkNr || [[#Datentypen|Integer]] || - || - || Laufende Nr pro Sendung
 
−
|-
 
−
| 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)
 
−
|-
 
−
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
 
−
|-
 
−
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
 
−
|-
 
−
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
−
|-
 
−
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
−
|-
 
−
| 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
 
−
|-
 
−
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
 
−
|-
 
−
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
−
|-
 
−
| terminZeit || [[#Datentypen|Calendar]] || 5 || - || HH:MM
 
−
|-
 
−
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
−
|-
 
−
| verpackungsart || [[#Datentypen|String]] || 6 || - || -
 
−
|-
 
−
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
−
|-
 
−
| versicherungswert || [[#Datentypen|Decimal]] || 18 || 2 || Höhe Versicherungswert
 
−
|-
 
−
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
−
|-
 
−
| 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
 
−
|-
 
−
| zbZoll || [[#Datentypen|String]] || 1 || - || Zahlungsbedingung für Zoll Steuern 'S' = Sender, 'R' = Empfänger
 
−
|-
 
−
| zielAdrBahnhof || [[#Datentypen|String]] || 30 || - || PLZ und Ort
 
−
|-
 
−
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
 
−
|-
 
−
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
 
−
|-
 
−
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|}
 
−
</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)
 
−
|-
 
−
| 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>
 
−
<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>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/anonymisiereVersandDaten'''<br>
 
−
'''MediaType: text/plain'''<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 || - || 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>
 
−
<br>
 
−
'''Funktion (POST): /hvs32rest/sendungsdatenAnfrage'''<br>
 
−
'''MediaType: text/plain'''<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
 
−
|-
 
−
| 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
 
−
|-
 
−
| faxNr || [[#Datentypen|String]] || 20 || - || Faxnummer des Empfängers
 
−
|-
 
−
| flexZustellungEmailadResponsese || [[#Datentypen|String]] || 80 || - || Flex-Zustellung Email-Adresse
 
−
|-
 
−
| frachtBrief || [[#Datentypen|String]] || 20 || - || Frachtbrief Nummer, falls Frachtbrief durch Vorsystem gedruckt wird.
 
−
|-
 
−
| frachtfuehrerKdNr || [[#Datentypen|String]] || 10 || - || Kundennummer des Frachtzahlers beim Frachtführer.
 
−
|-
 
−
| frankaturKennung || [[#Datentypen|String]] || 10 || - || -
 
−
|-
 
−
| ilnNr || [[#Datentypen|String]] || 20 || - || ILN des Empfängers (Pflicht bei Metro-Versand)
 
−
|-
 
−
| kostenstelle || [[#Datentypen|String]] || 30 || - || -
 
−
|-
 
−
| kundenNr || [[#Datentypen|String]] || 20 || - || Kundennummer des Empfängers beim Versender
 
−
|-
 
−
| Lagerkennzeichen || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
 
−
|-
 
−
| LieferantenID || [[#Datentypen|String]] || <!-- MAXLÄNGE --> || <!-- DEZ --> || <!-- BELEGUNG -->
 
−
|-
 
−
| '''lieferscheinNr''' || [[#Datentypen|String]] || 40 || - || Wird im HVS32 als Such-Nummer verwendet.
 
−
|-
 
−
| 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
 
−
|-
 
−
| neutabsenderName1 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderName2 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderName3 || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderOrt || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderPLZ || [[#Datentypen|String]] || 10 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| neutabsenderStrasse || [[#Datentypen|String]] || 50 || - || Nur bei Neutral-Absendern belegt
 
−
|-
 
−
| '''packStkGes''' || [[#Datentypen|Integer]] || - || - || Gesamt-Anzahl Colli der Sendung
 
−
|-
 
−
| [[#packstueckDaten|packstueckDaten]] || [[#Datentypen|Sequence]] [[#packstueckDaten|<PackStueckDaten>]] || - || - || -
 
−
|-
 
−
| packplatz || [[#Datentypen|String]] || 10 || - || HVS32-Packplatz-Client, der den Auftrag verarbeten soll.
 
−
|-
 
−
| paperlessInvoice || [[#Datentypen|String]] || 1 || - || Nur im UPS PaperlessInvoice Fall (T=PaperlessInvoice / F=nicht PaperlessInvoice)
 
−
|-
 
−
| postLeitcode || [[#Datentypen|String]] || 15 || - || -
 
−
|-
 
−
| postZielFrachtzent || [[#Datentypen|String]] || 5 || - || -
 
−
|-
 
−
| rechnungsEmpfLKZ || [[#Datentypen|String]] || 5 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfName1 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfName2 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfName3 || [[#Datentypen|String]] || 50 || - || Rechnungsempfänger
 
−
|-
 
−
| rechnungsEmpfOrt || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfPLZ || [[#Datentypen|String]] || 10 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsEmpfStrasse || [[#Datentypen|String]] || 50 || - || Rechnungsadresse
 
−
|-
 
−
| rechnungsNr || [[#Datentypen|String]] || 20 || - || Rechnungsnummer
 
−
|-
 
−
| requestSPM || [[#Datentypen|String]] || 5 || - || T/TRUE wenn die Entscheidungsmatrix angesprochen werden soll, sonst leer
 
−
|-
 
−
| sendungsinhalt || [[#Datentypen|String]] || 30 || - || -
 
−
|-
 
−
| 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
 
−
|-
 
−
| terminArt || [[#Datentypen|String]] || 1 || - || 'A'b / 'B'is / 'F'ix
 
−
|-
 
−
| terminDatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
−
|-
 
−
| terminZeit || [[#Datentypen|String]] || 5 || - || HH:MM
 
−
|-
 
−
| ustIDNr || [[#Datentypen|String]] || 20 || - || UmsatzsteuerNr des Empfängers
 
−
|-
 
−
| '''versandartID''' || [[#Datentypen|String]] || 10 || - || Versandartkennung aus dem HVS32
 
−
|-
 
−
| vorgabeFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Vorgabe-Frachtführer für [[Shipment_Policy_Manager_(Tarifwerk)|SPM]] Anfrage
 
−
|-
 
−
| vorpackdatum || [[#Datentypen|String]] || 10 || - || TT.MM.JJJJ
 
−
|-
 
−
| wechselbruecke || [[#Datentypen|String]] || 20 || - || Wechselbrücke, die diesem Packstück zugewiesen werden soll
 
−
|-
 
−
| zahlungsbedingung || [[#Datentypen|String]] || 10 || - || '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
 
−
|-
 
−
| '''zielAdrLKZ''' || [[#Datentypen|String]] || 5 || - || Länderkennzeichen (LKZ)
 
−
|-
 
−
| '''zielAdrName1''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName2 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName3 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| zielAdrName4 || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrOrt''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|-
 
−
| '''zielAdrPLZ''' || [[#Datentypen|String]] || 10 || - || Lieferadresse
 
−
|-
 
−
| zielAdrRegion || [[#Datentypen|String]] || 20 || - || Staat/Provinz (z.B.: für Sendungen in die USA wichtig)
 
−
|-
 
−
| '''zielAdrStrasse''' || [[#Datentypen|String]] || 50 || - || Lieferadresse
 
−
|}
 
−
</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
 
−
|-
 
−
| 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|
 
−
|-
 
−
| 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
 
−
|-
 
−
| 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": "",
 
−
"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 =
 
= Beispiele =
−
Alle JSON Beispiele finden Sie auch hier: [[REST_Beispiel|REST SERVER JSON Beispiele]]
 

Aktuelle Version vom 18. Mai 2022, 12:29 Uhr

Funktionsbeschreibung

Die Dateischnittstelle ist sehr flexibel und kann an nahezu alle Eingangsdaten angepasst werden. Es ist möglich mehrere Datensätze in einer Datei zu übergeben, aber auch ein Datensatz pro Datei ist möglich. In der Regel belegt ein Packstück eine Zeile, eventuell gefolgt von Zusatzinformationen wie Artikeldaten oder Gefahrgutsätzen.
Die einzelnen Felder sind unter Standard Datei Tabellenbeschreibung (CSV, SDF, etc.) beschrieben.

Übersicht der Funktionen

Packstück-Verarbeitung

Ein neues Packstück wird durch eine Zeile gekennzeichnet die mit der Kennung "IMP" beginnt.

Die weiteren Felder sind in der Standardschnittstelle beschrieben.

Etikett nachdrucken

Ein Nachdruck wird ausgelöst indem ein bereits übergebener Satz erneut erfasst wird. Je nach Einstellungen kann es dabei zu einer Warnung oder einer Verhinderung des Nachdrucks kommen - die zugehörigen Wahlmöglichkeiten befinden sich im Allgemein-Konfigurator, Bereich "Lieferschein-Verarbeitung".

Packstück stornieren

Ausgangsliste erzeugen

Frachtführer DFÜ erzeugen

Packstückdaten aktualisieren

Packstückdaten aktualisieren

Packstückdaten anonymisieren

Sendungs-Verarbeitung

Zusätzliche Datentypen

Je nach Frachtführer und Einsatzzweck kann es notwendig werden weitere Informationen zur Sendung zu übergeben. HVS verarbeitet spezielle Kennungen für Daten von im Packstück enthaltenen Artikel oder Gefahrgütern. In beiden Fällen ist es möglich mehrere Zusatzdaten pro Packstück zu übergeben, zum Beispiel wenn mehrere Artikel in einem Packstück enthalten sind.

ArtikelDaten

Artikel-Daten
Nr Feldname Von Bis Typ Länge Dezimalstellen Pflicht HVS-Feld Belegung Feldname
1 Satz-Kennung 1 3 A 3 M Festeintrag "ART" Satz-Kennung
2 Lieferschein-Nr 4 13 A 10 M Lieferschein-Nr
3 Packstück-Nr 14 16 N 3 C Pflicht bei AutomatikPolling Packstück-Nr
4 Positions-Nr 17 26 N 10 0 M Positions-Nr
5 Artikel-Nr 27 76 A 50 O Artikel-Nr
6 Artikel-Bezeichnung1 77 176 A 100 M Artikel-Bezeichnung1
7 Artikel-Bezeichnung2 177 276 A 100 O Artikel-Bezeichnung2
8 Artikel-Netto-Gewicht (je Maßeinheit) 277 285 N 9 3 M Artikel-Netto-Gewicht (je Maßeinheit)
9 BTN-Nummer 286 310 A 25 O BTN-Nummer
10 Artikel-Anzahl (je Maßeinheit) 311 319 N 9 0 M Artikel-Anzahl (je Maßeinheit)
11 Ursprungsland 320 321 A 2 O Ursprungsland
12 Artikel-Wert (je Maßeinheit) 322 330 N 9 2 O Artikel-Wert (je Maßeinheit)
13 Artikelwert-Währung 331 333 A 3 O ISO-Währung z.B. 'EUR' Artikelwert-Währung
14 Artikel-Maßeinheit 334 343 A 10 O Artikel-Maßeinheit
15 Artikel-BestellNr 344 393 A 50 M Artikel-BestellNr
16 Artikel-Volumen 394 402 N 9 3 M Artikel-Volumen
17 Artikel-Services 403 452 A 50 O Artikel-Services
18 Artikel-Gruppe 453 502 A 50 O Artikel-Gruppe

M = Muss eingetragen werden, O = Optimal einzutragen, C = Conditional abhängig von anderen Feldern

Bitte klären Sie die übergebenen Parameter unbedingt im Vorfeld mit Ihrem Ansprechpartner bei Heidler Strichcode GmbH da diese stark von den verwendeten Frachtführern abhängen.

Gefahrgut

Gefahrgut-Daten
Nr Name Feldname Von Bis Länge Dezimalstellen Typ Belegung Wichtig bei LQ
1 Satzkennung 1 3 3 A Fest 'GEF'
2 Gefahrgut-UNNR GefahrgutUNNr 4 7 4 A X
3 Gefahrgut-Klasse GefahrgutKlasse 8 11 4 A X
4 GG-Verpackungsgruppe GefahrgutVPG 12 14 3 A I,II,III bzw. leer
5 GG-Klassifizierungscode GefahrgutKCODE 15 18 4 A Pflicht bei Klasse 2
6 Gefahrgut-Bezeichnung GefahrgutBezeichnung 19 128 110 A Stoffbezeichnung It. ADR-Tabelle X
7 Gefahrgut-Stoffmenge GefahrgutMenge 129 139 11 3 N X
8 Kennung 'Begrenze Menge' GefahrgutBegrenzteMenge 140 140 1 A '*' oder 'T': Status 'Begrenzte Menge' X
9 Anzahl Versandstücke GG GefahrgutVerpAnzahl 141 143 3 N X
10 Versandstück-Art GefahrgutVerpackungsart 144 151 8 A GG-konform, z.B. '4G', '6HG2' usw. X
11 GG-ID GefahrgutID 152 159 8 A Eindeutige Suchnummer für Gefahrgut-Stammdaten
12 GG-Nebengefahrklasse(n) GefahrgutNebengefahr 160 171 12 A GG-Nebengefahrklasse(n)
13 Buchst. Bei Sondervorschr. 640 GefahrgutBuchst640 172 172 1 A Buchst. Bei Sondervorschr. 640 (A-L)
14 Maßeinheit GG-Stoffmenge GefahrgutMengeneinheit 173 173 1 A 0' bzw. Blank: Kilogramm; "1": Liter X
15 Beförderungskategorie GefahrgutBefoerdKat 174 174 1 N 0-4 It. ADR 1.1.3.6 X
16 GG-Faktor GefahrgutFaktor 175 178 4 N Gewichtungsfaktor It. ADR 1.1.3.6
17 Netto-Explosivmasse in kg GefahrgutNettoExpiMasse 179 189 11 3 N Nur bei Klasse 1, dann aber Pflicht
18 Tunnel-Beschränkungscode GefahrgutTunnelBCode 190 199 10 A ab ADR 2009 Pflicht, incl. Klammerung, z.B. (C/E)
19 Kennung 'Freigestellte Menge' GefahrgutFreigestMenge 200 200 1 A '*' oder 'T': Status 'Freigestellte Menge' (überstimmt Feld 8)
20 Kennung 'Umweltgefährdend' GefahrgutUmweltgef 201 201 1 A '*' oder 'T': Status 'Umweltgefährdend'
21 Gefahrgut-Techn. Benennung GefahrgutTechBenennung 202 301 100 A Gefahrauslöser/tech. Benennung bei N.A.G.-Gefahrgut

Bitte klären Sie die übergebenen Parameter unbedingt im Vorfeld mit Ihrem Ansprechpartner bei Heidler Strichcode GmbH da diese stark von den verwendeten Frachtführern abhängen.

Beispiele

Abgerufen von „https://wiki.heidler-strichcode.de/w/index.php?title=HVS32_Standard_Datei_Schnittstelle&oldid=4253“