order_management/get_orderstate.php

1

(% class="box" %)

2

(((Inhaltsverzeichnis)))

3

4

5

Liefert die Statusmeldungen von Aufträgen zurück.

6

= Beschreibung =

7

//**(% class="green mark" %)GET(%%) order_management/get_orderstate.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY**&start**=YYYYMMDDHHMMSS**&end**=YYYYMMDDHHMMSS//

8

= Parameter =

9

10

|company|RTI Firmenschlüssel|string||ja

|end|Datum bis zu dem alle Auftragsstatus zurückgegeben werden|string|Format: YYYYMMDDHHMMSS

17

Die maximale Zeitspanne beträgt 7 Tage.|(ja)^^*1^^

18

|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ögliche Werte:

(((

* csv (Standard)

* json

)))|nein

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

30

= Rückgabe =

31

Es wird ein** string **zurück gegeben. Ansonsten wird bei einem Fehler ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.

32

== CSV Format ==

33

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.

34

=== Metainformationen ===

35

|=Trennzeichen|Komma( , )

36

|=Textbegrenzer|Doppeltes Hochkomma ( " )

37

|=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)

38

|=Header|Zeile 1

39

40

=== Spaltenbeschreibung ===

41

|=Spalte|=Beschreibung|=

42

|CUSTORDERID|eigene Auftragsnummer|

43

|DATE|Datum der ausgeführten Aktion|DD.MM.YYYY HH:MM:SS

44

|STATE|Beschreibung der Aktion|

45

|SOURCETYPE|Auslösertyp der Aktion|PND (für Fahrzeug oder RTI) oder PORTAL

46

|SOURCE|Auslöser der Aktion|Person/System

47

|STATE_IDENT|Kennung des Status (sofern vergeben)|

48

|STATE_LANG|Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde|

49

|STATE_TRANS|Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde|

50

|META|Meta Info|

51

|REQUESTDATE|Anfragezeitpunkt|

52

|RTI_IDENT|RTI Ident des Fahrzeuges|

=== Beispiel ===

{{code language="java"}}"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"

57

"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"{{/code}}

== JSON Format ==

=== Beispiel ===

{{code language="java"}}[

63

{

64

"gpsdate": "18.07.2022 09:43:42",

65

"requestdate": "21.07.2022 06:43:45",

66

"custom_order_id": "Auftrag 123",

67

"state": "Zustellungsversuch",

"state_trans": null,

"state_lang": null,

"state_ident": null,

"meta": null,

"source_type": "PORTAL",

73

"source": "FTL YF 123",

74

"rti_ident": "rti123"

}

]{{/code}}

== Mögliche Fehlerwerte ==

79

|=Fehler|=Beschreibung

80

|MISSING_COMPANY|Firmenschlüssel fehlt

81

|INVALID_COMPANY|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.

82

|ERROR_MAINTENANCE|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.

83

|INVALID_KEY(VEHICLE~|GROUP~|IMPORT)|Der gegebene RTI Schlüssel entspricht nicht dem erwarteten Format

84

|NO_KEY_GIVEN(VEHICLE~|GROUP~|IMPORT)|Es wurde kein RTI Schlüssel zur Fahrzeugidentifizierung angegeben.

85

|INVALID_VEHICLE_KEY / INVALID_GROUP_KEY|Es wurden keine Fahrzeuge mit dem angegebenen Schlüssel gefunden.

86

|ERROR_MISSING_CUSTORDERID~|DATEFROM~|DATETO|Sie müssen entweder eine Auftragsnummer oder ein Start- und Enddatum für eine valide Anfrage angeben.

87

|ERROR_INVALID_DATEFROM|Sie haben ein Startdatum angegeben, welches nicht dem erforderlichen Format entspricht.

88

|ERROR_INVALID_DATETO|Sie haben ein Enddatum angegeben, welches nicht dem erforderlichen Format entspricht.

89

