Wiki-Quellcode von get_orderstate_v2.asp
Zuletzt geändert von YellowFox_RD am 2025/01/20 15:37
Zeige letzte Bearbeiter
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Inhaltsverzeichnis))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | (% class="red mark" %)DEPRECATED(%%) | ||
| 6 | Liefert die Statusmeldungen von Aufträgen zurück. | ||
| 7 | = Beschreibung = | ||
| 8 | //**(% class="green mark" %)GET(%%) get_orderstate_v2.asp?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY**&DATEFROM**=YYYYMMDD**&DATETO**=YYYYMMDD**&timefrom=**HHMMSS**&timeto**=HHMMSS**&datetype=**insertdate// | ||
| 9 | = Parameter = | ||
| 10 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
| 11 | |company|RTI Firmenschlüssel|string||ja | ||
| 12 | |vehicle|RTI Fahrzeugschlüssel|string|Entweder vehicle, group oder import Parameter|(ja) | ||
| 13 | |group|RTI Fahrzeuggruppenschlüssel (alle Fahrzeuge einer Gruppe)|string|Entweder vehicle, group oder import Parameter | ||
| 14 | Nur über Zeitauswahl|(ja) | ||
| 15 | |import|RTI Importschlüssel (alle Fahrzeuge)|string|Entweder vehicle, group oder import Parameter | ||
| 16 | Nur über Zeitauswahl|(ja) | ||
| 17 | |CUSTORDERID|eigene Auftragsnummer|string|Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO|(ja)^^*1^^ | ||
| 18 | |DATEFROM|Datum ab dem alle Auftragsstatus zurückgegeben werden|string|Format: YYYYMMDD oder DD.MM.YYYY|(ja)^^*1^^ | ||
| 19 | |DATETO|Datum bis zu dem alle Auftragsstatus zurückgegeben werden|string|Format: YYYYMMDD oder DD.MM.YYYY | ||
| 20 | Die maximale Zeitspanne beträgt 7 Tage.|(ja)^^*1^^ | ||
| 21 | |timefrom|Präzisierung des Anfangsdatums mit der Zeit|string|Format: HHMMSS|nein | ||
| 22 | |timeto|Präzisierung des Enddatums mit der Zeit|string|Format: HHMMSS|nein | ||
| 23 | |datetype|"insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sind|string||nein | ||
| 24 | |||
| 25 | ^^*1 Pflicht ist entweder CUSTORDERID oder ( DATEFROM und DATETO )^^ | ||
| 26 | = Rückgabe = | ||
| 27 | Es wird ein** string **zurück gegeben. Ansonsten wird bei einem Fehler ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben | ||
| 28 | == CSV Format == | ||
| 29 | 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. | ||
| 30 | === Metainformationen === | ||
| 31 | |=Trennzeichen|Komma( , ) | ||
| 32 | |=Textbegrenzer|Doppeltes Hochkomma ( " ) | ||
| 33 | |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 34 | |=Header|Zeile 1 | ||
| 35 | |||
| 36 | === Spalten bei Abfrage über eigene Auftragsnummer === | ||
| 37 | |=Spalte|=Beschreibung|= | ||
| 38 | |DATE|Datum der ausgeführten Aktion|DD.MM.YYYY HH:MM:SS | ||
| 39 | |STATE|Beschreibung der Aktion| | ||
| 40 | |SOURCETYPE|Auslösertyp der Aktion|PND für Fahrzeug oder RTI oder PORTAL | ||
| 41 | |SOURCE|Auslöser der Aktion|Person/Fahrzeugkennzeichen | ||
| 42 | |||
| 43 | === Spalten bei Abfrage über Zeitraum === | ||
| 44 | |=Spalte|=Beschreibung|= | ||
| 45 | |CUSTORDERID|eigene Auftragsnummer| | ||
| 46 | |DATE|Datum der ausgeführten Aktion|DD.MM.YYYY HH:MM:SS | ||
| 47 | |STATE|Beschreibung der Aktion| | ||
| 48 | |SOURCETYPE|Auslösertyp der Aktion|PND für Fahrzeug oder RTI oder PORTAL | ||
| 49 | |SOURCE|Auslöser der Aktion|Person/System | ||
| 50 | |REQUESTDATE|Systemzeit der Abfrage| | ||
| 51 | |META|Meta Info| | ||
| 52 | |RTI_IDENT|RTI Ident des Fahrzeuges|(nur über Importschlüssel oder Gruppenschlüssel Abfrage) | ||
| 53 | |STATE_IDENT|Kennung des Status (sofern vergeben)| | ||
| 54 | |STATE_LANG|Ländercode, falls der Status in einer anderen Sprache am Display gedrückt wurde| | ||
| 55 | |STATE_TRANS|Übersetzung des Statustext, falls der Status in einer anderen Sprache am Display gedrückt wurde| | ||
| 56 | |||
| 57 | === Mögliche Statustexte === | ||
| 58 | ((( | ||
| 59 | * Zustellungsversuch (YellowFox versucht den Auftrag auf das Display zu senden) | ||
| 60 | * Zustellung erfolgreich (Der Auftrag ist erfolgreich auf dem Display angekommen) | ||
| 61 | * Gelesen (Der Auftrag wurde auf dem Display gelesen) | ||
| 62 | * selbst definierte Auftragsstatus(Auftragsverwaltung~-~->Einstellungen) | ||
| 63 | ))) | ||
| 64 | === Garminspezifische Rückgaben === | ||
| 65 | ((( | ||
| 66 | * Gelesen - Auftrag Inaktiv | ||
| 67 | * Aktiv | ||
| 68 | * Erledigt | ||
| 69 | * Gelöscht | ||
| 70 | ))) | ||
| 71 | === Beispiel === | ||
| 72 | **Rückgabe in CSV** | ||
| 73 | {{code language="java"}}"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","REQUESTDATE","META" | ||
| 74 | "ORDER1","04.08.2010 09:34:49","Erledigt","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO" | ||
| 75 | "ORDER1","04.08.2010 09:34:17","Aktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO" | ||
| 76 | "ORDER1","04.08.2010 09:33:18","Gelesen - Auftrag Inaktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO" | ||
| 77 | "ORDER1","04.08.2010 09:29:15","Zustellung erfolgreich","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO" | ||
| 78 | "ORDER1","04.08.2010 09:29:09","Zustellungsversuch","PORTAL","RTI","04.08.2010 09:35:00","META_INFO"{{/code}} | ||
| 79 | |||
| 80 | = Beispielaufrufe = | ||
| 81 | **Abfrage für Auftrag** | ||
| 82 | {{code language="java"}}https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789{{/code}} | ||
| 83 | |||
| 84 | **Abfrage für Zeitraum 04.05.2015 00:00:00 - 06.05.2015 23:59:59** | ||
| 85 | {{code language="java"}}https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&DATEFROM=20150504&DATETO=20150506&timefrom=000000&timeto=235959&datetype=insertdate{{/code}} | ||
| 86 |