Changes for page get_messages.php
Last modified by YellowFox_RD on 2025/01/23 10:10
To version 2.1
edited by Dominic Lippmann
on 2025/01/23 10:09
on 2025/01/23 10:09
Change comment:
There is no comment for this version
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. YellowFox_RD1 +XWiki.yf-dominic - Content
-
... ... @@ -1,14 +1,21 @@ 1 1 (% class="box" %) 2 -(((Table of Contents))) 2 +((( 3 +Table of Contents 4 +))) 5 + 3 3 {{toc/}} 4 4 5 5 Returns the states of the messages. 9 + 6 6 = Description = 7 -//**(% class="green mark" %)GET(%%) get_messages.php?company**=RTI_COMPANYKEY**&vehicle**=RTI_VEHICLEKEY&**language=**deu**&datefrom**=YYYYMMDD**&dateto**=YYYYMMDD**&timefrom=**HHMMSS**&timeto**=HHMMSS**&filter=**1,2,3**&sessionkey=**ABABABABABABABABABABABABABABAB**&format=**xml//**&mode**=insertdate//// 11 + 12 +(% class="green mark" %)//**GET**//(%%)//** get_messages.php?company**=RTI_COMPANYKEY**&vehicle**=RTI_VEHICLEKEY&**language=**deu**&datefrom**=YYYYMMDD**&dateto**=YYYYMMDD**&timefrom=**HHMMSS**&timeto**=HHMMSS**&filter=**1,2,3**&sessionkey=**ABABABABABABABABABABABABABABAB**&format=**xml//**&mode**=insertdate 13 + 8 8 = Parameter = 9 - 15 + 16 + 10 10 |=Params|=Description|=Type|=Note|=Mandatory 11 -|company|RTI company key|string||yes 18 +|company|RTI company key|string| |yes 12 12 |vehicle|RTI vehcile key|string|vehicle or import or group parameter|(yes) 13 13 |group|RTI group key|string|vehicle or import or group parameter|(yes) 14 14 |import|RTI importkey|string|vehicle or import or group parameter|(yes) ... ... @@ -27,7 +27,6 @@ 27 27 10 = message with response templates sent 28 28 11 = delivered 29 29 12 = delivery attempt 30 - 31 31 more than one filter have to separate with a comma|no 32 32 |language|define output language|string|supported params: deu (standard), gbr, ndl, fra, ita|no 33 33 |format|result format|string|format of the result from the interface ... ... @@ -36,6 +36,7 @@ 36 36 |mode|Request of historydate or insertdate|string|historydate (standard) or insertdate|no 37 37 38 38 = Possible message status = 45 + 39 39 |=State|=Description 40 40 |delivery attempt|The message left the YellowFox data center. 41 41 |delivered|The message has arrived successfully on the display. ... ... @@ -51,9 +51,13 @@ 51 51 |answer received|A response from the display has been received. 52 52 53 53 = Return = 54 -By default, a **CSV string** is returned which contains the evaluation for each message. If the mandatory parameters are missing, an "**(% class="error" %)ERROR: Description(%%)**" is returned. 61 + 62 +By default, a **CSV string** is returned which contains the evaluation for each message. If the mandatory parameters are missing, an "(% class="error" %)**ERROR: Description**(%%)" is returned. 63 + 55 55 == CSV format == 65 + 56 56 === Metainformationen === 67 + 57 57 |=Separator|Semicolon ( ; ) 58 58 |=Delimiter|Double quote ( " ) 59 59 |=Line break|0x0D 0x0A (CarriageReturn LineFeed) ... ... @@ -60,16 +60,17 @@ 60 60 |=Header|Line 1 61 61 62 62 === Columns === 63 -|=Column|=Description|= 74 + 75 +|=Column|=Description|= 64 64 |DATE|date of the executed action|format: YYYY-MM-DD HH:MM:SS 65 -|STATE|description of the action| 66 -|SOURCE|action trigger (person)| 67 -|SOURCENAME|action trigger (system)| 68 -|SESSIONKEY|sessionkey of message| 77 +|STATE|description of the action| 78 +|SOURCE|action trigger (person)| 79 +|SOURCENAME|action trigger (system)| 80 +|SESSIONKEY|sessionkey of message| 69 69 |REQUESTDATE|system time of request|format: YYYY-MM-DD HH:MM:SS 70 70 |INSERTDATE|system time of processing|format: YYYY-MM-DD HH:MM:SS 71 -|TEXT|content of the message| 72 -|RTI_IDENT|RTI Ident| 83 +|TEXT|content of the message| 84 +|RTI_IDENT|RTI Ident| 73 73 74 74 **result as CSV** 75 75 {{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT" ... ... @@ -78,6 +78,7 @@ 78 78 "2016-12-02 09:09:15";"answer received";"PND";"Car 1";"ABABABABABABABABABABAB";"2016-12-05 10:17:52";"2016-12-02 09:09:20";"Answer 1";"Ident1"{{/code}} 79 79 80 80 == XML format == 93 + 81 81 **result as XML** 82 82 {{code language="java"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?> 83 83 <!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd"> ... ... @@ -91,7 +91,7 @@ 91 91 <requestdate>2016-12-05 10:17:15</requestdate> 92 92 <insertdate>2016-12-02 13:09:20</insertdate> 93 93 <text>Message 1</text> 94 - 107 + <rti_ident>Ident1</rti_ident> 95 95 </message> 96 96 <message> 97 97 <date>2016-12-02 13:08:25</date> ... ... @@ -102,7 +102,7 @@ 102 102 <requestdate>2016-12-05 10:17:15</requestdate> 103 103 <insertdate>2016-12-02 13:08:15</insertdate> 104 104 <text>Question 1?</text> 105 - 118 + <rti_ident>Ident1</rti_ident> 106 106 </message> 107 107 <message> 108 108 <date>2016-12-02 09:09:15</date> ... ... @@ -113,11 +113,12 @@ 113 113 <requestdate>2016-12-05 10:17:52</requestdate> 114 114 <insertdate>2016-12-02 09:09:20</insertdate> 115 115 <text>Answer 1</text> 116 - 129 + <rti_ident>Ident1</rti_ident> 117 117 </message> 118 118 </yf_getmessages>{{/code}} 119 119 120 120 == JSON Format (RFC 4627) == 134 + 121 121 **result as JSON** 122 122 {{code language="java"}}[ 123 123 {"date":"2016-12-02 13:09:15","state":"confirmation message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:09:20","text":"Message 1"},