HVS32 REST Interface (Polling) - Versionsgeschichte

Bhauser: /* Update package data (updateVersanddaten) */

2024-04-22T06:44:20Z

Update package data (updateVersanddaten)

Jschaile: dangerous goods: Fettdruck für Pflichfelder (wie auf der DE Seite)

2023-11-06T09:03:32Z

dangerous goods: Fettdruck für Pflichfelder (wie auf der DE Seite)

Bhauser am 27. Juni 2022 um 06:41 Uhr

2022-06-27T06:41:58Z

Änderungen zeigen

Bhauser am 27. Juni 2022 um 06:33 Uhr

2022-06-27T06:33:53Z

Bhauser am 27. Juni 2022 um 06:29 Uhr

2022-06-27T06:29:38Z

Bhauser: /* test interface (echo) */

2022-06-27T06:25:38Z

test interface (echo)

Odelice am 18. Mai 2022 um 10:30 Uhr

2022-05-18T10:30:24Z

Dniess: korrektur

2022-02-24T14:04:58Z

korrektur

Dniess: Übersetzung vervollständigt

2022-02-24T14:03:22Z

Übersetzung vervollständigt

Änderungen zeigen

Tehrhardt: /* edistatus */

2021-09-09T07:44:26Z

edistatus

@@ Zeile 1.914: / Zeile 1.914: @@
 == Update package data (updateVersanddaten) ==
