Changes for page do_message.php

Last modified by YellowFox_RD on 2025/01/23 10:13
From version 2.1
edited by YellowFox_RD
on 2025/01/23 10:13
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,24 +1,18 @@
1 1  (% class="box" %)
2 -(((
3 -Table of Contents
4 -)))
5 -
2 +(((Table of Contents)))
6 6  {{toc/}}
7 7  
8 8  Send a message to a single vehicle, a group or to all (import).
9 -
10 10  = Description =
11 -
12 -(% class="blue mark" %)//**POST**//(%%)//** do_message.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY**//&messagetext//**=Message//**&language**//=gbr//**&responsetype**//=2//**&format**//=xml//**&freeresponses[]**//=Montag**&freeresponses[]**=Dienstag**&dispatcher**=Absender
13 -
7 +//**(% class="blue mark" %)POST(%%) do_message.php?company**//=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY**//&messagetext//**=Message//**&language**//=gbr//**&responsetype**//=2//**&format**//=xml//**&freeresponses[]**//=Montag**&freeresponses[]**=Dienstag**&dispatcher**=Absender
14 14  = Parameter =
15 -
16 16  |=Parameter|=Description|=Type|=Note|=Mandatory
17 -|company|RTI company key|string| |yes
10 +|company|RTI company key|string||yes
18 18  |vehicle|RTI vehicle key|string|either vehicle, group or import parameter|(yes)
19 19  |group|RTI group key|string|either vehicle, group or import parameter|(yes)
20 20  |import|RTI import key|string|either vehicle, group or import parameter|(yes)
21 -|messagetext| |string|maximal text length:(((
14 +|messagetext||string|maximal text length:
15 +(((
22 22  * CE-displays + android fleet: 500 signs
23 23  * all other displays: 200 signs
24 24  )))|yes
... ... @@ -37,13 +37,10 @@
37 37  You get these UUIDs while uploading a file via file_storage/upload_file.php or you can access them via file_storage/get_overview.php|no
38 38  
39 39  = Return =
34 +By default, a **CSV string** is returned which contains the evaluation for each vehicle and the **SESSIONKEY** for successful dispatch. If the mandatory parameters are missing, an "**(% class="error" %)ERROR: Description(%%)**" is returned.
40 40  
41 -By default, a **CSV string** is returned which contains the evaluation for each vehicle and the **SESSIONKEY** for successful dispatch. If the mandatory parameters are missing, an "(% class="error" %)**ERROR: Description**(%%)" is returned.
42 -
43 43  == CSV-Format ==
44 -
45 45  === Meta informations ===
46 -
47 47  |=Separator|Semicolon ( ; )
48 48  |=Delimiter|Double quote ( " )
49 49  |=Line break|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -50,7 +50,6 @@
50 50  |=Header|Line 1
51 51  
52 52  === Columns ===
53 -
54 54  |=Column|=Description
55 55  |CAR|Vehicle-Name
56 56  |RESULT|Result of the action
... ... @@ -57,7 +57,6 @@
57 57  |SESSIONKEY|Sessionkey of the message
58 58  
59 59  === Example ===
60 -
61 61  **Result format as CSV**
62 62  {{code language="java"}}"CAR";"RESULT";"SESSIONKEY"
63 63  "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
... ... @@ -65,30 +65,28 @@
65 65  "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}}
66 66  
67 67  == XML Format ==
68 -
69 69  **Result format as XML**
70 70  {{code language="php"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
71 71  <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
72 72  <yf_domessage>
73 - <message>
74 - <car>Car 1</car>
75 - <result>ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED</result>
76 - <sessionkey></sessionkey>
77 - </message>
78 - <message>
79 - <car>Car 2</car>
80 - <result>OK</result>
81 - <sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
82 - </message>
83 - <message>
84 - <car>Car 3</car>
85 - <result>ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3</result>
86 - <sessionkey></sessionkey>
87 - </message>
61 + <message>
62 + <car>Car 1</car>
63 + <result>ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED</result>
64 + <sessionkey></sessionkey>
65 + </message>
66 + <message>
67 + <car>Car 2</car>
68 + <result>OK</result>
69 + <sessionkey>8a810da98bc0583af5959af0e8dde59g</sessionkey>
70 + </message>
71 + <message>
72 + <car>Car 3</car>
73 + <result>ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3</result>
74 + <sessionkey></sessionkey>
75 + </message>
88 88   </yf_domessage>{{/code}}
89 89  
90 90  == JSON Format (RFC 4627) ==
91 -
92 92  **Result format as JSON**
93 93  {{code language="java"}}[{"car":"Car 1","result":"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED"},{"car":"Car 2","result":"OK","sessionkey":"8a810da98bc0583af5959af0e8dde59g"},{"car":"Car 3","result":"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3"}]{{/code}}
94 94  
... ... @@ -103,10 +103,10 @@
103 103  {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=2&language=gbr&format=csv{{/code}}
104 104  
105 105  **Yes-No message to all with english confirmation and desired return format as XML**
106 -{{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=3&language=gbr&format=xml{{/code}}
93 +{{code language="java"}} https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=3&language=gbr&format=xml{{/code}}
107 107  
108 108  **Message with reply template to all, with desired return format as xml and the response template as a serialized array**
109 -{{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses[]=monday&freeresponses[]=tuesday{{/code}}
96 +{{code language="java"}} https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&messagetext=RTI%20do_message%20test&responsetype=4&format=xml&freeresponses[]=monday&freeresponses[]=tuesday{{/code}}
110 110  
111 111  **simple message to the vehicle with dispatcher**
112 112  {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=name