Wiki-Quellcode von inventory/get_history.php

Zuletzt geändert von YellowFox_RD am 2025/03/04 16:21

version	line-number	content
2.1	1	(% class="box" %)
3.1	2	(((
	3	Inhaltsverzeichnis
	4	)))
	5
2.1	6	{{toc/}}
1.1	7
	8	Gibt die gebuchten Aktivitäten und Positionsaktualisierungen (nur in Verbindung mit einem YellowFox Beacon) für ein- oder mehrere Objekte im gewünschten Zeitraum wieder.
3.1	9
2.1	10	= Beschreibung =
1.1	11
3.1	12	//GET /inventory/get_history.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY//
	13
2.1	14	= Parameter =
3.1	15
2.1	16	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
3.1	17	\|company\|RTI Firmenschlüssel\|string\| \|ja
	18	\|import\|RTI Importschlüssel\|string\| \|ja
	19	\|offset\| \|unsigned int\|Pro Abfrage werden bis zu 1000 Einträge zurück geliefert. Um weitere Einträge zu erhalten, können Sie ein Offset angeben.\|nein
	20	\|date_from\|(% rowspan="2" %)Format: ISO 8601
2.1	21	(YYYY-MM-DD)\|datestring\|Startzeit, ab wann Buchungen abgerufen werden sollen.
1.1	22	Ist kein Wert für date_from und date_to gesetzt, wird einen Monat zurück gegangen.\|nein
2.1	23	\|date_to\|datestring\|Endzeit, bis wann Buchungen abgerufen werden sollen. Ist keine Zeit angegeben, wird der Zeitpunkt der Abfrage verwendet.\|nein
	24	\|profiles[]\|Profiles UUID\|[] string\|optionale Einschränkung auf eine Liste an Objektprofilen\|nein
	25	\|objects[]\|Objects UUID\|[] string\|optionale Einschränkung auf eine Liste an Objekten\|nein
	26	\|groups[]\|Gruppenname UUID\|[] string\|optionale Einschränkung auf eine Liste an Objektgruppen\|nein
3.1	27	\|with_beacon\|Beacon Positionsmeldungen\|bool\|(((
2.1	28	* false: nur gebuchte Objekt- oder Statusänderungen werden zurückgegeben
	29	* true: alle Positionsaktualisierungen durch Beacons werden mit zurückgegeben.(((
	30	* Achtung: Dadurch können schnell große Datenmengen entstehen.
	31	)))
	32	)))\|nein
1.1	33
2.1	34	(% class="box" %)
	35	(((
3.1	36	Hinweis zur Datumseingrenzung
	37	Sie können 3 verschiedene Modi nutzen:
1.1	38	a) ohne Datumsangabe (date_from, date_to) werden die Daten des letzten Monats abgerufen
	39	b) mit gesetztem Startdatum (date_from) werden alle Daten ab diesem Datum abgerufen (maximal 1 Monat)
	40	c) mit gesetztem Start- und Enddatum werden alle Daten im angegebenen Zeitraum abgerufen (maximal 1 Monat)
2.1	41	)))
1.1	42
2.1	43	= Rückgabe =
3.1	44
2.1	45	Bei Erfolg erhalten Sie die Rückgabe im JSON Format. Bei fehlenden Pflichtparametern oder Fehlern wird ein "(% class="error" %)ERROR:Beschreibung(%%)" zurückgegeben.
1.1	46
2.1	47	== Mögliche Fehlerwerte ==
3.1	48
2.1	49	\|=Fehler\|=Beschreibung
	50	\|MISSING_COMPANY\|Firmenschlüssel fehlt
	51	\|INVALID_COMPANY\|Firma nicht gefunden. Dies kann an einem fehlerhaften Firmen- oder Import-Schlüssel liegen.
	52	\|ERROR_MAINTENANCE\|Ihre Firma wird gerade gewartet, währenddessen sind keine RTI Abfragen möglich.
	53	\|MISSING_IMPORT\|Import-Schlüssel fehlt.
	54	\|INVENTORY_NOT_ACTIVATED\|Objektverwaltung ist für ihre Firma nicht aktiviert.
	55	\|INVALID_DATE_RANGE\|Zeitraum wurde überschreiten.
	56	\|MISSING_DATE_FROM\|DateFrom fehlt
	57	\|INVALID_FORMAT_OFFSET\|Offset ist falsch
1.1	58
2.1	59	== JSON ==
3.1	60
2.1	61	Die genaue Spezifikation finden Sie anhand einer JSON Schema Datei [[hier>>https://map.yellowfox.de/rti/schema/get_history_schema.json]].
1.1	62
2.1	63	Beispiel Ausgabe
1.1	64
3.1	65	{{code language="js"}}
	66	{
2.1	67	"_date": "2025-02-26T10:13:17+01:00",
	68	"_links": {
	69	"next": {
	70	"href": null
	71	}
	72	},
	73	"events": [
	74	{
	75	"uuid": "7d64c6ac-49fd-0d4e-27e6-f7c1ea727b2b",
	76	"gpsdate": "2025-02-25T11:59:20+01",
	77	"data_source": "booking",
	78	"driver_name": null,
	79	"vehicle_sign": null,
	80	"lat": 0,
	81	"lon": 0,
	82	"satellites": 0,
	83	"text_position": "",
	84	"customer_text": null,
	85	"activities": [
	86	{
	87	"value": "Abgesetzt",
	88	"description": "Status"
	89	},
	90	{
	91	"value": "Bauhof",
	92	"description": "Status"
	93	},
	94	{
	95	"value": 1,
	96	"description": "Betriebsgewicht"
	97	},
	98	{
	99	"value": 12,
	100	"description": "Verdichtungstiefe"
	101	},
	102	{
	103	"value": 22,
	104	"description": "Flächenleistung"
	105	},
	106	{
	107	"value": "Hallo",
	108	"description": "Status 2"
	109	},
	110	{
	111	"value": 1,
	112	"description": "test"
	113	}
	114	]
	115	},
	116	{
	117	"uuid": "a5ddb6a3-20ad-a418-5236-bc7e6a229b55",
	118	"gpsdate": "2025-02-25T11:58:29+01",
	119	"data_source": "position",
	120	"driver_name": null,
	121	"vehicle_sign": null,
	122	"lat": 51.03629,
	123	"lon": 13.59799,
	124	"satellites": 8,
	125	"text_position": null,
	126	"customer_text": "test",
	127	"activities": []
	128	}
1.1	129
2.1	130	]
3.1	131	}
	132	{{/code}}
1.1	133
2.1	134	= Beispielaufrufe =
3.1	135
	136	{{code language="java"}}
	137	https://map.yellowfox.de/rti/inventory/get_history.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY
	138	{{/code}}