positions/get_pos_data.php

1

(% class="box" %)

2

(((Inhaltsverzeichnis)))

3

4

5

Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.

6

Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.

7

= Beschreibung =

8

**(% class="green mark" %)GET(%%) positions/get_pos_data.php****?company**=//COMPANY_RTIKEY//**&vehicle**=//VEHICLE_RTIKEY//**&start**=//YYYY-MM-DDTHH:MM:SS+HH:mm**&end**//=//YYYY-MM-DDTHH:MM:SS+HH:mm//

9

= Parameter =

10

11

|company|RTI Firmenschlüssel|string||ja

|date_type|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung|string|'insert' (Standard) = Verarbeitungsdatum

19

'gps' = Datum an dem die Positionsmeldung stattgefunden hat|nein

20

|additional_data|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten|string[]|(((

21

* 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4

22

* 'trailer' holt die Trailerinformationen

23

)))|nein

24

|hide_display|Blendet Meldungen vom Display aus|int|(((

25

* 0 (Standard) = Displaymeldungen werden mit ausgegeben

26

* 1 = Displaymeldungen werden nicht mit ausgegeben

27

)))|nein

28

|offset|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.|int||nein

(% class="box" %)

(((

**Hinweis zur Datumseingrenzung**

33

Sie können 3 verschiedene Modi nutzen:

34

a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)

35

b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung

36

c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug

)))

= Rückgabe =

Es wird ein **string** zurückgegeben. Im Fehlerfall wird "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben.

41

42

== Feldbeschreibung ==

43

|=Feld|=Beschreibung

44

|vehicle_sign|Kennzeichen

45

|rti_ident|RTI Ident

46

|insert_date|Wann wurde diese Meldung von YellowFox verarbeitet?

47

|gps_date|Wann wurde diese Meldung von dem Fahrzeug gesendet?

48

|lat|Latitude

49

|lon|Logitude

50

|text_position|Textaddresse der GPS Position

51

|customer|Kundenname (sofern die Adresse zu einem Kunden gehört)

52

|direction|Richtung in Grad

53

|satellites|Anzahl der Satelliten zur Positionsbestimmung

54

|speed|Geschwindigkeit in km/h

55

|ignition|Ist die Zündung an (1) oder aus (0) ?

56

|reason|Warum wurde diese Positionsmeldung generiert?

57

|km|Kilometerstand

58

|bszX|Wert des Betriebsstundenzählers

59

|driver_X|Name des Fahrers

60

|driverkey_X|Personalschlüssel des Fahrers

61

|eta_time|Wenn zu einem Ziel navigiert wird: Planmäßige Ankunft

62

|eta_distance|Wenn zu einem Ziel navigiert wird: verbleibende Distanz

63

|eta_duration|Wenn zu einem Ziel navigiert wird: verbleibende Dauer

64

|eta_lat|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition

65

|eta_lon|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition

66

|eta_desc|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition

67

|digital_inputs|Status der Telemetrieeingänge

68

nr = Nummer des Eingangs (1 bis 7)

69

name = Name des Eingangs

70

state = Status des Eingangs als Text

71

value = Status des Eingangs (1 = an, 0 = aus)

72

|trailer_info|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer

73

date = Datum des Status

74

type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)

75

name = Name des verbunden Trailers/Zugmaschine

76

rti_ident = RTI Ident des Trailers

77

state = Verbindungsstatus (CONNECTED oder DISCONNECTED)

78

|digital_temperature_values|Optionales Feld. Beinhaltet digitale Temperaturdaten.

79

nr = Nummer des Eingangs

80

value = Temperatur in °C

81

set_point = Angestrebter Wert in °C

82

|analogue_temperature_values|Optionales Feld. Beinhaltet analoge Temperaturdaten.

83

nr = Nummer des Eingangs

84

value = Temperatur in °C

85

86

== JSON ==

87

Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].

88

89

{{code language="java"}}{

"_date" => null,

"_links" => {

"next" => {

"href" => null

}

},

"has_more" => false,

"items": [

{

"vehicle_sign": "FTL YF 123",

100

"rti_ident": "",

101

"insert_date": "2022-09-22T13:23:35+02:00",

102

"gps_date": "2022-09-22T13:23:23+02:00",

103

"lat": 48.20398,

104

"lon": 16.22613,

105

"text_position": "A-1140 Wien (Penzing) Wientalstraße (B1)",

"customer": null,

"direction": 155,

"satellites": 12,

"speed": 0,

"ignition": 0,

"reason": "AnalogMinuteInterval",

"km": 361549,

"bsz1": null,

"bsz2": null,

"driver_1": null,

"driverkey_1": null,

"driver_2": null,

"driverkey_2": null,

"eta_time": null,

"eta_distance": null,

121

"eta_duration": null,

"eta_lat": null,

"eta_lon": null,

"eta_desc": null,

"digital_inputs": [

{

"nr": 2,

"name": "Sensor 2",

"state": "",

"value": 0

}

],

"trailer_info": {

"date": "2022-09-22T13:18:35+02:00",

135

"type": "TRAILER",

136

"name": "Trailer 123",

137

"rti_ident": "TR_ID",

138

"state":"CONNECTED"

139

},

140

"digital_temperature_values": [

{

"nr": 1,

"value": 13.2,

"set_point": 13.3

}

],

"analogue_temperature_values": [

{

"nr": 1,

"value": 21.56

},

{

"nr": 2,

"value": 11.83

}

]

}

]

}{{/code}}

