Wiki source code of do_track_once.php
Last modified by YellowFox_RD on 2025/01/23 09:47
Show last authors
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | ((( | ||
3 | Table of Contents | ||
4 | ))) | ||
5 | |||
6 | {{toc/}} | ||
7 | |||
8 | = do_track_once.php = | ||
9 | |||
10 | One time detection for a vehicle or group. | ||
11 | |||
12 | = Description = | ||
13 | |||
14 | (% class="green mark" %)//**GET**//(%%)//** do_track_once.php?company**=COMPANY_RTIKEY**&vehicle**=VEHICLE_RTIKEY**&format**=xml// | ||
15 | |||
16 | = Parameter = | ||
17 | |||
18 | |=Parameter|=Description|=Typ|=Note|=Mandatory | ||
19 | |company|RTI company key|string| |yes | ||
20 | |vehicle|RTI vehicle key|string|either vehicle or group parameter|(yes) | ||
21 | |group|RTI group key|string|either vehicle or group parameter|(yes) | ||
22 | |format|format of the result|string|format of the result from the interface | ||
23 | supported formats: csv (default)|no | ||
24 | |||
25 | = Return = | ||
26 | |||
27 | By default, a **CSV string** is returned, which contains **OK **for each vehicle on success. If an error occurs, an "**ERROR:Description**" is returned. | ||
28 | |||
29 | == CSV-Format == | ||
30 | |||
31 | === Meta informations === | ||
32 | |||
33 | |=Seperator|Semicolon ( ; ) | ||
34 | |=Delimter|Double quote ( " ) | ||
35 | |=Line Break|0x0D 0x0A (CarriageReturn LineFeed) | ||
36 | |=Header|Line 1 | ||
37 | |||
38 | === Columns === | ||
39 | |||
40 | |=Column|=Description | ||
41 | |CAR|vehicle name | ||
42 | |RESULT|result of the action | ||
43 | |||
44 | === Example === | ||
45 | |||
46 | **Result format as CSV** | ||
47 | {{code language="java"}}"CAR";"RESULT" | ||
48 | "Car 1";"OK" | ||
49 | "Car 2";"OK" | ||
50 | "Car 3";"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION" | ||
51 | "Car 4";"ERROR_SEND_ONE_TIME_DETECTION"{{/code}} | ||
52 | |||
53 | == XML Format == | ||
54 | |||
55 | **Result format as XML** | ||
56 | {{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?> | ||
57 | <!DOCTYPE yf_dotrackonce SYSTEM "http://map.yellowfox.de/rti/dtd/yf_dotrackonce.dtd"> | ||
58 | <yf_dotrackonce> | ||
59 | <tracking> | ||
60 | <car>Car 1</car> | ||
61 | <result>OK</result> | ||
62 | </tracking> | ||
63 | <tracking> | ||
64 | <car>Car 2</car> | ||
65 | <result>OK</result> | ||
66 | </tracking> | ||
67 | <tracking> | ||
68 | <car>Car 3</car> | ||
69 | <result>ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION</result> | ||
70 | </tracking> | ||
71 | <tracking> | ||
72 | <car>Car 4</car> | ||
73 | <result>ERROR_SEND_ONE_TIME_DETECTION</result> | ||
74 | </tracking> | ||
75 | </yf_dotrackonce>{{/code}} | ||
76 | |||
77 | == JSON Format (RFC 4627) == | ||
78 | |||
79 | **Result format as JSON** | ||
80 | {{code language="java"}}[{"car":"Car 1","result":"OK"},{"car":"Car 2","result":"OK"},{"car":"Car 3","result":"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION"},{"car":"Car 4","result":"ERROR_SEND_ONE_TIME_DETECTION"}]{{/code}} | ||
81 | |||
82 | = Example calls = | ||
83 | |||
84 | **One time detection for a single vehicle** | ||
85 | {{code language="java"}}https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY | ||
86 | |||
87 | https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}} | ||
88 | |||
89 | **One time detection for a group with desired return format as XML** | ||
90 | {{code language="java"}}https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&format=xml{{/code}} | ||
91 |