Versions Compared

Old Version 13

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede

Veranlasst einmalige Ortung für ein Fahrzeug oder eine Gruppe

Beschreibung

Status
colourGreen
titleGET
 do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=xml

Parameter

ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring

ja

vehicleRTI Fahrzeugschlüsselstringentweder vehicle oder group werden erwartet(ja)
groupRTI Gruppenschlüsselstringentweder vehicle oder group werden erwartet(ja)
formatRückgabeformatstringFormat der zurückgelieferten Antwort der Schnittstelle

unterstüzte Formate: csv (Standard), xml, json

nein

Rückgabe

Es wird standardmäßig ein CSV-String zurückgegeben, welcher zu jedem Fahrzeug bei Erfolg OK enthält. Bei einem Fehler wird ein "ERROR:Beschreibung" zurückgegeben

CSV-Format

Metainformationen

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 1

Spalten

SpalteBeschreibung
CARVehicle-Name
RESULTResultat der Aktion

Beispiel

Code Block
titleRückgabe als 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

Code Block
languagexml
titleRückgabe als 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)

Code Block
titleRückgabe als 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"}]

Beispielaufrufe

Code Block
titleEinmalige Ortung eines einzelnen Fahrzeuges
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"}


Code Block
titleEinmalige Ortung einer Gruppe und gewünschten Rückgabeformat als XML
https://map.yellowfox.de/rti/do_track_once.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&format=xml


Sv translation
languageen

do_track_once.php 

One time detection for a vehicle or group.

Description

Status
colourGreen
titleGET
 do_track_once.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=xml

Parameter

Parameter
Beschreibung
DescriptionTyp
Hinweis
Note
Pflicht
Mandatory
companyRTI company keystring

yes

vehicleRTI vehicle keystringeither vehicle or group parameter(yes)
groupRTI group keystringeither vehicle or group parameter(yes)
formatformat of the resultstring

format 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

Code Block
titleResult 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

Code Block
languagexml
titleResult 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)

Code Block
titleResult 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"}]
Examples

Example calls


Code Block
titleOne 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"}


Code Block
titleOne 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