Changes for page do_message.php

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

Summary

Details

Page properties
Content
... ... @@ -1,18 +1,24 @@
1 1  (% class="box" %)
2 -(((Table of Contents)))
2 +(((
3 +Table of Contents
4 +)))
5 +
3 3  {{toc/}}
4 4  
5 5  Send a message to a single vehicle, a group or to all (import).
9 +
6 6  = Description =
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
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 +
8 8  = Parameter =
15 +
9 9  |=Parameter|=Description|=Type|=Note|=Mandatory
10 -|company|RTI company key|string||yes
17 +|company|RTI company key|string| |yes
11 11  |vehicle|RTI vehicle key|string|either vehicle, group or import parameter|(yes)
12 12  |group|RTI group key|string|either vehicle, group or import parameter|(yes)
13 13  |import|RTI import key|string|either vehicle, group or import parameter|(yes)
14 -|messagetext||string|maximal text length:
15 -(((
21 +|messagetext| |string|maximal text length:(((
16 16  * CE-displays + android fleet: 500 signs
17 17  * all other displays: 200 signs
18 18  )))|yes
... ... @@ -31,10 +31,13 @@
31 31  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
32 32  
33 33  = 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.
35 35  
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 +
36 36  == CSV-Format ==
44 +
37 37  === Meta informations ===
46 +
38 38  |=Separator|Semicolon ( ; )
39 39  |=Delimiter|Double quote ( " )
40 40  |=Line break|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -41,6 +41,7 @@
41 41  |=Header|Line 1
42 42  
43 43  === Columns ===
53 +
44 44  |=Column|=Description
45 45  |CAR|Vehicle-Name
46 46  |RESULT|Result of the action
... ... @@ -47,6 +47,7 @@
47 47  |SESSIONKEY|Sessionkey of the message
48 48  
49 49  === Example ===
60 +
50 50  **Result format as CSV**
51 51  {{code language="java"}}"CAR";"RESULT";"SESSIONKEY"
52 52  "Car 1";"ERROR_HARDWARE_COMBINATION_NOT_SUPPORTED";""
... ... @@ -54,28 +54,30 @@
54 54  "Car 3";"ERROR_HARDWARE_DONT_SHOW_RESPONSETYPE_3";""{{/code}}
55 55  
56 56  == XML Format ==
68 +
57 57  **Result format as XML**
58 58  {{code language="php"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
59 59  <!DOCTYPE yf_domessage SYSTEM "https://map.yellowfox.de/rti/dtd/yf_domessage.dtd">
60 60  <yf_domessage>
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>
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>
76 76   </yf_domessage>{{/code}}
77 77  
78 78  == JSON Format (RFC 4627) ==
91 +
79 79  **Result format as JSON**
80 80  {{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}}
81 81  
... ... @@ -90,10 +90,10 @@
90 90  {{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}}
91 91  
92 92  **Yes-No message to all with english confirmation and desired return format as XML**
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}}
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}}
94 94  
95 95  **Message with reply template to all, with desired return format as xml and the response template as a serialized array**
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}}
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}}
97 97  
98 98  **simple message to the vehicle with dispatcher**
99 99  {{code language="java"}}https://map.yellowfox.de/rti/do_message.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&messagetext=RTI%20do_message%20test&dispatcher=name