Wiki source code of get_rs232.php

Last modified by YellowFox_RD on 2024/12/19 10:11
Show last authors
1 (% class="box" %)
2 (((Table of Contents)))
3 {{toc/}}
4
5 Get RS-232 data.
6 = Description =
7 **(% class="green mark" %)GET(%%) get_rs232.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYYMMDDHHMMSS//**&end**=//YYYYMMDDHHMMSS**&format**=csv//
8 = Parameters =
9 |=Parameter|=Description|=Type|=Note|=Mandatory
10 |company|RTI company key|string||yes
11 |vehicle|RTI vehicle key|string||yes
12 |start|start of interval|datestring|format: YYYYMMDDHHMMSS
13 maximal allowed range of 7 days between begin and end|yes
14 |end|end of interval|datestring|format: YYYYMMDDHHMMSS
15 maximal allowed range of 7 days between begin and end|yes
16 |format|return format|string|csv (standard), xml, json|no
17
18 = Return =
19  Return a **string**. In case of error "(% class="error" %)**ERROR:Description**(%%)" will be returned.
20
21 == CSV format ==
22 === meta data ===
23 |=Delimiter|semicolon ( ; )
24 |=Text delimiter|double quote ( " )
25 |=Line end|0x0D 0x0A (CarriageReturn LineFeed)
26 |=Header|first line
27
28 === Columns ===
29 |=Column|=Description|=
30 |DATE|GPS date when measurement was created|YYYY-MM-DD HH:MM:SS
31 |CAR|license|string
32 |SERIALOUTPUT|Rs232 data|string
33
34 === Example ===
35 == CSV format ==
36 **return in csv**
37 {{code language="java"}}"DATE";"CAR";"SERIALOUTPUT"
38 "2016-05-19 14:30:02";"DD-ABC 123";"PNA|0|000014A5DE88|52|425884|2|*"
39 "2016-05-19 14:30:05";"DD-ABC 123";"PNA|0|000014A5DE88|52|425884|1|*"
40 "2016-05-19 14:30:06";"DD-ABC 123";"PNA|0|000014A5DE88|52|425885|2|*"{{/code}}
41
42 == XML format ==
43 **return in xml**
44 {{code language="java"}}<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?><!DOCTYPE yfrtiout SYSTEM "https://map.yellowfox.de/rti/dtd/yf_getrs232.dtd">
45 <yf_getrs232>
46 <message>
47 <date>2016-05-19 14:30:02</date>
48 <car>DD-ABC 123</car>
49 <serialoutput>PNA|0|000014A5DE88|52|425884|2|*</serialoutput>
50 </message>
51 <message>
52 <date>2016-05-19 14:30:05</date>
53 <car>DD-ABC 123</car>
54 <serialoutput>PNA|0|000014A5DE88|52|425884|1|*</serialoutput>
55 </message>
56 <message>
57 <date>2016-05-19 14:30:06</date>
58 <car>DD-ABC 123</car>
59 <serialoutput>PNA|0|000014A5DE88|52|425885|2|*</serialoutput>
60 </message>
61 </yf_getrs232>{{/code}}
62
63 == JSON format (RFC 4627) ==
64 **return in json**
65 {{code language="java"}}[{"date":"2016-05-19 14:30:02","car":"DD-ABC 123","serialoutput":"PNA|0|000014A5DE88|52|425884|2|*"},{"date":"2016-05-19 14:30:05","car":"DD-ABC 123","serialoutput":"PNA|0|000014A5DE88|52|425884|1|*"},{"date":"2016-05-19 14:30:06","car":"DD-ABC 123","serialoutput":"PNA|0|000014A5DE88|52|425885|2|*"}]{{/code}}
66
67 = Example calls =
68 **return RS-232 data in CSV-format**
69 {{code language="java"}}https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20160519000101&end=20160520130001&format=csv
70
71 https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20160519000101&end=20160520130001&format=csv{{/code}}
72
73 **return RS-232 data in XML-format**
74 {{code language="java"}}https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20160519000101&end=20160520130001&format=xml
75
76 https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20160519000101&end=20160520130001&format=xml{{/code}}
77
78 **return RS-232 data in JSON-format**
79 {{code language="java"}}https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&start=20160519000101&end=20160520130001&format=json
80
81 https://map.yellowfox.de/rti/get_rs232.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&start=20160519000101&end=20160520130001&format=json{{/code}}
82