Sv translation

language	de

Liefert die Statusmeldungen von Aufträgen zurück.

Beschreibung

Status

colour	Green
title	GET

order_management/get_orderstate.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
vehicle	RTI Fahrzeugschlüssel	string	Entweder vehicle, group oder import Parameter	(ja)
group	RTI Fahrzeuggruppenschlüssel (alle Fahrzeuge einer Gruppe)	string	Entweder vehicle, group oder import Parameter	(ja)
import	RTI Importschlüssel (alle Fahrzeuge)	string	Entweder vehicle, group oder import Parameter	(ja)
customorderid	eigene Auftragsnummer	string	Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO	(ja)^*1
start	Datum ab dem alle Auftragsstatus zurückgegeben werden	string	Format: YYYYMMDDHHMMSS	(ja)^*1
end	Datum bis zu dem alle Auftragsstatus zurückgegeben werden	string	Format: YYYYMMDDHHMMSS Die maximale Zeitspanne beträgt 7 Tage.	(ja)^*1
datetype	Art des Datums welches für die Datumseinschränkung genutzt werden soll	string	Mögliche Werte: gps (Standard) insert	nein
format	Ausgabeformat	string	Möglich Werte: csv (Standard) json	nein

^{*1 Pflicht ist entweder customorderid oder ( start und end )}

Rückgabe

Es wird ein string zurück gegeben. Ansonsten wird bei einem Fehler ein "ERROR:Beschreibung" zurückgegeben.

CSV Format

Das Ergebnis (sofern Auftragsdaten gefunden wurden) ist eine CSV Liste. Die erste Zeile ist Header und enthält die Feldnamen. Als Textbegrenzer wird das Doppelte Hochkomma verwendet.

Metainformationen

Trennzeichen	Komma( , )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1

Spaltenbeschreibung

Spalte	Beschreibung
CUSTORDERID	eigene Auftragsnummer
DATE	Datum der ausgeführten Aktion	DD.MM.YYYY HH:MM:SS
STATE	Beschreibung der Aktion
SOURCETYPE	Auslösertyp der Aktion	PND (für Fahrzeug oder RTI) oder PORTAL
SOURCE	Auslöser der Aktion	Person/System
STATE_IDENT	Kennung des Status (sofern vergeben)
STATE_LANG	Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde
STATE_TRANS	Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde
META	Meta Info
REQUESTDATE	Anfragezeitpunkt
RTI_IDENT	RTI Ident des Fahrzeuges

Beispiel

Code Block

"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"
"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"

JSON Format

Beispiel

Code Block

[
    {
        "gpsdate": "18.07.2022 09:43:42",
        "requestdate": "21.07.2022 06:43:45",
        "custom_order_id": "Auftrag 123",
        "state": "Zustellungsversuch",
        "state_trans": null,
        "state_lang": null,
        "state_ident": null,
        "meta": null,
        "source_type": "PORTAL",
        "source": "FTL YF 123",
        "rti_ident": "rti123"
    }
]

Mögliche Fehlerwerte

Fehler	Beschreibung
MISSING_COMPANY	Firmenschlüssel fehlt
INVALID_COMPANY	Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
ERROR_MAINTENANCE	Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
INVALID_KEY(VEHICLE\|GROUP\|IMPORT)	Der gegebene RTI Schlüssel entspricht nicht dem erwarteten Format
NO_KEY_GIVEN(VEHICLE\|GROUP\|IMPORT)	Es wurde kein RTI Schlüssel zur Fahrzeugidentifizierung angegeben.
INVALID_VEHICLE_KEY / INVALID_GROUP_KEY	Es wurden keine Fahrzeuge mit dem angegebenen Schlüssel gefunden.
ERROR_MISSING_CUSTORDERID\|DATEFROM\|DATETO	Sie müssen entweder eine Auftragsnummer oder ein Start- und Enddatum für eine valide Anfrage angeben.
ERROR_INVALID_DATEFROM	Sie haben ein Startdatum angegeben, welches nicht dem erforderlichen Format entspricht.
ERROR_INVALID_DATETO	Sie haben ein Enddatum angegeben, welches nicht dem erforderlichen Format entspricht.
ERROR_INVALID_DATERANGE	Ihr Start- und Enddatum sind entweder mehr als 7 Tage auseinander oder Ihr Enddatum liegt vor Ihrem Startdatum.
ERROR_INVALID_FORMAT	Sie haben ein unbekanntes Ausgabeformat angegeben.
ERROR_INVALID_DATE_TYPE	Sie haben einen unbekannten Datumstyp angegeben.
ERROR_ORDER_NOT_FOUND	Suche über die Auftragsnummer: Es konnte kein Auftrag mit dieser Nummer gefunden werden.
ERROR_DUPLICATE_CUSTOMORDERID	Suche über die Auftragsnummer: Es wurden mehrere Aufträge mit dieser Nummer gefunden. Diese Funktion kann nur für eindeutig identifizierbare Aufträge genutzt werden.