-The gateway function updateVersanddaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to change the data of existing packages there. This request is sent, for example, if the value of goods for a package is only known at a later point in time. Data within the shipping unit, billing unit and delivery tables can be updated. The search is always made via the PackstueckID field and, if occupied, also via the TrackingNr field. With this request, however, the fields and content to be updated are no longer checked according to the guidelines of the carrier (e.g. weight limits, etc.). The upstream system must therefore ensure that the updated values match the carrier's guidelines. If this is not possible, this function cannot be used and the label must be canceled and reprocessed. In addition, fields that have already been printed on a label or that have been determined by the HVS32 shipping system in a carrier transaction (e.g. address, route, tracking number, special services, etc.) cannot be manipulated. There are no package/shipment data available for confirmation. After a successful update, only the error field is returned with the value 0 - or in the event of an error, the error is returned with the value 1 and Fehlertext1.
+The gateway function updateVersanddaten is sent from the data gateway server in automatic polling mode to the HVS32 in order to change the data of existing packages there. This request is sent, for example, if the value of goods for a package is only known at a later point in time. Data within the shipping unit, billing unit and delivery tables can be updated. The search is always made via the PackstueckID field and, if occupied, also via the TrackingNr field. <br><br>
 <br>
 {| class="wikitable"
@@ Zeile 2.400: / Zeile 2.406: @@
 <!-- ------------------------------------------------------------------------------- ENDE updateVersanddaten ------------------------------------------------------------------------------- -->
 <!-- ------------------------------------------------------------------------------- anonymisiereVersandDaten ------------------------------------------------------------------------------- -->
 == Anonymize package data (anonymisiereVersandDaten) ==
 The gateway sends the anonymisiereVersandDaten to the automatic polling of the HVS32. In the HVS32, customer-related data is thus anonymized for the corresponding data set in accordance with the GDPR. This anonymization is irrevocably and definitively carried out at the database level of the shipping system. It is therefore no longer possible to restore the original data. Log files, feedback files, carrier EDIs that have already been transferred, etc. are not affected. Only packages and shipments that have already been closed during the day can be anonymised.

@@ Zeile 102: / Zeile 102: @@
 ! Field name !! Type !! Max length !! Decimal places !! Assignment
 |-
-| gefahrgutBefoerdKat || [[#Datentypen|Integer]] || 1 || - || Transport category, mandatory (see ADR table column (15)), can be 0-4. Attention. Must be correct.
+| '''gefahrgutBefoerdKat''' ||[[#Datentypen|Integer]] || 1 || - || Transport category, mandatory (see ADR table column (15)), can be 0-4. Attention. Must be correct.
 |-
 | gefahrgutBegrenzteMenge || [[#Datentypen|String]] || 1 || - || T if the substance is shipped with status LQ / Limited Quantity according to ADR 3.4, otherwise F, Mandatory
 |-
-| gefahrgutBezeichnung || [[#Datentypen|String]] || 110 || - || mandatory (see ADR table column (2))
+| '''gefahrgutBezeichnung''' ||[[#Datentypen|String]] || 110 || - || mandatory (see ADR table column (2))
 |-
 | gefahrgutBuchst640 || [[#Datentypen|String]] || 1 || - || Letter for special provision 640, conditional obligation for substances where special provision 640 applies (see ADR table column (6))
@@ Zeile 120: / Zeile 120: @@
 | gefahrgutKCode || [[#Datentypen|String]] || 10 || - || Classification code, mandatory (see ADR table column (3b))
 |-
-| gefahrgutKlasse || [[#Datentypen|String]] || 100 || - || Mandatory (see ADR table column (3a))
+| '''gefahrgutKlasse''' ||[[#Datentypen|String]] || 100 || - || Mandatory (see ADR table column (3a))
 |-
-| gefahrgutMenge || [[#Datentypen|Decimal]] || 8 || 3 || Substance quantity of dangerous goods to be declared ADR-technically ( in liters for liquids and compressed gases, otherwise in kg, for LQ dangerous goods always kg )
+| '''gefahrgutMenge''' ||[[#Datentypen|Decimal]] || 8 || 3 || Substance quantity of dangerous goods to be declared ADR-technically ( in liters for liquids and compressed gases, otherwise in kg, for LQ dangerous goods always kg )
 |-
-| gefahrgutMengenEinheit || [[#Datentypen|String]] || 2 || - || Unit of quantity for substance quantity. '1' or 'l': liter ; '0' or 'kg' or empty: kg
+| '''gefahrgutMengenEinheit''' ||[[#Datentypen|String]] || 2 || - || Unit of quantity for substance quantity. '1' or 'l': liter ; '0' or 'kg' or empty: kg
 |-
 | gefahrgutNebenGefahr || [[#Datentypen|String]] || 10 || - || conditional obligation for substances where subsidiary hazard tick numbers exist in addition to the main hazard class/tick number (see ADR table column (5), if e.g. 3+6.1+8 is entered there, 6.1 and 8 are the subsidiary hazard tick numbers and to be transmitted as (6.1)(8) in the subsidiary hazard field )
@@ Zeile 136: / Zeile 136: @@
 | gefahrgutTunnelBCode || [[#Datentypen|String]] || 10 || - || Tunnel restriction code, mandatory (see ADR table column (15))
 |-
-| gefahrgutUNNR || [[#Datentypen|String]] || 10 || - || Mandatory (see ADR table column (1))
+| '''gefahrgutUNNR''' ||[[#Datentypen|String]] || 10 || - || Mandatory (see ADR table column (1))
 |-
 | gefahrgutUmweltGef || [[#Datentypen|String]] || 1 || - || T if substance is environmentally hazardous , otherwise F, mandatory for environmentally hazardous substances
@@ Zeile 142: / Zeile 142: @@
 | gefahrgutVPG || [[#Datentypen|String]] || 3 || - || Packing group, conditionally obligatory for substances for which this is assigned in the ADR table, can be I,II or III or not assigned at all (the latter e.g. for class 2)) (see ADR table column (4))
 |-
-| gefahrgutVerpAnzahl || [[#Datentypen|Integer]] || 4 || - || Number of units in which the dangerous goods are packed (in connection with the next field Dangerous goods packaging type)
+| '''gefahrgutVerpAnzahl''' ||[[#Datentypen|Integer]] || 4 || - || Number of units in which the dangerous goods are packed (in connection with the next field Dangerous goods packaging type)
 |-
-| gefahrgutVerpackungsart || [[#Datentypen|String]] || 5 || - || ADR code of packing type, e.g. 4G for box (cardboard), mandatory, see separate doc f. Packaging codes
+| '''gefahrgutVerpackungsart''' ||[[#Datentypen|String]] || 5 || - || ADR code of packing type, e.g. 4G for box (cardboard), mandatory, see separate doc f. Packaging codes
 |}
 </div></div>

@@ Zeile 276: / Zeile 276: @@
 {| class="wikitable"
 |-
-| '''Method (GET): /hvs32rest/echo/<Message>'''
+| '''Function (method: GET): /hvs32rest/echo/<Message>'''
 |}
@@ Zeile 288: / Zeile 288: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/versanddatenAnfrage'''
+|'''Function (method: POST) || /hvs32rest/versanddatenAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 798: / Zeile 798: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
+|'''Function (method: POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 943: / Zeile 943: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/stornoVersanddaten'''
+|'''Function (method: POST) || /hvs32rest/stornoVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.008: / Zeile 1.008: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/verladeVersanddaten'''
+|'''Function (method: POST) || /hvs32rest/verladeVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.078: / Zeile 1.078: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/sperreVersanddaten'''
+|'''Function (method: POST) || /hvs32rest/sperreVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.141: / Zeile 1.141: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/tagesabschluss'''
+|'''Function (method: POST) || /hvs32rest/tagesabschluss'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.253: / Zeile 1.253: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/listenabschlussAnfrage'''
+|'''Function (method: POST) || /hvs32rest/listenabschlussAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.354: / Zeile 1.354: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/listenNachdruckAnfrage'''
+|'''Function (method: POST) || /hvs32rest/listenNachdruckAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.448: / Zeile 1.448: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/ediabschlussAnfrage'''
+|'''Function (method: POST) || /hvs32rest/ediabschlussAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.551: / Zeile 1.551: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/versanddatenPruefAnfrage'''
+|'''Function (method: POST) || /hvs32rest/versanddatenPruefAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.918: / Zeile 1.918: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/updateVersanddaten'''
+|'''Function (method: POST) || /hvs32rest/updateVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 2.405: / Zeile 2.405: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/anonymisiereVersandDaten'''
+|'''Function (method: POST) || /hvs32rest/anonymisiereVersandDaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 2.474: / Zeile 2.474: @@
 {| class="wikitable"
 |-
-|'''Method (POST) || /hvs32rest/sendungsdatenAnfrage'''
+|'''Function (method: POST) || /hvs32rest/sendungsdatenAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>

@@ Zeile 276: / Zeile 276: @@
 {| class="wikitable"
 |-
-| '''Funktion (GET): /hvs32rest/echo/<Message>'''
+| '''Method (GET): /hvs32rest/echo/<Message>'''
 |}
@@ Zeile 288: / Zeile 288: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/versanddatenAnfrage'''
+|'''Method (POST) || /hvs32rest/versanddatenAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 798: / Zeile 798: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
+|'''Method (POST) || /hvs32rest/versanddatenNachdruckAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 943: / Zeile 943: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/stornoVersanddaten'''
+|'''Method (POST) || /hvs32rest/stornoVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.008: / Zeile 1.008: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/verladeVersanddaten'''
+|'''Method (POST) || /hvs32rest/verladeVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.078: / Zeile 1.078: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/sperreVersanddaten'''
+|'''Method (POST) || /hvs32rest/sperreVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.141: / Zeile 1.141: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/tagesabschluss'''
+|'''Method (POST) || /hvs32rest/tagesabschluss'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.253: / Zeile 1.253: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/listenabschlussAnfrage'''
+|'''Method (POST) || /hvs32rest/listenabschlussAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.354: / Zeile 1.354: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/listenNachdruckAnfrage'''
+|'''Method (POST) || /hvs32rest/listenNachdruckAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.448: / Zeile 1.448: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/ediabschlussAnfrage'''
+|'''Method (POST) || /hvs32rest/ediabschlussAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.551: / Zeile 1.551: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/versanddatenPruefAnfrage'''
+|'''Method (POST) || /hvs32rest/versanddatenPruefAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 1.918: / Zeile 1.918: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/updateVersanddaten'''
+|'''Method (POST) || /hvs32rest/updateVersanddaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 2.405: / Zeile 2.405: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/anonymisiereVersandDaten'''
+|'''Method (POST) || /hvs32rest/anonymisiereVersandDaten'''
 |-
 | '''MediaType || text/plain'''<br>
@@ Zeile 2.474: / Zeile 2.474: @@
 {| class="wikitable"
 |-
-|'''Funktion (POST) || /hvs32rest/sendungsdatenAnfrage'''
+|'''Method (POST) || /hvs32rest/sendungsdatenAnfrage'''
 |-
 | '''MediaType || text/plain'''<br>

@@ Zeile 276: / Zeile 276: @@
 {| class="wikitable"
 |-
-| '''Funktion (GET): /hvs32rest/echo/<Nachricht>'''
+| '''Funktion (GET): /hvs32rest/echo/<Message>'''
 |}
-<Nachricht> will be returned.
+<Message> will be returned.
 <!-- ------------------------------------------------------------------------------- ENDE echo ------------------------------------------------------------------------------- -->
 <!-- ------------------------------------------------------------------------------- versanddatenAnfrage ------------------------------------------------------------------------------- -->
 == package processing (versanddatenAnfrage) ==
 The gateway function versanddatenAnfrage is sent from the data gateway server to the HVS32 in automatic polling mode in order to generate and book a label for a package there. A label is identified for all other functions such as cancellation, loading release, etc. using the package ID on the host side. This is transferred in the PackstueckID field and must therefore be unique within the shipping system.

@@ Zeile 323: / Zeile 323: @@
 | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Client ID from the HVS32
 |-
-| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 |-
-| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 |-
 | avisZusatz1 || [[#Datentypen|String]] || 20 || - || Addition to fixed AVIS key 1
@@ Zeile 1.575: / Zeile 1.575: @@
 | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Client ID from the HVS32
 |-
-| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 |-
-| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 |-
 | avisZusatz1 || [[#Datentypen|String]] || 20 || - || Addition to fixed AVIS key 1
@@ Zeile 1.944: / Zeile 1.944: @@
 | '''auftraggeberID''' || [[#Datentypen|String]] || 10 || - || Client ID from the HVS32
 |-
-| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 |-
-| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 |-
 | avisZusatz1 || [[#Datentypen|String]] || 20 || - || Addition to fixed AVIS key 1
@@ Zeile 2.498: / Zeile 2.498: @@
 | ausschlussFrachtfuehrer || [[#Datentypen|String]] || 20 || - || Exclusion carrier for SPM request
 |-
-| avisHinweis1 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis1 || [[#Datentypen|String]] || 100 || - || -
 |-
-| avisHinweis2 || [[#Datentypen|String]] || 30 || - || -
+| avisHinweis2 || [[#Datentypen|String]] || 100 || - || -
 |-
 | avisZusatz1 || [[#Datentypen|String]] || 20 || - || Addition to fixed AVIS key 1

@@ Zeile 1.348: / Zeile 1.348: @@
 <!-- ------------------------------------------------------------------------------- ListenNachdruck------------------------------------------------------------------------------- -->
-== Ausgangsliste nachdrucken (listenNachdruckAnfrage) ==
+== reprint outgoing list  (listenNachdruckAnfrage) ==
 The gateway sends the listenNachdruckAnfrage request to the automatic polling of the HVS32. In the HVS32, an output list that has already been created is then reprinted using the output list number that was transferred. A list can only be reprinted if it has already been generated using the functions daily closing, list closing request or manually using the HVS32 mask. There are no package/shipment data available for confirmation. After successful completion of the list, only the Error field is returned with the value 0 - or in the event of an error, the Error is returned with the value 1 and Fehlertext1.
 <br>
@@ Zeile 1.442: / Zeile 1.442: @@
 <!-- ------------------------------------------------------------------------------- ediabschlussAnfrage ------------------------------------------------------------------------------- -->
-== Frachtführer DFÜ erzeugen (ediabschlussAnfrage) ==
+== Generate carrier EDI (ediabschlussAnfrage) ==
 The gateway sends the ediabschlussAnfrage request to the automatic polling of the HVS32. In the HVS32, a carrier EDI is generated based on the additionally transferred parameters and (if configured) transmitted to the carrier. Only packages for which an outgoing list was previously generated are taken into account for a carrier EDI. The feedback in the HVS32 takes place after the carrier EDI has been generated. There are no package/shipment data available for confirmation. After successful EDI completion, only the error field is reported with the value 0 - or in the event of an error, the error is reported with the value 1 Fehlertext1.
 <br>

@@ Zeile 168: / Zeile 168: @@
 = Carrier file could not be sent!<br>
-It is to be noted that not every carrier file is sent, this depends on the HVS32 configuration.<br>.
+It is to be noted that not every carrier file is sent, this depends on the HVS32 configuration.<br>
 I.e. as long as no status "1x" is contained, was proceeded with the carrier file according to the HVS32 configuration.
 |-
 | statustext || [[#Datentypen|String]] || 200 || - || Plain text of the status code
 |-
-| fftyp || [[#Datentypen|String]] || 50 || - || Frachtführertyp (z.B. UPS, GLS, DPD)
+| fftyp || [[#Datentypen|String]] || 50 || - || Carrier type (e.g. UPS, GLS, DPD)
 |-
-| dateityp || [[#Datentypen|String]] || 50 || - || FFDateityp (z.B.: Standard, Express, etc.)
+| dateityp || [[#Datentypen|String]] || 50 || - || Carrier Datatype (e.g.: Standard, Express, etc.)
 |-
-| auftraggeber || [[#Datentypen|String]] || 10 || - || Auftraggebernummer ('''ACHTUNG!''' Nicht die AuftraggeberID)
+| auftraggeber || [[#Datentypen|String]] || 10 || - || Client number ('''ATTENTION!''' Not the ClientID)
 |-
-| ffdateinr || [[#Datentypen|String]] || 10 || - || Nummer der FF-Datei (ggf. im Fehlerfall nicht gefüllt)
+| ffdateinr || [[#Datentypen|String]] || 10 || - || number of the carrier file (may not be filled in case of error)
 |}
 </div></div>
 <!-- ------------------------------------------------------------------------------- ENDE edistatus ------------------------------------------------------------------------------- -->
 <!-- ------------------------------------------------------------------------------- packstueckDaten ------------------------------------------------------------------------------- -->
 == packstueckDaten ==
 <div class="toccolours mw-collapsible mw-collapsed" style="overflow:auto;">