= Beispielaufrufe =

**Abfrage Zeitraum für eine Gruppe**

163

{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00&additional_data[]=temp{{/code}}

164

165

**Abfrage fester Zeitpunkt für ein Fahrzeug**

166

{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}

167

168

**Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident**

169

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

170

Wiki-Quellcode von positions/get_pos_data.php

Navigation

author	version	line-number	content
		1	(% class="box" %)
		2	(((Inhaltsverzeichnis)))
		3	{{toc/}}
		4
		5	Gibt die Positionsdaten eines Fahrzeuges oder einer Fahrzeuggruppe zurück.
		6	Wird keine Zeitraumsbegrenzung mitgegeben, wird die jeweilig aktuelle Position zurückgeliefert.
		7	= Beschreibung =
		8	(% class="green mark" %)GET(%%) positions/get_pos_data.php?company=//COMPANY_RTIKEY//&vehicle=//VEHICLE_RTIKEY//&start=//YYYY-MM-DDTHH:MM:SS+HH:mm&end//=//YYYY-MM-DDTHH:MM:SS+HH:mm//
		9	= Parameter =
		10	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
		11	\|company\|RTI Firmenschlüssel\|string\|\|ja
		12	\|vehicle\|RTI Fahrzeugschlüssel\|string\|entweder vehicle oder group Parameter\|(ja)
		13	\|group\|RTI Gruppenschlüssel\|string\|entweder vehicle oder group Parameter\|(ja)
		14	\|start\|Anfang des Abfragezeitraum\|datestring\|Format: ISO 8601\|nein
		15	\|end\|Ende des Abfragezeitraum\|datestring\|Format: ISO 8601\|nein
		16	\|query_date\|Datum zu welchen Zeitpunkt die jeweilige Position angezeigt werden soll\|datestring\|Format: ISO 8601\|nein
		17	\|format\|Rückgabeformat\|string\|json (Standard)\|nein
		18	\|date_type\|Welches Datum bildet die Grundlage für die Zeitraumseingrenzung\|string\|'insert' (Standard) = Verarbeitungsdatum
		19	'gps' = Datum an dem die Positionsmeldung stattgefunden hat\|nein
		20	\|additional_data\|Zusätzliche Parameter um bestimmte Informationen zusätzlich zu erhalten\|string[]\|(((
		21	* 'temp' holt die Temperaturwerte der Digitalen Sensoren 1-8 und Analogen Sensoren 1-4
		22	* 'trailer' holt die Trailerinformationen
		23	)))\|nein
		24	\|hide_display\|Blendet Meldungen vom Display aus\|int\|(((
		25	* 0 (Standard) = Displaymeldungen werden mit ausgegeben
		26	* 1 = Displaymeldungen werden nicht mit ausgegeben
		27	)))\|nein
		28	\|offset\|Die Anfrage liefert maximal 5000 Datensätze zurück. Durch ein Offset können Sie den nächsten Block anfragen.\|int\|\|nein
		29
		30	(% class="box" %)
		31	(((
		32	Hinweis zur Datumseingrenzung
		33	Sie können 3 verschiedene Modi nutzen:
		34	a) Sie geben start und end an und erhalten damit alle Positionen innerhalb dieser Zeitspanne (diese beiden Zeitangaben dürfen maximal 24 Stunden auseinander liegen)
		35	b) Sie geben nur query_date an und erhalten damit pro Fahrzeug die zu diesem Zeitpunkt aktuellste Meldung
		36	c) Sie geben keinen Datumsparameter an und erhalten damit die derzeit aktuellste Position pro Fahrzeug
		37	)))
		38
		39	= Rückgabe =
		40	Es wird ein string zurückgegeben. Im Fehlerfall wird "(% class="error" %)ERROR:Beschreibung(%%)" zurückgegeben.
		41
		42	== Feldbeschreibung ==
		43	\|=Feld\|=Beschreibung
		44	\|vehicle_sign\|Kennzeichen
		45	\|rti_ident\|RTI Ident
		46	\|insert_date\|Wann wurde diese Meldung von YellowFox verarbeitet?
		47	\|gps_date\|Wann wurde diese Meldung von dem Fahrzeug gesendet?
		48	\|lat\|Latitude
		49	\|lon\|Logitude
		50	\|text_position\|Textaddresse der GPS Position
		51	\|customer\|Kundenname (sofern die Adresse zu einem Kunden gehört)
		52	\|direction\|Richtung in Grad
		53	\|satellites\|Anzahl der Satelliten zur Positionsbestimmung
		54	\|speed\|Geschwindigkeit in km/h
		55	\|ignition\|Ist die Zündung an (1) oder aus (0) ?
		56	\|reason\|Warum wurde diese Positionsmeldung generiert?
		57	\|km\|Kilometerstand
		58	\|bszX\|Wert des Betriebsstundenzählers
		59	\|driver_X\|Name des Fahrers
		60	\|driverkey_X\|Personalschlüssel des Fahrers
		61	\|eta_time\|Wenn zu einem Ziel navigiert wird: Planmäßige Ankunft
		62	\|eta_distance\|Wenn zu einem Ziel navigiert wird: verbleibende Distanz
		63	\|eta_duration\|Wenn zu einem Ziel navigiert wird: verbleibende Dauer
		64	\|eta_lat\|Wenn zu einem Ziel navigiert wird: Latitude der Zielposition
		65	\|eta_lon\|Wenn zu einem Ziel navigiert wird: Longitude der Zielposition
		66	\|eta_desc\|Wenn zu einem Ziel navigiert wird: Textadresse der Zielposition
		67	\|digital_inputs\|Status der Telemetrieeingänge
		68	nr = Nummer des Eingangs (1 bis 7)
		69	name = Name des Eingangs
		70	state = Status des Eingangs als Text
		71	value = Status des Eingangs (1 = an, 0 = aus)
		72	\|trailer_info\|Optionales Feld. Beinhaltet Informationen zum Kopplungszustand mit einem Trailer
		73	date = Datum des Status
		74	type = verbunden mit Trailer (TRAILER) oder Zugmaschine (VEHICLE)
		75	name = Name des verbunden Trailers/Zugmaschine
		76	rti_ident = RTI Ident des Trailers
		77	state = Verbindungsstatus (CONNECTED oder DISCONNECTED)
		78	\|digital_temperature_values\|Optionales Feld. Beinhaltet digitale Temperaturdaten.
		79	nr = Nummer des Eingangs
		80	value = Temperatur in °C
		81	set_point = Angestrebter Wert in °C
		82	\|analogue_temperature_values\|Optionales Feld. Beinhaltet analoge Temperaturdaten.
		83	nr = Nummer des Eingangs
		84	value = Temperatur in °C
		85
		86	== JSON ==
		87	Eine JSON Schema Beschreibung der Rückgabe finden Sie [[hier>>https://map.yellowfox.de/rti/schema/get_pos_data_schema.json]].
		88
		89	{{code language="java"}}{
		90	"_date" => null,
		91	"_links" => {
		92	"next" => {
		93	"href" => null
		94	}
		95	},
		96	"has_more" => false,
		97	"items": [
		98	{
		99	"vehicle_sign": "FTL YF 123",
		100	"rti_ident": "",
		101	"insert_date": "2022-09-22T13:23:35+02:00",
		102	"gps_date": "2022-09-22T13:23:23+02:00",
		103	"lat": 48.20398,
		104	"lon": 16.22613,
		105	"text_position": "A-1140 Wien (Penzing) Wientalstraße (B1)",
		106	"customer": null,
		107	"direction": 155,
		108	"satellites": 12,
		109	"speed": 0,
		110	"ignition": 0,
		111	"reason": "AnalogMinuteInterval",
		112	"km": 361549,
		113	"bsz1": null,
		114	"bsz2": null,
		115	"driver_1": null,
		116	"driverkey_1": null,
		117	"driver_2": null,
		118	"driverkey_2": null,
		119	"eta_time": null,
		120	"eta_distance": null,
		121	"eta_duration": null,
		122	"eta_lat": null,
		123	"eta_lon": null,
		124	"eta_desc": null,
		125	"digital_inputs": [
		126	{
		127	"nr": 2,
		128	"name": "Sensor 2",
		129	"state": "",
		130	"value": 0
		131	}
		132	],
		133	"trailer_info": {
		134	"date": "2022-09-22T13:18:35+02:00",
		135	"type": "TRAILER",
		136	"name": "Trailer 123",
		137	"rti_ident": "TR_ID",
		138	"state":"CONNECTED"
		139	},
		140	"digital_temperature_values": [
		141	{
		142	"nr": 1,
		143	"value": 13.2,
		144	"set_point": 13.3
		145	}
		146	],
		147	"analogue_temperature_values": [
		148	{
		149	"nr": 1,
		150	"value": 21.56
		151	},
		152	{
		153	"nr": 2,
		154	"value": 11.83
		155	}
		156	]
		157	}
		158	]
		159	}{{/code}}
		160
		161	= Beispielaufrufe =
		162	Abfrage Zeitraum für eine Gruppe
		163	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&start=2022-09-22T13:23:00%2B00:00:00&end=2022-09-22T14:23:00%2B00:00:00&additional_data[]=temp{{/code}}
		164
		165	Abfrage fester Zeitpunkt für ein Fahrzeug
		166	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&query_date=2022-09-22T13:23:00%2B00:00:00{{/code}}
		167
		168	Abfrage jetziger Zeitpunkt für ein Fahrzeug mit RTI Ident
		169	{{code language="java"}}https://map.yellowfox.de/rti/positions/get_pos_data.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}{{/code}}
		170