HVS32 Standard Datei Schnittstelle
Voraussetzungen
| DGS-Version | 3.6.0.595 oder höher |
| DGS-Plugins | HVS32Client, REST Server |
Funktionsbeschreibung
Bei der REST-Schnittstelle stellt der DataGatewayServer (DGS) einen REST Server mit folgenden Funktionen zur Verfügung. Dieser ist in der Standardkonfiguration unter http://<Servername>:<Port>/hvs32rest erreichbar. Dabei wird der Port 8081 verwendet, welcher bei Bedarf geändert werden kann.
Datentypen
Integer - Zahl mit ausschließlich numerischen Zeichen (0-9).
Decimal - Zahl mit Nachkommastellen
Calendar - Datum. Monat ist dabei 0-basierend (0 = Januar, 11 = Dezember)
String - Beliebige Zeichen aus dem Zeichensatz ISO-8859-1. Maximale Länge darf nicht überschritten werden.
Binary - Base64 kodierte Binärdaten
Sequence - Eine Liste von Elementen
Map - Key/Value Map
Zusätzliche Datentypen
Ein spezial Datentyp kann innerhalb der Anfrage / Rückmeldung einer Funktion genutzt werden.
artikelDaten
Artikel-Daten
| Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
|---|---|---|---|---|
| anzahlBuegel | Integer | - | - | Nur für Hängeversand: Anzahl der Bügel auf welche die Artikelgruppe aufgeteilt ist |
| anzahlPosEtiketten | Integer | - | - | Anzahl Artikeletiketten, welche gedruckt werden sollen |
| artikelBTNNr | String | 25 | - | BTN Nummer / Zolltarifnummer |
| artikelEAN | String | 20 | - | EAN Nummer |
| artikelEinheit | String | 10 | - | Einheit der Artikelmenge |
| artikelGewicht | Decimal | 9 | 3 | Gewicht des Arikels |
| artikelGruppe | String | 50 | - | Artikelgruppe |
| artikelMenge | Decimal | 9 | 3 | Menge des Artikels |
| artikelServices | String | 100 | - | Pipe getrennte Services für diesen Artikel |
| artikelSollMenge | Decimal | 9 | 3 | - |
| artikelText1 | String | 100 | - | Artikelbezeichnung |
| artikelText2 | String | 100 | - | Artikelbezeichnung |
| artikelText3 | String | 100 | - | Artikelbezeichnung |
| artikelText4 | String | 100 | - | Artikelbezeichnung |
| artikelVolumen | Decimal | 9 | 3 | Volumen des Artikels |
| artikelWaehrung | String | 3 | - | Währung in welcher der Wert des Artikels angegeben wird |
| artikelWert | Decimal | 18 | 2 | Wert des Artikels |
| chargeFlag | String | 1 | - | |
| kundenArtikelNr | String | 50 | - | Artikelnummer |
| kundenBestellNr | String | 50 | - | Bestellnummer |
| posAuftragNr | String | 50 | - | Auftragsnummer |
| posLieferNr | String | 40 | - | Lieferscheinnummer |
| positionNr | String | 50 | - | Laufende Nummer innerhalb des Packstücks |
| serienNr | String | 30 | - | Seriennummer |
| ursprungLand | String | 2 | - | Ursprungsland des Artikels |
gefahrgut
Gefahrgut-Daten
| Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
|---|---|---|---|---|
| gefahrgutBefoerdKat | Integer | 1 | - | Beförderungskategorie, Pflicht (siehe ADR-Tabelle Spalte (15)), kann 0-4 sein. Achtung! Muss unbedingt korrekt sein. |
| gefahrgutBegrenzteMenge | String | 1 | - | T wenn der Stoff mit Status LQ / Begrenzte Menge nach ADR 3.4 verschickt wird, ansonsten F, Pflicht |
| gefahrgutBezeichnung | String | 100 | - | Pflicht (siehe ADR-Tabelle Spalte (2)) |
| gefahrgutBuchst640 | String | 1 | - | Buchstabe für Sondervorschrift 640, bedingte Pflicht bei Stoffen, bei denen die Sondervorschrift 640 gilt (siehe ADR-Tabelle Spalte (6)) |
| gefahrgutFFCode | String | |||
| gefahrgutFaktor | Integer | 3 | - | Bewertungsfaktor für Punktesummation auf dem Beförderungspapier, (kann 0, 1, 3, 50 oder 999 sein), eigentlich Pflicht, kann aber eindeutig aus der Beförderungskategorie geschlossen werden, daher muss es nicht unbedingt belegt sein |
| gefahrgutFreigestMenge | String | 1 | - | T wenn der Stoff mit Status EQ / Excepted Quantities nach ADR 3.5 verschickt wird, ansonsten F, Pflicht |
| gefahrgutID | String | 8 | - | Eindeutige Suchnummer für Gefahrgut-Stammdaten |
| gefahrgutKCode | String | 10 | - | Klassifizierungscode, Pflicht (siehe ADR-Tabelle Spalte (3b)) |
| gefahrgutKlasse | String | 100 | - | Pflicht (siehe ADR-Tabelle Spalte (3a)) |
| gefahrgutMenge | Decimal | 8 | 3 | Stoff-Menge an Gefahrgut, die ADR-technisch zu deklarieren ist ( in Litern bei Flüssigkeiten und verdichteten Gasen, sonst in kg, bei LQ-Gefahrgut immer kg ) |
| gefahrgutMengenEinheit | String | 2 | - | Mengeneinheit zur Stoff-Menge. ‚1‘ oder ‚l‘: Liter ; ‚0‘ oder ‚kg‘ oder leer: kg |
| gefahrgutNebenGefahr | String | 10 | - | bedingte Pflicht bei Stoffen, bei denen neben der Hauptgefahr-Klasse/Zettelnummer noch Nebengefahr-Zettelnummern vorhanden sind (siehe ADR-Tabelle Spalte (5), wenn dort z.B. 3+6.1+8 eingetragen ist, sind 6.1 und 8 die Nebengefahr-Zettelnummern und als (6.1)(8) im Feld Nebengefahr zu übermitteln ) |
| gefahrgutNettoExplMasse | Decimal | 8 | 3 | Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1 |
| gefahrgutPositionNr | Integer | - | - | Netto-Explosivmasse in kg, nur bei Gefahrgütern der Klasse 1 |
| gefahrgutTechBenennung | String | 150 | - | bedingt Pflicht bei N.A.G. Gefahrgut (d.h. wenn die Bezeichnung mit N.A.G. endet) |
| gefahrgutTunnelBCode | String | 10 | - | Tunnelbeschränkungscode, Pflicht (siehe ADR-Tabelle Spalte (15)) |
| gefahrgutUNNR | String | 10 | - | Pflicht (siehe ADR-Tabelle Spalte (1)) |
| gefahrgutUmweltGef | String | 1 | - | T wenn Stoff umweltgefährdend ist , ansonsten F, Pflicht bei umweltgefährdenden Stoffen |
| gefahrgutVPG | String | 3 | - | Verpackungsgruppe, bedingt Pflicht bei den Stoffen, bei denen diese in der ADR-Tabelle belegt ist, kann I,II oder III sein oder gar nicht belegt (letzteres z.B. bei Klasse 2)) (siehe ADR-Tabelle Spalte (4)) |
| gefahrgutVerpAnzahl | Integer | 4 | - | Anzahl der Einheiten, in denen das Gefahrgut verpackt ist (in Zusammenhang mit dem nächsten Feld GefahrgutVerpackungsart) |
| gefahrgutVerpackungsart | String | 5 | - | ADR-Code der Verpackungsart, z.B. 4G für Kiste (Pappe), Pflicht, siehe separate Doc f. Verpackungscodes |
edistatus
EDIStatus
| Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
|---|---|---|---|---|
| fehlercode | Integer | - | - | 0 = Erfolgreich |
| statuscode | String | 2 | - |
01 = FFDatei wurde erzeugt. Es ist zu beachten, dass nicht jede FFDatei verschickt wird, dies hängt ab von der HVS32 Konfiguration. |
| statustext | String | 200 | - | Klartext des Statuscodes |
| fftyp | String | 50 | - | Frachtführertyp (z.B. UPS, GLS, DPD) |
| dateityp | String | 50 | - | FFDateityp (z.B.: Standard, Express, etc.) |
| auftraggeber | String | 10 | - | Auftraggebernummer (ACHTUNG! Nicht die AuftraggeberID) |
| ffdateinr | String | 10 | - | Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt) |
packstueckDaten
Packstückdaten
| Feldname | Typ | Max Länge | Dezimalstellen | Belegung |
|---|---|---|---|---|
| anzahlArtikel | Integer | 6 | - | Anzahl Artikel (Druck auf Etikett) |
| artikelDaten | Sequence <ArtikelDaten> | - | - | Eine Liste der Packstück-Artikel vom Typ ArtikelDaten (1:n) |
| assoc | Map (String, String) | - | - | Zusatzfeld für evtl. Erweiterungen (Key=Feldname / Value=Wert) |
| barcodeID | String | - | - | Zusatzfeld für evtl. Erweiterungen |
| barcodeText | String | - | - | Zusatzfeld für evtl. Erweiterungen |
| barcodeTyp | String | - | - | Zusatzfeld für evtl. Erweiterungen |
| druckername | String | 30 | - | Name eines Ausgabekanals (Drucker) im HVS32 über den das Etikett gedruckt wird. (Benötigt Druckerspooler Erweiterungsmodul) |
| gefahrgut | Sequence <Gefahrgut> | - | - | Eine Liste der Gefahrgüter vom Typ Gefahrgut (1:n) |
| gewicht | Decimal | 8 | 3 | Bruttogewicht in KG |
| hostTrackingNr | String | 35 | - | Falls die Paketnummer aus dem Vorsystem verwendet werden soll. |
| infotext1 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext2 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext3 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext4 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext5 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext6 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext7 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext8 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext9 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| infotext10 | String | 150 | - | Zusatzfeld für evtl. Erweiterungen |
| letztesPackstueck | String | 1 | - | T/F: T=letztes Packstück der Sendung (wird bei Hängeversand zum Drucken der Sendungs-Hängekarte benötigt) |
| nachnahme | String | 3 | - | Warenwert - ISO-Währungscode |
| nettoGewicht | Decimal | 8 | 3 | Nettogewicht in KG |
| nnVermerk | String | 3 | - | Nachnahme - ISO-Währungscode |
| nnVerwendung | String | 1 | - | 'B' = Bar, 'V' = Verrechnungsscheck |
| nnWaehrung | String | 3 | - | Nachnahme - ISO-Währungscode |
| packStkNr | Integer | - | - | Laufende Nummer pro Sendung |
| packstueckBreite | Integer | - | - | Breite in cm |
| packstueckHoehe | Integer | - | - | Höhe in cm |
| packstueckID | String | 20 | - | Eindeutige Nummer für das Paket im Vorsystem. Wird als eindeutige Paketreferenz benötigt um das Etikett später zu stornieren oder zu Verladen. |
| packstueckLaenge | Integer | - | - | Länge in cm |
| verpackungsart | String | 6 | - | - |
| versicherungswert | Decimal | 18 | 2 | Höhe-Versicherungswert |
| vwWaehrung | String | 3 | - | Versicherungswert - ISO-Währungscode |
| warenwert | Decimal | 18 | 2 | - |
| wwWaehrung | String | 3 | - | Warenwert - ISO-Währungscode |