|ERROR_INVALID_DATERANGE|Ihr Start- und Enddatum sind entweder mehr als 7 Tage auseinander oder Ihr Enddatum liegt vor Ihrem Startdatum.

90

|ERROR_INVALID_FORMAT|Sie haben ein unbekanntes Ausgabeformat angegeben.

91

|ERROR_INVALID_DATE_TYPE|Sie haben einen unbekannten Datumstyp angegeben.

92

|ERROR_ORDER_NOT_FOUND|Suche über die Auftragsnummer: Es konnte kein Auftrag mit dieser Nummer gefunden werden.

93

|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 =

== JSON ==

{{code language="java"}}https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&format=json

99

100

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=Auftrag 123&format=json {{/code}}

== CSV ==

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

105

106

https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20220501000000&end=20220508000000&format=csv{{/code}}

107

Wiki-Quellcode von order_management/get_orderstate.php

Navigation

author	version	line-number	content
		1	(% class="box" %)
		2	(((Inhaltsverzeichnis)))
		3	{{toc/}}
		4
		5	Liefert die Statusmeldungen von Aufträgen zurück.
		6	= Beschreibung =
		7	//(% class="green mark" %)GET(%%) order_management/get_orderstate.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS//
		8	= Parameter =
		9	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
		10	\|company\|RTI Firmenschlüssel\|string\|\|ja
		11	\|vehicle\|RTI Fahrzeugschlüssel\|string\|Entweder vehicle, group oder import Parameter\|(ja)
		12	\|group\|RTI Fahrzeuggruppenschlüssel (alle Fahrzeuge einer Gruppe)\|string\|Entweder vehicle, group oder import Parameter\|(ja)
		13	\|import\|RTI Importschlüssel (alle Fahrzeuge)\|string\|Entweder vehicle, group oder import Parameter\|(ja)
		14	\|customorderid\|eigene Auftragsnummer\|string\|Entweder dieses Feld ist gesetzt, oder start und end\|(ja)^^*1^^
		15	\|start\|Datum ab dem alle Auftragsstatus zurückgegeben werden\|string\|Format: YYYYMMDDHHMMSS\|(ja)^^*1^^
		16	\|end\|Datum bis zu dem alle Auftragsstatus zurückgegeben werden\|string\|Format: YYYYMMDDHHMMSS
		17	Die maximale Zeitspanne beträgt 7 Tage.\|(ja)^^*1^^
		18	\|datetype\|Art des Datums welches für die Datumseinschränkung genutzt werden soll\|string\|Mögliche Werte:
		19	(((
		20	* gps (Standard)
		21	* insert
		22	)))\|nein
		23	\|format\|Ausgabeformat\|string\|Mögliche Werte:
		24	(((
		25	* csv (Standard)
		26	* json
		27	)))\|nein
		28
		29	^^*1 Pflicht ist entweder customorderid oder ( start und end )^^
		30	= Rückgabe =
		31	Es wird ein string zurück gegeben. Ansonsten wird bei einem Fehler ein "(% class="error" %)ERROR:Beschreibung(%%)" zurückgegeben.
		32	== CSV Format ==
		33	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.
		34	=== Metainformationen ===
		35	\|=Trennzeichen\|Komma( , )
		36	\|=Textbegrenzer\|Doppeltes Hochkomma ( " )
		37	\|=Zeilenende\|0x0D 0x0A (CarriageReturn LineFeed)
		38	\|=Header\|Zeile 1
		39
		40	=== Spaltenbeschreibung ===
		41	\|=Spalte\|=Beschreibung\|=
		42	\|CUSTORDERID\|eigene Auftragsnummer\|
		43	\|DATE\|Datum der ausgeführten Aktion\|DD.MM.YYYY HH:MM:SS
		44	\|STATE\|Beschreibung der Aktion\|
		45	\|SOURCETYPE\|Auslösertyp der Aktion\|PND (für Fahrzeug oder RTI) oder PORTAL
		46	\|SOURCE\|Auslöser der Aktion\|Person/System
		47	\|STATE_IDENT\|Kennung des Status (sofern vergeben)\|
		48	\|STATE_LANG\|Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde\|
		49	\|STATE_TRANS\|Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde\|
		50	\|META\|Meta Info\|
		51	\|REQUESTDATE\|Anfragezeitpunkt\|
		52	\|RTI_IDENT\|RTI Ident des Fahrzeuges\|
		53
		54	=== Beispiel ===
		55
		56	{{code language="java"}}"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","STATE_IDENT","STATE_LANG","STATE_TRANS","META","REQUESTDATE","RTI_IDENT"
		57	"Auftrag 123","18.07.2022 09:43:42","Zustellungsversuch","PORTAL","FTL YF 123","","","","","21.07.2022 06:38:50","rti123"{{/code}}
		58
		59	== JSON Format ==
		60	=== Beispiel ===
		61
		62	{{code language="java"}}[
		63	{
		64	"gpsdate": "18.07.2022 09:43:42",
		65	"requestdate": "21.07.2022 06:43:45",
		66	"custom_order_id": "Auftrag 123",
		67	"state": "Zustellungsversuch",
		68	"state_trans": null,
		69	"state_lang": null,
		70	"state_ident": null,
		71	"meta": null,
		72	"source_type": "PORTAL",
		73	"source": "FTL YF 123",
		74	"rti_ident": "rti123"
		75	}
		76	]{{/code}}
		77
		78	== Mögliche Fehlerwerte ==
		79	\|=Fehler\|=Beschreibung
		80	\|MISSING_COMPANY\|Firmenschlüssel fehlt
		81	\|INVALID_COMPANY\|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
		82	\|ERROR_MAINTENANCE\|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
		83	\|INVALID_KEY(VEHICLE~\|GROUP~\|IMPORT)\|Der gegebene RTI Schlüssel entspricht nicht dem erwarteten Format
		84	\|NO_KEY_GIVEN(VEHICLE~\|GROUP~\|IMPORT)\|Es wurde kein RTI Schlüssel zur Fahrzeugidentifizierung angegeben.
		85	\|INVALID_VEHICLE_KEY / INVALID_GROUP_KEY\|Es wurden keine Fahrzeuge mit dem angegebenen Schlüssel gefunden.
		86	\|ERROR_MISSING_CUSTORDERID~\|DATEFROM~\|DATETO\|Sie müssen entweder eine Auftragsnummer oder ein Start- und Enddatum für eine valide Anfrage angeben.
		87	\|ERROR_INVALID_DATEFROM\|Sie haben ein Startdatum angegeben, welches nicht dem erforderlichen Format entspricht.
		88	\|ERROR_INVALID_DATETO\|Sie haben ein Enddatum angegeben, welches nicht dem erforderlichen Format entspricht.
		89	\|ERROR_INVALID_DATERANGE\|Ihr Start- und Enddatum sind entweder mehr als 7 Tage auseinander oder Ihr Enddatum liegt vor Ihrem Startdatum.
		90	\|ERROR_INVALID_FORMAT\|Sie haben ein unbekanntes Ausgabeformat angegeben.
		91	\|ERROR_INVALID_DATE_TYPE\|Sie haben einen unbekannten Datumstyp angegeben.
		92	\|ERROR_ORDER_NOT_FOUND\|Suche über die Auftragsnummer: Es konnte kein Auftrag mit dieser Nummer gefunden werden.
		93	\|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.
		94
		95	= Beispielaufruf =
		96	== JSON ==
		97
		98	{{code language="java"}}https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&customorderid=Auftrag 123&format=json
		99
		100	https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&customorderid=Auftrag 123&format=json {{/code}}
		101
		102	== CSV ==
		103
		104	{{code language="java"}}https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle=VEHICLE_KEY&start=20220501000000&end=20220508000000&format=csv
		105
		106	https://map.yellowfox.de/rti/order_management/get_orderstate.php?company=COMPANY_KEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20220501000000&end=20220508000000&format=csv{{/code}}
		107