Beispielaufruf

Code Block
https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&start=20220501000000&end=20220508000000&format=json

Sv translation

language	en

Returns the status messages of orders.

Description

Status

colour	Green
title	GET

order_management/get_orderstate.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS

Parameters

parameter	description	type	hint	mandatory
company	RTI company key	string		yes
vehicle	RTI vehicle key	string	either vehicle, group or import parameter	(yes)
group	RTI vehicle group key (all vehicles of a group)	string	either vehicle, group or import parameter	(yes)
import	RTI import key (all vehicles)	string	either vehicle, group or import parameter	(yes)
customorderid	user-defined order number	string	either set this field or start and end	(yes)^*1
start	date from which to return order states	string	Format: YYYYMMDDHHMMSS	(yes)^*1
end	date to which to return order states	string	Format: YYYYMMDDHHMMSS The maximum time span is 7 days.	(yes)^*1
datetype	type of date to be used for date restriction	string	Possible values: gps (default) insert	no
format	output format	string	Possible values: csv (default) json	no

^{*1 mandatory is either customorderid or ( start and end )}

Return value

A string will be returned. On error you will receive "ERROR:description".

CSV format

First line is the header with field names. We use a double quote as text delimiter.

Meta information

separator	comma ( , )
text delimiter	double quote ( " )
line end	0x0D 0x0A (CarriageReturn LineFeed)
header	line 1

Column description

column	description
CUSTORDERID	user-defined order number
DATE	date of pressed state	DD.MM.YYYY HH:MM:SS
STATE	state text which was pressed
SOURCETYPE	type of source	PND (if vehicle or RTI) or PORTAL
SOURCE	who triggered this action	person/system name
STATE_IDENT	user-defined ident of state if given
STATE_LANG	country code, if the state was pressed in another language than german
STATE_TRANS	translated state text, if the state was pressed in another language than german
META	meta info
REQUESTDATE	request date
RTI_IDENT	RTI ident of vehicle

Example

Code Block

"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"
"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"

JSON format

Example

Code Block

[
    {
        "gpsdate": "18.07.2022 09:43:42",
        "requestdate": "21.07.2022 06:43:45",
        "custom_order_id": "Auftrag 123",
        "state": "Zustellungsversuch",
        "state_trans": null,
        "state_lang": null,
        "state_ident": null,
        "meta": null,
        "source_type": "PORTAL",
        "source": "FTL YF 123",
        "rti_ident": "rti123"
    }
]

Possible error values

error	description
MISSING_COMPANY	company key is missing
INVALID_COMPANY	Company not found. Migth be due to faulty company or import key.
ERROR_MAINTENANCE	Your company is under maintenance, at the moment no requests are possible.
INVALID_KEY(VEHICLE\|GROUP\|IMPORT)	The given RTI key does not match the expected structure.
NO_KEY_GIVEN(VEHICLE\|GROUP\|IMPORT)	No RTI key to identify any vehicles was given.
INVALID_VEHICLE_KEY / INVALID_GROUP_KEY	No vehicles which match the RTI keys were found.
ERROR_MISSING_CUSTORDERID\|DATEFROM\|DATETO	You have to set either a custom order id or start and end for a valid request,
ERROR_INVALID_DATEFROM	You have entered a start date, which does not match the needed format.
ERROR_INVALID_DATETO	You have entered an end date, which does not match the needed format.
ERROR_INVALID_DATERANGE	Your start and end date are either more than 7 days apart or your end date is before your start date.
ERROR_INVALID_FORMAT	You have entered an unknown output format.
ERROR_INVALID_DATE_TYPE	You have entered an unknown date type.
ERROR_ORDER_NOT_FOUND	Search via custom order id: No order with given order number was found.
ERROR_DUPLICATE_CUSTOMORDERID	Search via custom order id: Multiple orders with given order number were found. This function can only be used to gather states for orders which unique identifiers.

Example call

Code Block

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&format=json

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&start=20220501000000&end=20220508000000&format=csv

Page tree

Versions Compared

Old Version 6

New Version 7

Key

Beschreibung

Parameter

Rückgabe

CSV Format

Metainformationen

Spaltenbeschreibung

Beispiel

JSON Format

Beispiel

Mögliche Fehlerwerte

Beispielaufruf

Description

Parameters

Return value

CSV format

Meta information

Column description

Example

JSON format

Example

Possible error values

Example call

Page tree

Page History

Versions Compared

Old Version 6

New Version 7

Key

Beschreibung

Parameter

Rückgabe

CSV Format

Metainformationen

Spaltenbeschreibung

Beispiel

JSON Format

Beispiel

Mögliche Fehlerwerte

Beispielaufruf

Description

Parameters

Return value

CSV format

Meta information

Column description

Example

JSON format

Example

Possible error values

Example call