Wiki-Quellcode von get_orders.php

Zuletzt geändert von YellowFox_RD am 2025/01/20 15:36
Zeige letzte Bearbeiter
1 (% class="box" %)
2 (((Inhaltsverzeichnis)))
3 {{toc/}}
4
5 Gibt eine Liste aller Aufträge, welche im angegebenem Zeitraum erstellt worden sind
6 = Beschreibung =
7 **(% class="green mark" %)GET(%%) get_orders.php**?**company**=COMPANY_RTIKEY&**vehicle**VEHICLE_RTIKEY&**start**=YYYYMMDDHHMMSS&**end**=YYYYMMDDHHMMSS&**format**=json
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 Gruppenschlüssel|string|entweder vehicle, group oder import Parameter|(ja)
13 |import|RTI Importschlüssel|string|entweder vehicle, group oder import Parameter|(ja)
14 |start|Beginn des Abfragezeitraumes|datestring|Format: YYYYMMDDHHMMSS
15 (((
16 * der maximale Zeitraum zwischen "//start//" und "//end//" beträgt 31 Tage
17 )))|ja
18 |end|Ende des Abfragezeitraumes|datestring|Format: YYYYMMDDHHMMSS
19 (((
20 * der maximale Zeitraum zwischen "//start//" und "//end//" beträgt 31 Tage
21 )))|ja
22 |only_ondisplay_created|Optional nur Rückgabe von Aufträgen, die auf dem Display erstellt wurden|int|Die Auftragserstellung ist nicht für alle Displaytypen verfügbar und muss jeweils freigeschalten werden
23 (((
24 * Gibt alle erstellten Auftrage zurück (Option nicht gesetzt oder "0")(((
25 * Gibt nur die Aufträge zurück, die auf dem Display erstellt wurden (Zuweisung "1")
26 )))
27 )))|nein
28 |format|Ausgabeformat|string|'csv' (Standard) oder 'json'|nein
29
30 = Rückgabe =
31 Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben
32 == CSV Format ==
33 Bei einer korrekten Anfrage werden die Daten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Dannach folgen dann die Daten
34 === Metainformationen ===
35 |=Trennzeichen|Semikolon ( ; )
36 |=Textbegrenzer|Doppeltes Hochkomma ( " )
37 |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
38 |=Header|Zeile 1
39 |=Kodierung|UTF-8
40
41 === Spalten ===
42 |=Spalte|=Beschreibung|=
43 |DATE|Auftragserstellungsdatum|Format: YYYY-MM-DD HH:MM:SS
44 |CUSTORDER|selbst definierte Auftragsnummer|
45 |TEXT|Auftragstext|
46 |VEHICLE|zugeordnetes Fahrzeug|
47 |DELETED_IN_VEHICLE|Auftrag bereits vom Fahrzeugdisplay gelöscht|(((
48 * 0 = nein
49 * 1 = ja
50 )))
51 |ACTIVE|ist der Auftrag gerade Aktiv|(((
52 * 0 = nein
53 * 1 = ja 
54 )))
55 |LAST_STATE_DATE|Datum der letzten Statusmeldung|Format YYYY-MM-DD HH:MM:SS
56 |LAST_STATE_TEXT|die eigentliche letzte Statusmeldung|
57 |LAST_STATE_IDENT|Kennung des Status (sofern vergeben)|
58 |LAST_STATE_LANG|Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde|
59 |LAST_STATE_TRANS|Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde|
60 |NAV_CUSTOMER|Kundenname|
61 |NAV_TEXT|Zieladresse|
62 |NAV_LAT|Geokoordinate der Zieladresse (Latitude)|
63 |NAV_LON|Geokoordinate der Zieladresse (Longitude)|
64 |FORM_NAME|zugeordnetes benutzerdefiniertes Formular|
65 |META|Meta Info|
66 |RTI_IDENT|RTI Ident des Fahrzeuges|
67
68 === JSON Format ===
69
70 {{code language="js"}}[
71 {
72 "create_date": "2022-03-15 09:43:30",
73 "custom_order_number": "ExampleNr",
74 "text": "Beispieltext",
75 "vehicle": {
76 "name": "YT 120",
77 "rtiIdent": "YT 120 Ident"
78 },
79 "is_deleted": false,
80 "is_active": true,
81 "last_state": {
82 "date": "2022-03-15 09:45:44",
83 "text": "start",
84 "custom_id": "",
85 "language": "",
86 "translations": ""
87 },
88 "target_information": {
89 "customer": "Nico@home",
90 "address": "Am Wuesteberg 3, 01723 Kesselsdorf, D",
91 "lat": 51.0096,
92 "lon": 13.8376,
93 "arrival_time_planned": "2022-03-15 16:00:00"
94 },
95 "form": {
96 "name": "Fotos"
97 },
98 "meta": ""
99 }
100 ]{{/code}}
101
102 === Beispiel ===
103 **Rückgabe in CSV**
104 {{code language="java"}}"DATE";"CUSTORDER";"TEXT";"VEHICLE";"DELETED_IN_VEHICLE";"ACTIVE";"LAST_STATE_DATE";"LAST_STATE_TEXT";"NAV_CUSTOMER";"NAV_TEXT";"NAV_LAT";"NAV_LON";"META";"RTI_IDENT"
105 "2012-12-27 14:39:00";"ORDER1";"TEXT1";"FZG1";"1";"0";"2012-12-27 13:44:44";"Auftrag im Display gelöscht";"";"";"";"";"";"Ident 1"
106 "2012-12-27 13:42:00";"ORDER2";"TEXT2";"FZG1";"0";"1";"2012-12-27 13:28:29";"Start";"";"";"";"";"";"Ident 1"
107 "2012-12-27 12:03:34";"ORDER3";"TEXT3";"FZG2";"1";"0";"2013-01-11 15:57:50";"Erledigt";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907";"";"Ident 1"
108 "2012-12-27 12:03:15";"ORDER4";"TEXT4";"FZG2";"0";"1";"2012-12-27 12:04:03";"Angenommen";"YellowFox";"D-01723 Kesselsdorf Am Wüstberg 3";"51.036307";"13.598907";"";"Ident 1"{{/code}}
109
110 = Beispielaufrufe =
111 **Alle Aufträge, die von und zu einem Fahrzeug gesendet wurden**
112 {{code language="java"}}https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE=VEHICLE_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS
113
114 https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&VEHICLE={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS{{/code}}
115
116 **Alle Aufträge, die auf irgendeinem der Fahrzeuge erstellt wurden**
117 {{code language="java"}}https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&only_ondisplay_created=1{{/code}}
118
119 **Alle Aufträge, die von oder an eine Fahrzeuggruppe gesendet wurden**
120 {{code language="java"}}https://map.yellowfox.de/rti/get_orders.php?company=COMPANY_RTIKEY&group=IMPORT_GROUPKEY&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS{{/code}}
121