Wiki source code of get_orderstate_v2.asp
Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | (% class="box" %) | ||
| 2 | (((Table of Contents))) | ||
| 3 | {{toc/}} | ||
| 4 | |||
| 5 | (% class="red mark" %)DEPRECATED(%%) | ||
| 6 | Gets the status messages of an order. | ||
| 7 | = Description = | ||
| 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|=Description|=Type|=Note|=Required | ||
| 11 | |company|RTI company key|string||yes | ||
| 12 | |vehicle|RTI vehicle key|string|Either vehicle, group or import parameter|(yes) | ||
| 13 | |group|RTI vehicle group key|string|Either vehicle, group or import parameter | ||
| 14 | Only with time selection|(yes) | ||
| 15 | |import|RTI import key (all vehicles)|string|Either vehicle, group or import parameter | ||
| 16 | Only with time selection|(yes) | ||
| 17 | |CUSTORDERID|Own order number|string|Either this field is set, or DATEFROM and DATETO|(yes)*1 | ||
| 18 | |DATEFROM|Start date to return the orders from.|string|Format: YYYYMMDD or DD.MM.YYYY|(yes)*1 | ||
| 19 | |DATETO|End date to return the orders to.|string|Format: YYYYMMDD or DD.MM.YYYY | ||
| 20 | The max. timespan is 7 days.|(yes)*1 | ||
| 21 | |timefrom|Clarification of the beginning date of the time|string|Format: HHMMSS|no | ||
| 22 | |timeto|Clarification of the ending date of the time|string|Format: HHMMSS|no | ||
| 23 | |datetype|"insertdate" return all entries inside the timerange, depending to server insertion date.|string||no | ||
| 24 | |||
| 25 | *1 Manadatory is either CUSTORDERID or ( DATEFROM and DATETO ) | ||
| 26 | = Return = | ||
| 27 | A** string **is returned. Otherwise on error a "(% class="error" %)**ERROR:Description**(%%)" is returned. | ||
| 28 | == CSV Format == | ||
| 29 | The result (if order data was found) is a CSV list. The first row defines the header and contains the column namens. | ||
| 30 | === Meta informations === | ||
| 31 | |=Separator|Comma (,) | ||
| 32 | |=Delimiter|Double quote( " ) | ||
| 33 | |=Lineend|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 34 | |=Header|Line 1 | ||
| 35 | |||
| 36 | === Columns for request by order number === | ||
| 37 | |=Column|=Description|= | ||
| 38 | |DATE|The action date|DD.MM.YYYY HH:MM:SS | ||
| 39 | |STATE|The action description| | ||
| 40 | |SOURCETYPE|The action trigger type|PND for vehicle or RTI or PORTAL | ||
| 41 | |SOURCE|The action trigger|Person/vehicle sign | ||
| 42 | |||
| 43 | === Columns for request by time range === | ||
| 44 | |=Column|=Description|= | ||
| 45 | |CUSTORDERID|own order number| | ||
| 46 | |DATE|The action date|DD.MM.YYYY HH:MM:SS | ||
| 47 | |STATE|The action description| | ||
| 48 | |SOURCETYPE|The action trigger type|PND for vehicle or RTI or PORTAL | ||
| 49 | |SOURCE|The action trigger|Person/System | ||
| 50 | |REQUESTDATE|The request system date time| | ||
| 51 | |META|meta info| | ||
| 52 | |RTI_IDENT|RTI Ident|only via import key or group key request | ||
| 53 | |STATE_IDENT|custom ident (if set)| | ||
| 54 | |STATE_LANG|country code, if status was selected in another language on the display| | ||
| 55 | |STATE_TRANS|translation of status text, if status was selected in another language on the display| | ||
| 56 | |||
| 57 | === Possible status texts === | ||
| 58 | ((( | ||
| 59 | * delivery attempt | ||
| 60 | * delivery successful | ||
| 61 | * read | ||
| 62 | * self-defined order statuses(order management~-~->settings) | ||
| 63 | ))) | ||
| 64 | === Garmin specific return values === | ||
| 65 | ((( | ||
| 66 | * read - Order Inactive | ||
| 67 | * active | ||
| 68 | * done | ||
| 69 | * deleted | ||
| 70 | ))) | ||
| 71 | === Example === | ||
| 72 | **return 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 | = Example calls = | ||
| 81 | **Request for a order** | ||
| 82 | {{code language="java"}}https://map.yellowfox.de/rti/get_orderstate_v2.asp?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&CUSTORDERID=123456789{{/code}} | ||
| 83 | |||
| 84 | **Request for a date time range 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 |