Wiki-Quellcode von get_messages.php

Version 2.1 von Dominic Lippmann am 2025/01/17 15:25

version	line-number	content
1.1	1	(% class="box" %)
2.1	2	(((
	3	Inhaltsverzeichnis
	4	)))
	5
1.1	6	{{toc/}}
	7
	8	Liefert die Statusmeldungen für Nachrichten zurück.
2.1	9
1.1	10	= Beschreibung =
2.1	11
	12	(% class="green mark" %)//GET//(%%)// get_messages.php?company=RTI_COMPANYKEY&vehicle=RTI_VEHICLEKEY&language=deu&start=YYYYMMDDHHMMSS&end=YYYYMMDDHHMMSS&filter=1,2,3&sessionkey=ABABABABABABABABABABABABABABAB&format=xml&mode=insertdate//
	13
1.1	14	= Parameter =
2.1	15
	16
1.1	17	\|=Parameter\|=Beschreibung\|=Typ\|=Hinweis\|=Pflicht
2.1	18	\|company\|RTI Firmenschlüssel\|string\| \|ja
1.1	19	\|vehicle\|RTI Fahrzeugschlüssel\|string\|entweder vehicle oder group oder import werden erwartet\|(ja)
	20	\|group\|RTI Gruppenschlüssel\|string\|entweder vehicle oder group oder import werden erwartet\|(ja)
	21	\|import\|RTI Importschlüssel\|string\|entweder vehicle oder group oder import werden erwartet\|(ja)
	22	\|start\|Anfang des Abfragezeitraum\|string\|Format: YYYYMMDDHHMMSS\|ja
	23	\|end\|Ende des Abfragezeitraum\|string\|Format: YYYYMMDDHHMMSS
	24	Die maximale Zeitspanne beträgt 7 Tage.\|ja
	25	\|filter\|Filtermöglichkeit nach Nachrichtentyp\|integer\|1 = Antwort erhalten
	26	2 = Bestätigungsnachricht gesendet
	27	3 = Display ausgeschaltet
	28	4 = Ja/Nein Nachricht gesendet
	29	5 = Nachricht bereits vorhanden
	30	6 = Nachricht erhalten
	31	7 = Nachricht gelesen
	32	8 = Nachricht gelöscht
	33	9 = Nachricht konnte nicht zugestellt werden
	34	10 = Nachricht mit Antwortvorlagen gesendet
	35	11 = Zugestellt
	36	12 = Zustellungsversuch
	37	mehrere Filter sind mit Komma getrennt anzugeben\|nein
	38	\|language\|Bestimmt die Ausgabesprache\|string\|(((
	39	* kein Wert oder "deu" = Deutsch
	40	* "gbr" = englisch
	41	* "fra" = französisch
	42	* "ita" = italienisch
	43	)))\|nein
	44	\|format\|Rückgabeformat\|string\|Format der zurückgelieferten Antwort der Schnittstelle
	45	unterstützte Formate: csv (Standard), xml, json\|nein
	46	\|sessionkey\|Enthält den Sessionkey aus "do_message.php"\|string\|Entweder dieses Feld ist gesetzt, oder start und end\|ja
	47	\|mode\|Abfrage nach Historydate oder Insertdate\|string\|Entweder historydate (standard) oder insertdate\|nein
	48
	49	= Mögliche Nachrichtenstatus =
2.1	50
1.1	51	\|=Status\|=Erläuterung
	52	\|Zustellungsversuch\|Die Nachricht hat das YellowFox Rechenzentrum verlassen
	53	\|Zugestellt\|Die Nachricht ist auf dem Display erfolgreich angekommen
	54	\|Display ausgeschaltet\|Das Display kann die Nachricht nicht empfangen, da es ausgeschaltet ist
	55	\|Nachricht bereits vorhanden\|Die Nachricht kann nicht erneut zugestellt werden, da diese bereits vorhanden ist
	56	\|Nachricht erhalten\|Es ist eine Nachricht im Portal angekommen, welche auf einem Display erstellt wurde
	57	\|Nachricht gelesen\|Nachricht wurde auf dem Display gelesen
	58	\|Nachricht gelöscht\|Nachricht wurde auf dem Display gelöscht
	59	\|Nachricht konnte nicht zugestellt werden\|Die Nachricht hat das Display nicht erreicht, weitere Zustellungsversuche werden nicht durchgeführt
	60	\|Nachricht mit Antwortvorlagen gesendet\|Die Nachricht wurde mit Antwortvorlagen versendet
	61	\|Ja/Nein Nachricht gesendet\|Die Nachricht wurde mit einer Ja-Nein-Option als Antwort versendet
	62	\|Bestätigungsnachricht gesendet\|Die Nachricht wurde mit einer Bestätigungsoption versendet
	63	\|Antwort erhalten\|Eine Antwort des Displays ist eingegangen
	64
	65	= Rückgabe =
	66
2.1	67	Es wird standardmäßig ein CSV-String zurückgegeben, welcher zu jedem Fahrzeug die Auswertung der Nachrichten enthält. Bei fehlenden Pflichtparametern wird ein "(% class="error" %)ERROR:Beschreibung(%%)" zurückgegeben
	68
