You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 13 Next »

Gets the status messages of an order.

Description

get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&language=deu&DATEFROM=YYYYMMDD&DATETO=YYYYMMDD&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate

Parameter

parameter
description
type
note
required
companyRTI company keystring yes
vehicleRTI vehicle keystring yes
import

RTI import key (all vehicles)

stringOnly with time selectionyes
languageDefines the output language (deu/gbr/ita/fra)string
  • no value or "deu" = german
  • "gbr" = english
  • "fra" = french
  • "ita" = italian
no
CUSTORDERIDOwn order numberstringEither this field is set, or DATEFROM and DATETOyes
DATEFROMStart date to return the orders from.stringFormat: YYYYMMDD or DD.MM.YYYYyes
DATETOEnd date to return the orders to.stringFormat: YYYYMMDD or DD.MM.YYYY
The max. timespan is 7 days.		yes
timefromClarification of the beginning date of the timestringFormat: HHMMSSno
timetoClarification of the ending date of the timestringFormat: HHMMSSno
datetype"insertdate" return all entries inside the timerange, depending to server insertion date.string no

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

SeparatorSemicolon ( ; )
DelimiterDouble quote( " )
Lineend0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 1
EncodingUTF-8

Columns for request by order number

Column
Description
DATEThe action date (YYYY-MM-DD HH:MM:SS)
STATEThe action description
SOURCETYPEThe action trigger type (PND for vehicle or RTI or PORTAL)
SOURCEThe action trigger (Person/vehicle sign)

Columns for request by time range

Column
Description
CUSTORDERIDown order number
DATEThe action date (YYYY-MM-DD HH:MM:SS)
STATEThe action description
SOURCETYPEThe action trigger type (PND for vehicle or RTI or PORTAL)
SOURCEThe action trigger (Person/System)
REQUESTDATEThe request system date time

Possible status texts

  • delivery attempt
  • Zustellung erfolgreich
  • Gelesen
  • selbst definierte Auftragsstatus(Auftragsverwaltung-->Einstellungen)

Garmin specific return values

  • Gelesen - Auftrag Inaktiv
  • Aktiv
  • Erledigt
  • Gelöscht

Example

"CUSTORDERID","DATE","STATE","SOURCETYPE","SOURCE","REQUESTDATE"
"ORDER1","04.08.2010 09:34:49","Erledigt","PND","Fahrzeugname","04.08.2010 09:35:00"
"ORDER1","04.08.2010 09:34:17","Aktiv","PND","Fahrzeugname","04.08.2010 09:35:00"
"ORDER1","04.08.2010 09:33:18","Gelesen - Auftrag Inaktiv","PND","Fahrzeugname","04.08.2010 09:35:00"
"ORDER1","04.08.2010 09:29:15","Zustellung erfolgreich","PND","Fahrzeugname","04.08.2010 09:35:00"
"ORDER1","04.08.2010 09:29:09","Zustellungsversuch","PORTAL","RTI","04.08.2010 09:35:00"

Example calls

Request for a order
http://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&CUSTORDERID=123456789
http://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&language=deu&DATEFROM=20150504&DATETO=20150506&timefrom=000000&timeto=235959&datetype=insertdate
  • No labels