get_orderstate_v2.asp
Table of Contents
DEPRECATED
Gets the status messages of an order.
Description
GET get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate
Parameter
| Parameter | Description | Type | Note | Required |
|---|---|---|---|---|
| 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 )
Return
A string is returned. Otherwise on error a "ERROR:Description" is returned.
CSV Format
The result (if order data was found) is a CSV list. The first row defines the header and contains the column namens.
Meta informations
| Separator | Comma (,) |
|---|---|
| Delimiter | Double quote( " ) |
| Lineend | 0x0D 0x0A (CarriageReturn LineFeed) |
| Header | Line 1 |
Columns for request by order number
| Column | Description | |
|---|---|---|
| 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
| Column | Description | |
|---|---|---|
| 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
return in csv
"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
Request for a order
https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789
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