Sv translation |
---|
|
Liefert die Statusmeldungen von Aufträgen zurück. Beschreibung |
...
...
_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY& |
...
DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate Parameter | | | | |
---|
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 Nur über Zeitauswahl | (ja) |
|
...
import | RTI Importschlüssel (alle Fahrzeuge |
|
...
...
- kein Wert oder "deu" = Deutsch
- "gbr" = englisch
- "fra" = französisch
- "ita" = italienisch
...
Entweder vehicle, group oder import Parameter Nur über Zeitauswahl | (ja) | CUSTORDERID | eigene Auftragsnummer | string | Entweder dieses Feld ist gesetzt, oder DATEFROM und DATETO | (ja)*1 | DATEFROM | Datum ab dem alle |
|
...
Auftragsstatus zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY | (ja)*1 | DATETO | Datum bis zu dem alle |
|
...
Auftragsstatus zurückgegeben werden | string | Format: YYYYMMDD oder DD.MM.YYYY Die maximale Zeitspanne beträgt 7 Tage. | (ja)*1 | timefrom | Präzisierung des Anfangsdatums mit der Zeit | string | Format: HHMMSS | nein | timeto | Präzisierung des Enddatums mit der Zeit | string | Format: HHMMSS | nein | datetype | "insertdate" gibt alle Einträge zurück welche im abgefragten Zeitraum im Rechenzentrum verarbeitet worden sind | string |
|
...
*1 Pflicht ist entweder CUSTORDERID oder ( DATEFROM und DATETO ) |
...
...
ein string zurück gegeben. Ansonsten wird bei einem Fehler ein "ERROR:Beschreibung" zurückgegeben 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. |
...
...
, ) | Textbegrenzer | Doppeltes Hochkomma ( " ) |
---|
Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
---|
Header | Zeile 1 |
---|
|
...
...
Spalten bei Abfrage über 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/Fahrzeugkennzeichen |
|
...
...
Gibt Auftragsaktionen aus.
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.
Abfrage über eigene Auftragsnummer:
...
Spalten bei Abfrage über Zeitraum | |
|
---|
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 |
|
...
...
...
...
System | REQUESTDATE | Systemzeit der Abfrage |
| META | Meta Info |
| RTI_IDENT | RTI Ident des Fahrzeuges | (nur über Importschlüssel oder Gruppenschlüssel Abfrage) | 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 |
|
Mögliche Statustexte- Zustellungsversuch (YellowFox versucht den Auftrag auf das Display zu senden)
- Zustellung erfolgreich (Der Auftrag ist erfolgreich auf dem Display angekommen)
- Gelesen (Der Auftrag wurde auf dem Display gelesen)
|
Abfrage über Zeitraumabfrage:
- CUSTORDERID - eigene Auftragsnummer
- DATE - Datum der ausgeführten Aktion
- STATE - Beschreibung der Aktion
- SOURCETYPE - Auslösertyp der Aktion (PND für Fahrzeug oder RTI oder PORTAL)
- SOURCE - Auslöser der Aktion (Person/System)
- REQUESTDATE - Systemzeit der Abfrage
DATEFROM und DATETO müssen im Format DD.MM.YYYY oder YYYYMMDD angegeben werden. Die maximale Zeitspanne beträgt 7 Tage.
Mögliche Statustexte:
...
- selbst definierte Auftragsstatus(Auftragsverwaltung-->Einstellungen)
Garminspezifische Rückgaben- Gelesen - Auftrag Inaktiv
- Aktiv
- Erledigt
- Gelöscht
|
Beispiel:
Beispiel Code Block |
---|
| "CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","REQUESTDATE","META"
"ORDER1","04.08.2010 09:34:49","Erledigt","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:34:17","Aktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:33:18","Gelesen - Auftrag Inaktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:15","Zustellung erfolgreich","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:09","Zustellungsversuch","PORTAL","RTI","04.08.2010 09:35:00","META_INFO" |
Beispielaufrufe Code Block |
---|
| https://map.yellowfox.de/rti/get_orderstate_v2.asp?company= |
|
...
...
RTI_VEHICLEKEY&CUSTORDERID= |
|
...
Code Block |
---|
title | Abfrage für Zeitraum 04.05.2015 00:00:00 - 06.05.2015 23:59:59 |
---|
| https://map.yellowfox.de/rti/ |
|
oder
get_orderstate_v2.asp?company= |
|
...
...
=RTI_IMPORTKEY&DATEFROM=20150504&DATETO=20150506&timefrom=000000&timeto=235959&datetype=insertdate |
|
Sv translation |
---|
|
Code Block |
---|
Gets the status messages of an order. Description get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate |
Beispiel Abfrage mit Zeitraumauswahl:
Parameter | | | | |
---|
company | RTI company key | string |
| yes | vehicle | RTI vehicle key | string | Either vehicle, group or import parameter | (yes) | group | RTI vehicle group key | string | Either vehicle, group or import parameter Only with time selection | (yes) | import | RTI import key (all vehicles) | string | Either vehicle, group or import parameter Only with time selection | (yes) | CUSTORDERID | Own order number | string | Either this field is set, or DATEFROM and DATETO | (yes)*1 | DATEFROM | Start date to return the orders from. | string | Format: YYYYMMDD or DD.MM.YYYY | (yes)*1 | DATETO | End date to return the orders to. | string | Format: YYYYMMDD or DD.MM.YYYY The max. timespan is 7 days. | (yes)*1 | timefrom | Clarification of the beginning date of the time | string | Format: HHMMSS | no | timeto | Clarification of the ending date of the time | string | Format: HHMMSS | no | datetype | "insertdate" return all entries inside the timerange, depending to server insertion date. | string |
| no |
*1 Manadatory is either CUSTORDERID or ( DATEFROM and DATETO ) ReturnA string is returned. Otherwise on error a "ERROR:Description" is returned. The result (if order data was found) is a CSV list. The first row defines the header and contains the column namens. Separator | Comma (,) |
---|
Delimiter | Double quote( " ) |
---|
Lineend | 0x0D 0x0A (CarriageReturn LineFeed) |
---|
Header | Line 1 |
---|
Columns for request by order number | |
|
---|
DATE | The action date | DD.MM.YYYY HH:MM:SS | STATE | The action description |
| SOURCETYPE | The action trigger type | PND for vehicle or RTI or PORTAL | SOURCE | The action trigger | Person/vehicle sign |
Columns for request by time range | |
|
---|
CUSTORDERID | own order number |
| DATE | The action date | DD.MM.YYYY HH:MM:SS | STATE | The action description |
| SOURCETYPE | The action trigger type | PND for vehicle or RTI or PORTAL | SOURCE | The action trigger | Person/System | REQUESTDATE | The request system date time |
| META | meta info |
| RTI_IDENT | RTI Ident | only via import key or group key request | STATE_IDENT | custom ident (if set) |
| STATE_LANG | country code, if status was selected in another language on the display |
| STATE_TRANS | translation of status text, if status was selected in another language on the display |
|
Possible status texts- delivery attempt
- delivery successful
- read
- self-defined order statuses(order management-->settings)
Garmin specific return values- read - Order Inactive
- active
- done
- deleted
Example |
"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","REQUESTDATE","META"
"ORDER1","04.08.2010 09:34:49","Erledigt","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:34:17","Aktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:33:18","Gelesen - Auftrag Inaktiv","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:15","Zustellung erfolgreich","PND","Fahrzeugname","04.08.2010 09:35:00","META_INFO"
"ORDER1","04.08.2010 09:29:09","Zustellungsversuch","PORTAL","RTI","04.08.2010 09:35:00","META_INFO" |
|
...
Example calls Code Block |
---|
| https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789 |
Code Block |
---|
title | Request for a date time range 04.05.2015 00:00:00 - 06.05.2015 23:59:59 |
---|
| 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 |
|