Wiki source code of get_cars.php

Last modified by YellowFox_RD on 2025/04/17 10:09

version	line-number	content
1.1	1	(% class="box" %)
2.2	2	(((
3.1	3	Table of Contents
2.2	4	)))
	5
1.1	6	{{toc/}}
	7
3.1	8	Shows a list of cars which are affected by a RTI request.
2.2	9
3.1	10	= Description =
2.2	11
3.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
3.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
3.1	23	= Return =
2.2	24
3.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
3.1	29	=== Meta informations ===
2.2	30
3.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
3.1	37	=== Columns ===
2.2	38
3.1	39	\|=Column\|=Description
	40	\|CARNAME\|name of the vehicle
1.1	41	\|IDENT\|RTI Ident
3.1	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
	47	\|VEHICLEDESCRIPTION\|vehicle description
1.1	48
3.1	49	=== Example ===
2.2	50
3.1	51	Return in CSV
2.2	52	{{code language="java"}}"CARNAME";"IDENT";"COSTCENTER";"VEHICLEGROUPS";"KMCORRECTIONFACTOR";"VEHICLEVIN";"VEHICLEIDENT";"VEHICLEDESCRIPTION"
	53	"CAR1";"IDENT1";"COSTCENTER1";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"1DB69T687HT";"35fdebee00dfa3278fa88c54cd7f8c2f";"Transporter"
	54	"CAR2";"IDENT2";"COSTCENTER2";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB69T687HT";"45fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 2"
	55	"CAR3";"IDENT3";"COSTCENTER3";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"5DB69T687HT";"49fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 3"
	56	"CAR4";"IDENT4";"COSTCENTER4";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3UO69T687HT";"98fdebee00dfa3278fa88c54cd7f8c2f";"Transporter 4"
	57	"CAR5";"IDENT5";"COSTCENTER5";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"3DB697487HT";"4ff7debee00dfa3278fa88c54cd7f8c2f";"Transporter 5"
	58	"CAR6";"IDENT6";"COSTCENTER6";"[{"name":"gruppe1"},{"name":"gruppe2"}]";"1";"";"526debee00dfa3278fa88c54cd7f8c2f";"Kranwagen"{{/code}}
1.1	59
	60	== JSON ==
	61
3.1	62	{{code language="java"}}
2.2	63	[
	64	{
	65	"vehicle_sign": "FTL YF 123",
	66	"rti_ident": null,
	67	"tracking_mode": "IntelligentLocating",
	68	"tracking_interval": 0,
	69	"supported_modes": [
	70	"CourseChange",
	71	"IntelligentLocating",
	72	"DistanceInterval",
	73	"MinuteInterval"
1.1	74	],
2.2	75	"vehicle_groups": [
1.1	76	{
	77	"name": "gruppe1"
	78	},
	79	{
	80	"name": "gruppe2"
	81	}
2.2	82	],
	83	"km_correction":1,
	84	"vehicle_vin": "1DB69T6847HT",
	85	"vehicle_ident": "35fdebee00dfa3278fa88c54cd7f8c2f",
	86	"vehicle_description": "Transporter"
	87	}
	88	]
	89	{{/code}}
1.1	90
3.1	91	= Example Calls =
2.2	92
3.1	93	Name of one vehicle
1.1	94	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
	95
	96	https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_RTIIDENT"}{{/code}}
	97
3.1	98	Returns all cars of a group
1.1	99	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY{{/code}}
	100
3.1	101	All cars, which are requestable over the RTI
1.1	102	{{code language="java"}}https://map.yellowfox.de/rti/get_cars.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY{{/code}}
3.1	103
	104
	105	\\