1.1	69	== CSV-Format ==
2.1	70
1.1	71	=== Metainformationen ===
2.1	72
1.1	73	\|=Trennzeichen\|Semikolon ( ; )
	74	\|=Textbegrenzer\|Doppeltes Hochkomma ( " )
	75	\|=Zeilenende\|0x0D 0x0A (CarriageReturn LineFeed)
	76	\|=Header\|Zeile 1
	77
	78	=== Spalten ===
2.1	79
	80	\|=Spalte\|=Beschreibung\|=
1.1	81	\|DATE\|Datum der ausgeführten Aktion\|Format: YYYY-MM-DD HH:MM:SS
2.1	82	\|STATE\|Beschreibung der Aktion\|
	83	\|SOURCE\|Auslöser der Aktion (Person)\|
	84	\|SOURCENAME\|Auslöser der Aktion (System)\|
	85	\|SESSIONKEY\|Sessionkey der Nachricht\|
1.1	86	\|REQUESTDATE\|Systemzeit der Abfrage\|Format: YYYY-MM-DD HH:MM:SS
	87	\|INSERTDATE\|Systemzeit der Verarbeitung\|Format: YYYY-MM-DD HH:MM:SS
2.1	88	\|TEXT\|Inhalt der Nachricht\|
	89	\|RTI_IDENT\|RTI Ident des Fahrzeuges\|
1.1	90
	91	Rückgabe als CSV
	92	{{code language="java"}}"DATE";"STATE";"SOURCE";"SOURCENAME";"SESSIONKEY";"REQUESTDATE";"INSERTDATE";"TEXT";"RTI_IDENT"
	93	"2016-12-02 13:09:15";"Bestätigungsnachricht gesendet";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:09:20";"Nachricht 1";"Ident1"
	94	"2016-12-02 13:08:25";"Ja/Nein Nachricht gesendet";"PORTAL";"Disponent 1";"";"2016-12-05 10:17:15";"2016-12-02 13:08:15";"Frage 1?";"Ident1"
	95	"2016-12-02 09:09:15";"Antwort erhalten";"PND";"Car 1";"ABABABABABABABABABABAB";"2016-12-05 10:17:52";"2016-12-02 09:09:20";"Antwort 1";"Ident1"{{/code}}
	96
	97	== XML Format ==
2.1	98
1.1	99	Rückgabe als XML
	100	{{code language="xml"}}<?xml version="1.0" encoding="UTF-8" standalone="no"?>
	101	<!DOCTYPE yf_getmessages SYSTEM "http://map.yellowfox.de/rti/dtd/yf_getmessages.dtd">
	102	<yf_getmessages>
	103	<message>
	104	<date>2016-12-02 13:09:15</date>
	105	<state>Bestätigungsnachricht gesendet</state>
	106	<source>PORTAL</source>
	107	<sourcename>Disponent 1</sourcename>
	108	<sessionkey/>
	109	<requestdate>2016-12-05 10:17:15</requestdate>
	110	<insertdate>2016-12-02 13:09:20</insertdate>
	111	<text>Nachricht 1</text>
2.1	112	<rti_ident>Ident1</rti_ident>
1.1	113	</message>
	114	<message>
	115	<date>2016-12-02 13:08:25</date>
	116	<state>Ja/Nein Nachricht gesendet</state>
	117	<source>PORTAL</source>
	118	<sourcename>Disponent 1</sourcename>
	119	<sessionkey/>
	120	<requestdate>2016-12-05 10:17:15</requestdate>
	121	<insertdate>2016-12-02 13:08:15</insertdate>
	122	<text>Frage 1?</text>
2.1	123	<rti_ident>Ident1</rti_ident>
1.1	124	</message>
	125	<message>
	126	<date>2016-12-02 09:09:15</date>
	127	<state>Antwort erhalten</state>
	128	<source>PND</source>
	129	<sourcename>Car 1</sourcename>
	130	<sessionkey>ABABABABABABABABABABAB</sessionkey>
	131	<requestdate>2016-12-05 10:17:52</requestdate>
	132	<insertdate>2016-12-02 09:09:20</insertdate>
	133	<text>Antwort 1</text>
2.1	134	<rti_ident>Ident1</rti_ident>
1.1	135	</message>
	136	</yf_getmessages>{{/code}}
	137
	138	== JSON Format (RFC 4627) ==
2.1	139
1.1	140	Rückgabe als JSON
	141	{{code language="java"}}[
	142	{"date":"2016-12-02 13:09:15","state":"Bestätigungsnachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:09:20","text":"Nachricht 1","rti_ident":"Ident1"},
	143	{"date":"2016-12-02 13:08:25","state":"Ja\/Nein Nachricht gesendet","source":"PORTAL","sourcename":"Disponent 1","sessionkey":"","requestdate":"2016-12-05 10:17:15","insertdate":"2016-12-02 13:08:15","text":"Frage 1?","rti_ident":"Ident1"},
	144	{"date":"2016-12-02 09:09:15","state":"Antwort erhalten","source":"PND","sourcename":"Car 1","sessionkey":"ABABABABABABABABABABAB","requestdate":"2016-12-05 10:17:52","insertdate":"2016-12-02 09:09:20","text":"Antwort 1","rti_ident":"Ident1"}
	145	] {{/code}}
	146
	147	= Beispiele =
	148
	149	Abfrage über SessionKey
	150	{{code language="java"}}https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle=VEHICLE_RTIKEY&language=deu&sessionkey=SESSION_KEY
	151
	152	https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&vehicle={"type":"car_ident","groupKey":"GROUP_RTIKEY","ident":"VEHICLE_IDENT"}&language=deu&sessionkey=SESSION_KEY{{/code}}
	153
	154	Abfrage über Zeitraum
	155	{{code language="java"}}https://map.yellowfox.de/rti/get_messages.php?company=COMPANY_RTIKEY&group=GROUP_RTIKEY&language=gbr&start=20161202083015&end=20161205161500&filter=1,2,4,11&format=xml&mode=insertdate{{/code}}
	156