Changes for page get_messages.php

Last modified by YellowFox_RD on 2025/01/23 10:10
From version 3.1
edited by YellowFox_RD
on 2025/01/23 10:10
Change comment: There is no comment for this version
To version 1.1
edited by YellowFox_RD
on 2024/12/19 10:11
Change comment: Imported from XAR

Summary

Details

Page properties
Content
... ... @@ -1,21 +1,14 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  Returns the states of the messages.
9 -
10 10  = Description =
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 -
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////
14 14  = Parameter =
15 -
16 -
9 + 
17 17  |=Params|=Description|=Type|=Note|=Mandatory
18 -|company|RTI company key|string| |yes
11 +|company|RTI company key|string||yes
19 19  |vehicle|RTI vehcile key|string|vehicle or import or group parameter|(yes)
20 20  |group|RTI group key|string|vehicle or import or group parameter|(yes)
21 21  |import|RTI importkey|string|vehicle or import or group parameter|(yes)
... ... @@ -34,6 +34,7 @@
34 34  10 = message with response templates sent
35 35  11 = delivered
36 36  12 = delivery attempt
30 +
37 37  more than one filter have to separate with a comma|no
38 38  |language|define output language|string|supported params: deu (standard), gbr, ndl, fra, ita|no
39 39  |format|result format|string|format of the result from the interface
... ... @@ -42,7 +42,6 @@
42 42  |mode|Request of historydate or insertdate|string|historydate (standard) or insertdate|no
43 43  
44 44  = Possible message status =
45 -
46 46  |=State|=Description
47 47  |delivery attempt|The message left the YellowFox data center.
48 48  |delivered|The message has arrived successfully on the display.
... ... @@ -58,13 +58,9 @@
58 58  |answer received|A response from the display has been received.
59 59  
60 60  = Return =
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 -
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.
64 64  == CSV format ==
65 -
66 66  === Metainformationen ===
67 -
68 68  |=Separator|Semicolon ( ; )
69 69  |=Delimiter|Double quote ( " )
70 70  |=Line break|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -71,28 +71,26 @@
71 71  |=Header|Line 1
72 72  
73 73  === Columns ===
74 -
75 -|=Column|=Description|=
63 +|=Column|=Description|=
76 76  |DATE|date of the executed action|format: YYYY-MM-DD HH:MM:SS
77 -|STATE|description of the action|
78 -|SOURCE|action trigger (person)|
79 -|SOURCENAME|action trigger (system)|
80 -|SESSIONKEY|sessionkey of message|
65 +|STATE|description of the action|
66 +|SOURCE|action trigger (person)|
67 +|SOURCENAME|action trigger (system)|
68 +|SESSIONKEY|sessionkey of message|
81 81  |REQUESTDATE|system time of request|format: YYYY-MM-DD HH:MM:SS
82 82  |INSERTDATE|system time of processing|format: YYYY-MM-DD HH:MM:SS
83 -|TEXT|content of the message|
84 -|RTI_IDENT|RTI Ident|
71 +|TEXT|content of the message|
72 +|RTI_IDENT|RTI Ident|
85 85  
86 86  **result as CSV**
87 -\\{{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
75 +{{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
88 88  ""2016-12-02 13:09:15";"confirmation message sent";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:09:20";"Message 1";"Ident1"
89 89  "2016-12-02 13:08:25";"yes/no message sent";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:08:15";"Question 1?";"Ident1"
90 90  "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}}
91 91  
92 92  == XML format ==
93 -
94 94  **result as XML**
95 -\\{{code language="java"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
82 +{{code language="java"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
96 96  <!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
97 97  <yf_getmessages>
98 98   <message>
... ... @@ -104,7 +104,7 @@
104 104   <requestdate>2016-12-05 10:17:15</requestdate>
105 105   <insertdate>2016-12-02 13:09:20</insertdate>
106 106   <text>Message 1</text>
107 - <rti_ident>Ident1</rti_ident>
94 + <rti_ident>Ident1</rti_ident>
108 108   </message>
109 109   <message>
110 110   <date>2016-12-02 13:08:25</date>
... ... @@ -115,7 +115,7 @@
115 115   <requestdate>2016-12-05 10:17:15</requestdate>
116 116   <insertdate>2016-12-02 13:08:15</insertdate>
117 117   <text>Question 1?</text>
118 - <rti_ident>Ident1</rti_ident>
105 + <rti_ident>Ident1</rti_ident>
119 119   </message>
120 120   <message>
121 121   <date>2016-12-02 09:09:15</date>
... ... @@ -126,14 +126,13 @@
126 126   <requestdate>2016-12-05 10:17:52</requestdate>
127 127   <insertdate>2016-12-02 09:09:20</insertdate>
128 128   <text>Answer 1</text>
129 - <rti_ident>Ident1</rti_ident>
116 + <rti_ident>Ident1</rti_ident>
130 130   </message>
131 131  </yf_getmessages>{{/code}}
132 132  
133 133  == JSON Format (RFC 4627) ==
134 -
135 135  **result as JSON**
136 -\\{{code language="java"}}[
122 +{{code language="java"}}[
137 137  {"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"},
138 138  {"date":"2016-12-02 13:08:25","state":"yes/no message sent","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:08:15","text":"Question 1?"},
139 139  {"date":"2016-12-02 09:09:15","state":"answer received","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Answer 1","rti_ident":"Ident1"}]{{/code}}
... ... @@ -141,10 +141,10 @@
141 141  = Example call =
142 142  
143 143  **Query by SessionKey**
144 -\\{{code language="java"}}https://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
130 +{{code language="java"}}https://map.yellowfox.de/rti/get_messages.pgp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
145 145  
146 146  https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY{{/code}}
147 147  
148 148  **Query by time range based**
149 -\\{{code language="java"}}https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate{{/code}}
135 +{{code language="java"}}https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate{{/code}}
150 150