Outbound Order Book

Wir verwenden eine REST-API mit den fertigen Fahrzeuglogistiknachrichten als XML-Körper. Wir werden eine OpenAPI-Spezifikation der Endpunkte bereitstellen. Für die Spezifikation der Nutzdaten siehe die separat bereitgestellte XSD.

Die verfügbaren APIs sind vom Typ Feed/Stream, der es ermöglicht, alle Aufträge in der chronologischen Reihenfolge zu verbrauchen, in der sie erzeugt wurden. Der Spediteur kann die Häufigkeit (z. B. zwischen 1 und 5 Minuten) und die Anzahl der Aufträge, die er auf einmal verbrauchen möchte, selbst bestimmen und alle Aufträge in der Warteschlange verbrauchen, bis keine neuen Aufträge mehr verfügbar sind. Alle Aufträge sind für einen bestimmten Zeitraum verfügbar, unabhängig davon, ob sie verbraucht wurden oder nicht. Dies bietet mehr Flexibilität bei der Frage, wann und wie sie konsumiert und bearbeitet werden, und ermöglicht auch eine erneute Konsumierung, wenn dies erforderlich ist, z. B. wenn das Speditionssystem nicht verfügbar ist oder Probleme bei der Verarbeitung einer bestimmten Nachricht hatte. Alle APIs werden von RIO bereitgestellt, und die Sicherheitsanforderungen von RIO werden auf der RIO-Seite erfüllt.

Wir verwenden OAuth2 mit einem Client Credentials Grant. Für Details siehe hier.

Fehlerbehandlung
Die Fehlerantwort ist Teil der API-Spezifikation. Sie sollte genügend Informationen enthalten, um die Behandlung des Fehlers zu ermöglichen, z.B. Fehlercodes, die es ermöglichen, mögliche Aktionen zu identifizieren, sogar automatisierte, mit einer Fehlermeldung, die eine manuelle Behandlung des Fehlers ermöglicht, falls notwendig.
RIO verwendet in der Regel ProblemJson, das Fehlercodes und auch eine detailliertere Erläuterung des Fehlers enthält, z. B. Meldungen oder bestimmte Felder, die ungültige Daten enthalten.

Versionierung
Alle FVL-Nachrichten müssen in der richtigen Reihenfolge gesendet werden und einen Zeitstempel enthalten, der angibt, wann die jeweilige Nachricht erstellt wurde ("issueDate"). Meldungen mit demselben Identifikator und älteren Zeitstempeln werden zurückgewiesen. Außerdem ist darauf zu achten, dass zuerst die Originalmeldung und danach eine Aktualisierung gesendet wird.

Testen
Um Experimente und Integrationstests zu ermöglichen, stellen wir eine Testversion der API unter einer URL zur Verfügung, die mit test. beginnt, siehe OpenAPI-Spezifikation für weitere Einzelheiten. Der Zugriff ist mit demselben Client wie für das Produktivsystem möglich.
Die Test-API hat derzeit das gleiche Verhalten wie das Produktivsystem. Zur besseren Abgrenzung sollte jedoch der TestingIndicator gesetzt werden. Zu einem späteren Zeitpunkt könnte sie dazu verwendet werden, neue Funktionen zu testen, bevor sie in der Produktion aktiviert werden.
Die von der Test-API bereitgestellten Testdaten umfassen mehrere unterschiedliche Fälle, die durch ein Präfix in der documentID in Form von CaseX- unterschieden werden können. Bitte beachten Sie, dass ein solches Präfix in der Produktion nicht erscheinen wird. Die bereitgestellten Fälle sind:

Bei Transportaufträgen:

• Zwei Standardnachrichten mit der gleichen Ladelisten-Id
• Eine Standardnachricht und eine zweite Nachricht, die den Transportauftrag der ersten Nachricht storniert
• Eine Standardnachricht und eine Aktualisierung dieser Nachricht
• Eine Standardnachricht für eine 1:n-Beziehung (nur für einige Dienstleister relevant)

Bei Serviceaufträgen:

• Eine Standardnachricht.
• Eine Standardnachricht und eine zweite Nachricht, die den Serviceauftrag der ersten Nachricht storniert.
• Eine Standardnachricht und eine Aktualisierung dieser Nachricht.

Sie werden informiert, welche Fälle für Sie relevant sind. Neue Testdaten werden in festen Zeitabständen generiert.
Bitte beachten Sie, dass die Test-API nicht in automatisierten Tests verwendet werden sollte!

