vehicle_settings/get_odometer_history.php

A **string** will be returned (json or csv). If the request was successful "**OK**". If the request failed "(% class="error" %)**ERROR:Description**(%%)".

author	version	line-number	content
		1	(% class="box" %)
		2	(((
		3	Table of Contents
		4	)))
		5
		6	{{toc/}}
		7
		8	Get all existing odometer data that have been performed by users of the Customer Portal.
		9
		10	= Description =
		11
		12	(% class="green mark" %)GET(%%)// /vehicle_settings/get_odometer_history.php?company=RTI_COMPANYKEY&vehicle=//VEHICLE_RTIKEY
		13
		14	= Parameter =
		15
		16	\|=Parameter\|=Description\|=Type\|=Note\|=Mandatory
		17	\|company\|RTI company key\|string\| \|yes
		18	\|vehicle\|RTI vehicle key\|string\| \|yes
		19	\|format\|Output format\|string\|csv or json, default: csv\|no
		20
		21	= Return =
		22
		23	A string will be returned (json or csv). If the request was successful "OK". If the request failed "(% class="error" %)ERROR:Description(%%)".
		24
		25	== Possible error values ==
		26
		27	\|=error\|=description
		28	\|MISSING_COMPANY\|company key is missing
		29	\|INVALID_COMPANY\|Company not found. Company key or import key might be faulty.
		30	\|ERROR_MAINTENANCE\|Your company is under maintenance, no RTI request are possible at the moment.
		31	\|MISSING_VEHICLE\|vehicle key is missing
		32	\|INVALID_FORMAT\|invalid output format
		33
		34	== CSV ==
		35
		36	=== Meta informations ===
		37
		38	\|=Separator\|Semicolon ( ; )
		39	\|=Delimiter\|Double quote ( " )
		40	\|=Line break\|0x0D 0x0A (CarriageReturn LineFeed)
		41	\|=Header\|Line 1
		42
		43	=== Columns ===
		44
		45	\|=Column\|=Description
		46	\|DATE\|date of change
		47	\|NEWODOMETER\|Odometer reading after correction
		48	\|OLDODOMETER\|Odometer reading before correction
		49	\|KMCORRECTIONFACTOR\|Corrected value
		50	\|UPDATEBY\|Users of the portal
		51
		52	=== Example ===
		53
		54	\|=Return in CSV
		55	\|{{code language="java"}}"DATE";"NEWODOMETER";"OLDODOMETER";"KMCORRECTIONFACTOR";"UPDATEBY"
		56	"2021-11-23T21:08:13+00:00";"262655";"259434";"1";"Mitarbeiter 1"
		57	"2021-08-19T13:19:08+00:00";"259434";"257319";"1";"Mitarbeiter 1"
		58	"2021-05-26T16:14:54+00:00";"257319";"0";"0";"Mitarbeiter 1"
		59	"2019-08-06T14:18:47+00:00";"241000";"213597";"1.05259";"Mitarbeiter 2"
		60	"2018-01-12T17:00:29+00:00";"213597";"198227";"1.08232";"Mitarbeiter 1"
		61	"2017-02-03T15:34:37+00:00";"198227";"195037";"1.10995";"Mitarbeiter 1"
		62	"2016-10-14T10:50:58+00:00";"195037";"193018";"1";""
		63	"2016-09-07T08:30:51+00:00";"193018";"190600";"1";"Mitarbeiter 2"
		64	"2016-08-11T18:12:12+00:00";"190600";"1";"1.00021";"Mitarbeiter 2"
		65	"2016-06-15T10:35:50+00:00";"1";"0";"1";"Portal"{{/code}}
		66
		67	\|=Return in JSON
		68	\|{{code language="java"}}[
		69	{
		70	"date": "2021-11-23T21:08:13+00:00",
		71	"newOdometer": "262655",
		72	"oldOdometer": "259434",
		73	"kmCorrectionFactor": "1",
		74	"updateBy": "Mitarbeiter 1"
		75	},
		76	{
		77	"date": "2021-08-19T13:19:08+00:00",
		78	"newOdometer": "259434",
		79	"oldOdometer": "257319",
		80	"kmCorrectionFactor": "1",
		81	"updateBy": "Mitarbeiter 1"
		82	},
		83	{
		84	"date": "2021-05-26T16:14:54+00:00",
		85	"newOdometer": "257319",
		86	"oldOdometer": "0",
		87	"kmCorrectionFactor": "0",
		88	"updateBy": "Mitarbeiter 1"
		89	},
		90	{
		91	"date": "2019-08-06T14:18:47+00:00",
		92	"newOdometer": "241000",
		93	"oldOdometer": "213597",
		94	"kmCorrectionFactor": "1.05259",
		95	"updateBy": "Mitarbeiter 2"
		96	},
		97	{
		98	"date": "2018-01-12T17:00:29+00:00",
		99	"newOdometer": "213597",
		100	"oldOdometer": "198227",
		101	"kmCorrectionFactor": "1.08232",
		102	"updateBy": "Mitarbeiter 1"
		103	},
		104	{
		105	"date": "2017-02-03T15:34:37+00:00",
		106	"newOdometer": "198227",
		107	"oldOdometer": "195037",
		108	"kmCorrectionFactor": "1.10995",
		109	"updateBy": "Mitarbeiter 1"
		110	},
		111	{
		112	"date": "2016-10-14T10:50:58+00:00",
		113	"newOdometer": "195037",
		114	"oldOdometer": "193018",
		115	"kmCorrectionFactor": "1",
		116	"updateBy": ""
		117	},
		118	{
		119	"date": "2016-09-07T08:30:51+00:00",
		120	"newOdometer": "193018",
		121	"oldOdometer": "190600",
		122	"kmCorrectionFactor": "1",
		123	"updateBy": "Mitarbeiter 2"
		124	},
		125	{
		126	"date": "2016-08-11T18:12:12+00:00",
		127	"newOdometer": "190600",
		128	"oldOdometer": "1",
		129	"kmCorrectionFactor": "1.00021",
		130	"updateBy": "Mitarbeiter 2"
		131	},
		132	{
		133	"date": "2016-06-15T10:35:50+00:00",
		134	"newOdometer": "1",
		135	"oldOdometer": "0",
		136	"kmCorrectionFactor": "1",
		137	"updateBy": "Portal"
		138	}
		139	]{{/code}}
		140
		141	= Example call =
		142
		143	{{code language="java"}}
		144	https://map.yellowfox.de/rti/vehicle_settings/get_odometer_history.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY
		145	https://map.yellowfox.de/rti/vehicle_settings/get_odometer_history.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=csv
		146	https://map.yellowfox.de/rti/vehicle_settings/get_odometer_history.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&format=json{{/code}}
		147

Wiki source code of vehicle_settings/get_odometer_history.php