Wiki source code of get_messagestate.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 | |||
| 7 | Return message states | ||
| 8 | = Description = | ||
| 9 | //**get_messagestate.asp?company**=RTI_COMPANYKEY**&vehicle**=RTI_VEHICLEKEY&**language=**deu**&DATEFROM**=YYYYMMDD**&DATETO**=YYYYMMDD**&timefrom=**HHMMSS**&timeto**=HHMMSS**&datetype=**insertdate// | ||
| 10 | = Parameter = | ||
| 11 | |=Parameter|=Description|=Type|=Note|=Mandatory | ||
| 12 | |company|RTI company key|string||yes | ||
| 13 | |vehicle|RTI vehicle key|string|only used for secondary authentification|yes | ||
| 14 | |language|define output language|string|((( | ||
| 15 | * kein Wert oder "deu" = Deutsch | ||
| 16 | * "gbr" = englisch | ||
| 17 | * "fra" = französisch | ||
| 18 | * "ita" = italienisch | ||
| 19 | )))|no | ||
| 20 | |sessionkey|SeesionKey from "do_message.asp|string|this field or DATEFROM and DATETO are mandatory|yes | ||
| 21 | |DATEFROM|begin of requested timerange|string|Format: YYYYMMDD|yes | ||
| 22 | |DATETO|end of requested timerange|string|Format: YYYYMMDD | ||
| 23 | Maximum time range is 7 days|yes | ||
| 24 | |timefrom|more precise of DATEFROM|string|Format: HHMMSS|no | ||
| 25 | |timeto|more precise if DATETO|string|Format: HHMMSS|no | ||
| 26 | |datetype|"insertdate" returns all states which are processed/inserted at data center in the requested timerange|string||no | ||
| 27 | |||
| 28 | = Return = | ||
| 29 | A **string **will be returned. In case of error "(% class="error" %)**ERROR:Description**(%%)" is given. | ||
| 30 | == Query by Sessionkey == | ||
| 31 | === Metainformations === | ||
| 32 | |=Delimiter|Comma ( , ) | ||
| 33 | |=Text Delimiter|not available | ||
| 34 | |=Line End|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 35 | |=Header|Line 1 | ||
| 36 | |||
| 37 | === Columns === | ||
| 38 | |=Column|=Description|= | ||
| 39 | |DATE|Date of state action|Format: DD.MM.YYYY HH:MM:SS | ||
| 40 | |STATE|Description of state action| | ||
| 41 | |SOURCE|source of state action|Person/Vehcile | ||
| 42 | |||
| 43 | === Example === | ||
| 44 | |||
| 45 | {{code language="java"}}DATE,STATE,SOURCE | ||
| 46 | 04.08.2010 09:48:41,Nachricht gelöscht,PND / Fahrzeugname | ||
| 47 | 04.08.2010 09:43:24,Nachricht gelesen,PND / Fahrzeugname | ||
| 48 | 04.08.2010 09:42:24,Zugestellt,PND / Fahrzeugname | ||
| 49 | 04.08.2010 09:41:54,Zustellungsversuch,PORTAL / RTI{{/code}} | ||
| 50 | |||
| 51 | == Return via time range == | ||
| 52 | === Metainformations === | ||
| 53 | |=Delimiter|Comma ( , ) | ||
| 54 | |=Text Delimiter|Double Quote ( " ) | ||
| 55 | |=Line End|0x0D 0x0A (CarriageReturn LineFeed) | ||
| 56 | |=Header|Line 1 | ||
| 57 | |||
| 58 | === Columns === | ||
| 59 | |=Spalte|=Beschreibung|= | ||
| 60 | |DATE|Date of state action|Format: DD.MM.YYYY HH:MM:SS | ||
| 61 | |STATE|Description of state action| | ||
| 62 | |SOURCE|source of state action (Person)| | ||
| 63 | |SRCNAME|source of state action (System)| | ||
| 64 | |KEY|Sessionkey of message| | ||
| 65 | |REQUESTDATE|Systemtime of request|Format: DD.MM.YYYY HH:MM:SS | ||
| 66 | |INSERTDATE|Systemtime of insert|Format: DD.MM.YYYY HH:MM:SS | ||
| 67 | |||
| 68 | **Example** | ||
| 69 | |||
| 70 | {{code language="java"}}"DATE","STATE","SOURCE","SRCNAME","KEY","REQUESTDATE","INSERTDATE" | ||
| 71 | "04.08.2010 09:48:41","Nachricht gelöscht","PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:49:23" | ||
| 72 | "04.08.2010 09:43:24","Nachricht gelesen",PND","Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:44:10" | ||
| 73 | "04.08.2010 09:42:24","Zugestellt",PND,"Fahrzeugname","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:43:11" | ||
| 74 | "04.08.2010 09:41:54","Zustellungsversuch","PORTAL","RTI","ABABABABABABABABABABABABABABABAB","04.08.2010 09:50:00","04.08.2010 09:42:11"{{/code}} | ||
| 75 | |||
| 76 | = Example Calls = | ||
| 77 | **Query by SessionKey** | ||
| 78 | {{code language="java"}}https://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY{{/code}} | ||
| 79 | |||
| 80 | **Query by time range based on insert date** | ||
| 81 | {{code language="java"}}https://map.yellowfox.de/rti/get_messagestate.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&DATEFROM=TT.MM.JJJJ&DATETO=TT.MM.JJJJ&timefrom=HHMMSS&timeto=HHMMSS&datetype=insertdate{{/code}} | ||
| 82 | |||
| 83 | // | ||
| 84 | // | ||
| 85 |