Wiki source code of get_messages_pnd.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 all messages, send by vehicle to portal, inside the defined request time range. | ||
8 | = Description = | ||
9 | //**get_messages_pnd.asp?company**=RTI_COMPANYKEY**&vehicle**=RTI_VEHICLEKEY**&mode**=CSV**&time**=m// | ||
10 | = Parameter = | ||
11 | |=Parameter|=Description|=Type|=Note|=Required | ||
12 | |company|RTI company key|string||yes | ||
13 | |vehicle|RTI vehicle key|string|vehicle or group must be defined|yes | ||
14 | |group|RTI group key|string|vehicle or group must be defined|yes | ||
15 | |time|Show messages from last x minutes.|integer|Valid range is 5-60|yes | ||
16 | |mode|The data output format|string|Currently only "CSV" is supported, and also the default value.|no | ||
17 | |||
18 | = Return = | ||
19 | Returned data are in **string** format. On error "(% class="error" %)**ERROR:Description**(%%)" is returned. | ||
20 | == CSV format == | ||
21 | If the request is valid, the data are returned as CSV (Comma Separated Value) format. The first response line is always | ||
22 | the header, defining the column names. After it the personal data follows. | ||
23 | === Meta informations === | ||
24 | |=Separator|Semicolon ( ; ) | ||
25 | |=Delimiter|Double quote ( " ) | ||
26 | |=Line break|0x0D 0x0A (CarriageReturn LineFeed) | ||
27 | |=Header|Line 1 | ||
28 | |=Encoding|UTF-8 | ||
29 | |||
30 | === Columns === | ||
31 | |=Column|=Description | ||
32 | |DATE|Message create date (DD.MM.YYYY HH:MM:SS) | ||
33 | |TEXT|Recieved message text | ||
34 | |CAR|The vehicle sign | ||
35 | |||
36 | === Example === | ||
37 | **Example-Output** | ||
38 | {{code language="java"}}"DATE";"TEXT";"CAR"; | ||
39 | 04.08.2010 09:44:19;"Come later...";"Vehicle1"; | ||
40 | 04.08.2010 09:57:51;"Bin gleich da";"Vehicle1";{{/code}} | ||
41 | |||
42 | = Example call = | ||
43 | **All messages from selected vehicle within the last 2 minutes** | ||
44 | {{code language="java"}}https://map.yellowfox.de/rti/get_messages_pnd.asp?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&mode=CSV&time=2{{/code}} | ||
45 | |||
46 | // | ||
47 | // | ||
48 |