Um das Outbound Order Book über Schnittstellenkommunikation nutzen zu können, stellen wir eine REST API zur Verfügung, mit der Sie service2service-basiert kommunizieren können. Um die Schnittstelle nutzen zu können, benötigen Sie eine Client-ID und zugehörige Credentials, die Sie nach der Buchung des Services von RIO erhalten. Das verwendete Nachrichtenformat für den Datenaustausch über die Schnittstelle ist der VDA/Odette/ECG-Standard "Finished Vehicle Logistics" mit den Nachrichten FV14a, FV14b, FV17, FV18 im XML-Format. Die genaue Nachrichtenspezifikation erhalten Sie von Ihrem jeweiligen Kunden.

Bitte wenden Sie sich dazu an den RIO-Support.

Das genutzte Nachrichtenformat zum Datenaustausch per Schnittstelle ist der VDA/Odette/ECG-Standard “Finished Vehicle Logistics” mit den Nachrichten FV14a, FV14b, FV17, FV18 im XML Format. Da sich die Nutzung der definierten Attribute von Auftraggeber zu Auftraggeber unterscheiden kann wenden Sie sich bitte an Ihren Auftraggeber bzgl. dessen konkreter Spezifikation der FVL Nachrichten.

Transportaufträge bezeichnen Aufträge zum Transportieren von Fahrzeugen von einem Abgangs- zu einem Zielort. Sie können Transportaufträge sehen, bestätigen und bei der Transportdurchführung Statusmeldungen erzeugen. Ebenso können Sie Störfälle melden.

Dabei handelt es sich um die verschiedenen Kategorien in die die Transportaufträge fallen. in der Inbox finden sich Transportaufträge mit Status "un/confirmed" und "canceled". In En Route finden sich Transportaufträge, welche den Status "loaded" tragen. In Finished finden sich lediglich Transportaufträge mit dem Status "unloaded".

Das LKW-Kennzeichen sollte vor Einfahrt in das entsprechende Werk geändert werden. Spätere Änderungen können ggf. nicht rechtzeitig übertragen und durch den Auftraggeber verarbeitet werden und somit nicht im Moment der Einfahrt am Werkstor vorliegen. Genaue Regularien stimmen Sie bitte mit ihren lokalen Ansprechpartnern ab.

Transportaufträge können über die freie Suche oder über Filteroptionen wiedergefunden werden. Geben Sie für die freie Suche Merkmale des Transportauftrages (z.B. Modell, Werk, VIN) in das Suchfeld, das sich rechts über der Auftragstabelle befindet, ein. Um Filteroptionen zu nutzen, Klicken Sie auf die Schaltfläche "Filter" links neben dem Suchfeld und wählen Sie die gewünschten Optionen aus.

Durch das Öffnen des Transportauftrages können Sie die VIN einsehen. Klicken Sie dazu in der Übersicht der Transportaufträge auf den gewünschten Transportauftrag. Dadurch öffnet sich die Sidebar mit weiteren Details. Danach können sie durch einen Klick auf ShipmentDetails die Details der Sendung bzw. des Fahrzeugs einsehen.

Durch das Öffnen des Transportauftrages können Sie die VIN einsehen. Klicken Sie dazu in der Übersicht der Transportaufträge auf den gewünschten Transportauftrag. Dadurch öffnet sich die Sidebar mit weiteren Details. Danach können Sie wahlweise die ShipmentDetails (für Informationen zur Ladung) oder die TransportDetails (für Informationen zum Transport) betrachten.

Aufträge können nur vom Auftraggeber storniert werden. Bei etwaigen Anliegen wenden Sie sich bitte über die "Kontakt"-Funktion des betreffenden Auftrags an den zugehörigen Ansprechpartner.

Eine orangene Markierung eines Auftrages weist auf eine Änderung durch den Auftraggeber hin.

Nein, eine Ablehnung eingegangener Transportaufträge ist nicht möglich. Bei etwaigen Anliegen wenden Sie sich bitte über die "Kontakt"-Funktion des betreffenden Auftrags an den zugehörigen Ansprechpartner.

Durch das Öffnen des Transportauftrages können Sie die VIN einsehen. Klicken Sie dazu in der Übersicht der Transportaufträge auf den gewünschten Transportauftrag. Dadurch öffnet sich die Sidebar mit weiteren Details. Hier finden Sie einen Link mit der Aufschrift "Störfall melden", über den Sie einen Störfall aufnehmen können.

Serviceaufträge bezeichnen Aufträge zur Durchführung von speziellen Services am Fahrzeug. Die Inhalte eines Serviceauftrags spezifizieren die durchzuführende Leistung. Sie können die Beendung eines Services melden sowie, abhängig von Serviceauftrag, zusätzliche Informationen mitteilen.