do_track_once.php

Last modified by YellowFox_RD on 2025/01/23 09:47

Table of Contents

do_track_once.php

One time detection for a vehicle or group.

Description

GET do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=xml

Parameter

ParameterDescriptionTypNoteMandatory
companyRTI company keystring yes
vehicleRTI vehicle keystringeither vehicle or group parameter(yes)
groupRTI group keystringeither vehicle or group parameter(yes)
formatformat of the resultstringformat of the result from the interface
supported formats: csv (default)
no

Return

By default, a CSV string is returned, which contains OK for each vehicle on success. If an error occurs, an "ERROR:Description" is returned.

CSV-Format

Meta informations

SeperatorSemicolon ( ; )
DelimterDouble quote ( " )
Line Break0x0D 0x0A (CarriageReturn LineFeed)
HeaderLine 1

Columns

ColumnDescription
CARvehicle name
RESULTresult of the action

Example

Result format as CSV
"CAR";"RESULT"
"Car 1";"OK"
"Car 2";"OK"
"Car 3";"ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION"
"Car 4";"ERROR_SEND_ONE_TIME_DETECTION"

XML Format

Result format as XML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE yf_dotrackonce SYSTEM "http://map.yellowfox.de/rti/dtd/yf_dotrackonce.dtd">
<yf_dotrackonce>
<tracking>
 <car>Car 1</car>
 <result>OK</result>
</tracking>
<tracking>
 <car>Car 2</car>
 <result>OK</result>
</tracking>
<tracking>
 <car>Car 3</car>
 <result>ERROR_VEHICLE_NOT_SUPPORTED_ONE_TIME_DETECTION</result>
</tracking>
<tracking>
 <car>Car 4</car>
 <result>ERROR_SEND_ONE_TIME_DETECTION</result>
</tracking>
</yf_dotrackonce>

JSON Format (RFC 4627)

Result format as JSON
[{"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"}]

Example calls

One time detection for a single vehicle
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY

https:
//map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}

One time detection for a group with desired return format as XML
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&format=xml