Wiki source code of get_cars.php

Last modified by YellowFox_RD on 2025/04/22 11:13

version	line-number	content
1.1	1	(% class="box" %)
2.2	2	(((
6.1	3	Table of Contents
2.2	4	)))
	5
1.1	6	{{toc/}}
	7
6.1	8	Shows a list of cars which are affected by a RTI request.
2.2	9
6.1	10	= Description =
2.2	11
6.1	12	(% class="green mark" %)GET(%%) get_cars.php?company=//COMPANY_RTIKEY//&vehicle=//VEHICLE_RTIKEY//
2.2	13
1.1	14	= Parameter =
2.2	15
6.1	16	\|=Parameter\|=Description\|=Typ\|=Note\|=Mandatory
	17	\|company\|RTI company key\|string\| \|yes
	18	\|vehicle\|RTI vehicle key\|string\|either vehicle, group or import parameter\|(yes)
	19	\|group\|RTI group key\|string\|either vehicle, group or import parameter\|(yes)
	20	\|import\|RTI import key\|string\|either vehicle, group or import parameter\|(yes)
	21	\|format\|Output format\|string\|csv or json, default: csv\|no
1.1	22
6.1	23	= Return =
2.2	24
6.1	25	Return a string. In case of error it returns "(% class="error" %)ERROR:Description(%%)".
2.2	26
1.1	27	== CSV ==
2.2	28
6.1	29	=== Meta informations ===
2.2	30
6.1	31	\|=Separator\|Semicolon ( ; )
	32	\|=Delimiter\|Double quote ( " )
	33	\|=Line break\|0x0D 0x0A (CarriageReturn LineFeed)
	34	\|=Header\|Line 1
	35	\|=Encoding\|UTF-8
1.1	36
6.1	37	=== Columns ===
2.2	38
6.1	39	\|=Column\|=Description\|=Note
	40	\|CARNAME\|name of the vehicle\|
	41	\|IDENT\|RTI Ident\| Is a key, that is defined by the user in the portal and can change.
	42	\|COSTCENTER\|cost center of the vehicle\|
	43	\|VEHICLEGROUPS\|group of vehicles\|
	44	\|KMCORRECTIONFACTOR\|km correction factor\|
	45	\|VEHICLEVIN\|chassis number (VIN)\|
	46	\|VEHICLEIDENT\|vehicle ident\|Is a unique key defined by YellowFox which will never change. You can use to identify the vehicle.
	47	\|VEHICLEDESCRIPTION\|vehicle description\|
	48	\|(((
	49	ISTRAILER
	50	)))\|is vehicle a Trailer \|yes => 1, no => 0
1.1	51
6.1	52	=== Example ===
2.2	53
6.1	54	Return in CSV
	55	{{code language="java"}}"CARNAME";"IDENT";"COSTCENTER";"VEHICLEGROUPS";"KMCORRECTIONFACTOR";"VEHICLEVIN";"VEHICLEIDENT";"VEHICLEDESCRIPTION";"ISTRAILER"
	56	"CAR1";"IDENT1";"COSTCENTER1";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"1DB69T687HT";"35fdebee00dfa3278fa88c54cd7f8c2f";"Transporter";0
	57	"CAR2";"IDENT2";"COSTCENTER2";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB69T687HT";"45fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 2";0
	58	"CAR3";"IDENT3";"COSTCENTER3";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"5DB69T687HT";"49fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 3";0
	59	"CAR4";"IDENT4";"COSTCENTER4";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3UO69T687HT";"98fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 4";0
	60	"CAR5";"IDENT5";"COSTCENTER5";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB697487HT";"4ff7debee00dfa3278fa88c54cd7f8c2f";"Trailer";1
	61	"CAR6";"IDENT6";"COSTCENTER6";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"";"526debee00dfa3278fa88c54cd7f8c2f";"Kranwagen";0{{/code}}
1.1	62
	63	== JSON ==
	64
6.1	65	{{code language="java"}}
2.2	66	[
	67	{
	68	"vehicle_sign": "FTL YF 123",
	69	"rti_ident": null,
	70	"tracking_mode": "IntelligentLocating",
	71	"tracking_interval": 0,
	72	"supported_modes": [
	73	"CourseChange",
	74	"IntelligentLocating",
	75	"DistanceInterval",
	76	"MinuteInterval"
1.1	77	],
2.2	78	"vehicle_groups": [
1.1	79	{
	80	"name": "gruppe1"
	81	},
	82	{
	83	"name": "gruppe2"
	84	}
2.2	85	],
	86	"km_correction":1,
	87	"vehicle_vin": "1DB69T6847HT",
	88	"vehicle_ident": "35fdebee00dfa3278fa88c54cd7f8c2f",
6.1	89	"vehicle_description": "Transporter",
	90	"isTrailer": false
2.2	91	}
	92	]
	93	{{/code}}
1.1	94
6.1	95	= Example Calls =
2.2	96
6.1	97	Name of one vehicle
1.1	98	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
	99
	100	https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_RTIIDENT"}{{/code}}
	101
6.1	102	Returns all cars of a group
1.1	103	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY{{/code}}
	104
6.1	105	All cars, which are requestable over the RTI
1.1	106	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
6.1	107
	108
	109
1.1	110