Änderungen von Dokument get_personnel.php

Zusammenfassung

• Seiteneigenschaften (2 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Dokument-Autor

...	...	@@ -1,1 +1,1 @@
1		-XWiki.YellowFox_RD
	1	+XWiki.yf-dominic

Inhalt

...	...	@@ -1,28 +1,32 @@
1	1	(% class="box" %)
2		-(((Inhaltsverzeichnis)))
	2	+(((
	3	+Inhaltsverzeichnis
	4	+)))
	5	+
3	3	{{toc/}}
4	4
5	5	Abfrage der aktuell angelegten Personen der der Personalverwaltung
	9	+
6	6	= Beschreibung =
7		-//**(% class="green mark" %)GET(%%) get_personnel.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY&**format=**csv//
	11	+
	12	+(% class="green mark" %)//**GET**//(%%)//** get_personnel.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY&**format=**csv//
	13	+
8	8	= Parameter =
	15	+
9	9	|=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
10		-|company|RTI Firmenschlüssel|string||ja
11		-|import|RTI Importschlüssel|string||ja
12		-|format|Ausgabeformat der Liste|string|unterstützte Formate sind:
13		-(((
	17	+|company|RTI Firmenschlüssel|string| |ja
	18	+|import|RTI Importschlüssel|string| |ja
	19	+|format|Ausgabeformat der Liste|string|unterstützte Formate sind:(((
14	14	* csv - Ausgabe im CSV Format
15	15	* json - Ausgabe im JSON Format
16	16	* xml - Ausgabe im XML Format
17		-)))
18		-Standard: csv|nein
	23	+)))Standard: csv|nein
19	19	|history|Ausgabe aller Personalschlüssel einer Person oder nur des aktuellsten|int|(((
20	20	* 0 - nur den aktuellen Schlüssel ausgeben
21	21	* 1 - alle Personalschlüssel ausgeben(((
22	22	* Ein Eintrag pro Schlüssel
23	23	)))
24		-)))
25		-Standard: 0|nein
	29	+)))Standard: 0|nein
26	26	|id|Eingrenzung der Ausgabe auf die angegebene Personal-ID|string|siehe //strict// Parameter|nein
27	27	|name|Eingrenzung der Ausgabe auf Personen mit dem angegebenen Namen|string|siehe //strict// Parameter|nein
28	28	|pkey|Eingrenzung der Ausgabe auf den angegebenen Personalschlüssel|string|siehe //strict// Parameter|nein
...	...	@@ -30,28 +30,30 @@
30	30	|strict|Unterscheidung ob genau das Suchwort gefunden werden soll oder alle Ergebnisse, die das Suchwort enthalten|int|(((
31	31	* 0 - liefert alle Ergebnisse, die den gesuchten Begriff enthalten
32	32	* 1 - liefert nur die Ergebnisse, die genau zum gesuchten Wert passen
33		-)))
34		-Standard: 1
35		-Betrifft die Parameter:// id, name, pkey, group//|nein
	37	+)))Standard: 1
	38	+Betrifft die Parameter: id, name, pkey, group|nein
36	36
37	37	= Rückgabe =
38		-Es wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "**(% class="error" %)403 - Verboten: Zugriff verweigert.(%%)**" HTTP-Header gesendet.
	41	+
	42	+Es wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "(% class="error" %)**403 - Verboten: Zugriff verweigert.**(%%)" HTTP-Header gesendet.
	43	+
39	39	== Spalten ==
40		-|=Spalte CSV|=Spalte JSON/XML|=Bezeichnung Personalverwaltung|=Beschreibung|=Hinweis|=
41		-|ID|id|MA-Nummer|selbstdefinierte eindeutige Mitarbeiternummer||
42		-|NAME|name|Name|vollständiger Name der Person||
43		-|KEY|key[id]|Personalschlüssel|Personalschlüssel (für Buchungen über YellowFox)||
44		-|VALID_FROM|key[valid_from]|Personalschlüssel gültig ab|Gültigkeitsbeginn des Personalschlüssels||Format: YYYY-MM-DD HH:MM:SS
45		-|VALID_TO|key[valid_to]|Personalschlüssel gültig bis|Gültigkeitsende des Personalschlüssels||Format: YYYY-MM-DD HH:MM:SS
46		-|GROUPS|groups[group]|Personalgruppen|Komma getrennte Liste mit den Bezeichnungen der zugewiesenen Personalgruppen||
47		-|CARD_NR|card_nr|Ausweisnummer|Entspricht der optional zuweisbaren Ausweisnummer, welche zur Erfassung von Buchungen mittels ReinerSCT genutzt wird||
48		-|DRV_LICENCE_NR|drv_licence[id]|Führerschein|Führerscheinnummer der Person|Daten nur bei gebuchtem Tacho Archiv|
	45	+
	46	+|=Spalte CSV|=Spalte JSON/XML|=Bezeichnung Personalverwaltung|=Beschreibung|=Hinweis|=
	47	+|ID|id|MA-Nummer|selbstdefinierte eindeutige Mitarbeiternummer| |
	48	+|NAME|name|Name|vollständiger Name der Person| |
	49	+|KEY|key[id]|Personalschlüssel|Personalschlüssel (für Buchungen über YellowFox)| |
	50	+|VALID_FROM|key[valid_from]|Personalschlüssel gültig ab|Gültigkeitsbeginn des Personalschlüssels| |Format: YYYY-MM-DD HH:MM:SS
	51	+|VALID_TO|key[valid_to]|Personalschlüssel gültig bis|Gültigkeitsende des Personalschlüssels| |Format: YYYY-MM-DD HH:MM:SS
	52	+|GROUPS|groups[group]|Personalgruppen|Komma getrennte Liste mit den Bezeichnungen der zugewiesenen Personalgruppen| |
	53	+|CARD_NR|card_nr|Ausweisnummer|Entspricht der optional zuweisbaren Ausweisnummer, welche zur Erfassung von Buchungen mittels ReinerSCT genutzt wird| |
	54	+|DRV_LICENCE_NR|drv_licence[id]|Führerschein|Führerscheinnummer der Person|Daten nur bei gebuchtem Tacho Archiv|
49	49	|DRV_LICENCE_VALID_TO|drv_licence[valid_to]|Führerschein gültig bis|Ablaufdatum des Führerscheins|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
50		-|IDENTITY_CARD_NR|identity_card[id]|Personalausweis|Personalausweisnummer|Daten nur bei gebuchtem Tacho Archiv|
	56	+|IDENTITY_CARD_NR|identity_card[id]|Personalausweis|Personalausweisnummer|Daten nur bei gebuchtem Tacho Archiv|
51	51	|IDENTITY_CARD_VALID_TO|identity_card[valid_to]|Personalausweis gültig bis|Ablaufdatum des Personalausweises|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
52		-|PASSPORT_NR|passport[id]|Reisepass|Reisepass Nummer|Daten nur bei gebuchtem Tacho Archiv|
	58	+|PASSPORT_NR|passport[id]|Reisepass|Reisepass Nummer|Daten nur bei gebuchtem Tacho Archiv|
53	53	|PASSPORT_VALID_TO|passport[valid_to]|Reisepass gültig bis|Ablaufdatum des Reisepasses|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
54		-|ADR_CERTIFICATE_NR|adr_certificate[id]|ADR Bescheinigung|Nummer der ADR Bescheinigung|Daten nur bei gebuchtem Tacho Archiv|
	60	+|ADR_CERTIFICATE_NR|adr_certificate[id]|ADR Bescheinigung|Nummer der ADR Bescheinigung|Daten nur bei gebuchtem Tacho Archiv|
55	55	|ADR_CERTICATE_VALID_TO|adr_certificate[valid_to]|ADR Bescheinigung gültig bis|Ablaufdatum der ADR Bescheinigung|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
56	56	|BKRFQG_VALID_TO|bkrfqg[valid_to]|Qualifikation laut Schlüsselzahl 95 gültig bis|Gültigkeit der Schulung zum Berufskraftfahrerqualifikationsgesetz|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
57	57	|BIRTHDATE|birthdate|Geburtsdatum|Geburtsdatum der Person|Daten nur bei gebuchtem Tacho Archiv
...	...	@@ -58,15 +58,18 @@
58	58	Wenn Tag und/oder Monat unbekannt, wird der Geburtstag mit "XX" für die unbekannten Werte aufgefüllt entsprechend deutschem Ausweisgesetz
59	59	(Bsp: 1980-06-XX oder 1980-XX-XX)|Format: YYYY-MM-DD HH:MM:SS
60	60	|JOB_START_DATE|job_start_date|Einstellungsdatum|Einstellungsdatum der Person|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
61		-|DRV_LICENCE_CHECK_TAG_ID|drv_licence_check[tag_id]|NFC Tag ID|NFC Tag ID zur Führerscheinkontrolle||
62		-|DRV_LICENCE_CHECK_LAST_CHECK|drv_licence_check[last_check]|letzte Führerscheinkontrolle|Datum der letzten Führerscheinkontrolle||Format: YYYY-MM-DD HH:MM:SS
63		-|DRV_LICENCE_CHECK_NEXT_CHECK|drv_licence_check[next_check]|nächste Führerscheinkontrolle|Datum der nächsten fälligen Führerscheinkontrolle||Format YYYY-MM-DD
64		-|DRV_LICENCE_CHECK_INTERVAL|drv_licence_check[interval]|Kontrollintervall|Kontrollintervall zwischen 2 Abfragen in Sekunden||
	67	+|DRV_LICENCE_CHECK_TAG_ID|drv_licence_check[tag_id]|NFC Tag ID|NFC Tag ID zur Führerscheinkontrolle| |
	68	+|DRV_LICENCE_CHECK_LAST_CHECK|drv_licence_check[last_check]|letzte Führerscheinkontrolle|Datum der letzten Führerscheinkontrolle| |Format: YYYY-MM-DD HH:MM:SS
	69	+|DRV_LICENCE_CHECK_NEXT_CHECK|drv_licence_check[next_check]|nächste Führerscheinkontrolle|Datum der nächsten fälligen Führerscheinkontrolle| |Format YYYY-MM-DD
	70	+|DRV_LICENCE_CHECK_INTERVAL|drv_licence_check[interval]|Kontrollintervall|Kontrollintervall zwischen 2 Abfragen in Sekunden| |
65	65
66	66	== CSV Format ==
	73	+
67	67	Bei einer korrekten Anfrage werden die Personaldaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
68	68	Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Dannach folgen dann die Daten
	76	+
69	69	=== Metainformationen ===
	78	+
70	70	|=Trennzeichen|Semikolon ( ; )
71	71	|=Textbegrenzer|Doppeltes Hochkomma ( " )
72	72	|=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
...	...	@@ -73,6 +73,7 @@
73	73	|=Header|Zeile 1
74	74
75	75	=== Header ===
	85	+
76	76	**Header Informationen**
77	77	{{code language="java"}}"ID";"NAME";"KEY";"VALID_FROM";"VALID_TO";"GROUPS";"CARD_NR";"DRV_LICENCE_NR";"DRV_LICENCE_VALID_TO";"IDENTITY_CARD_NR";"IDENTITY_CARD_VALID_TO";"PASSPORT_NR";"PASSPORT_VALID_TO";"ADR_CERTIFICATE_NR";"ADR_CERTIFICATE_VALID_TO";"BKRFQG_VALID_TO";"BIRTHDATE";"JOB_START_DATE"{{/code}}
78	78
...	...	@@ -81,90 +81,92 @@
81	81	"0012";"Max Mustermann";"DF1234567890";"2018-01-01 06:43:00";"";"Fahrer,Dresden";"";"YFDD9876";"2021-11-10 23:59:59";"";"";"";"2023-04-30 23:59:59";"";"2020-07-31 23:59:59";"2021-11-30 23:59:59";"1990-02-19 00:00:00";"2014-09-01 00:00:00";""4729000A3341";"2020-03-01 10:43:00";"2020-03-15";"1209600"{{/code}}
82	82
83	83	== JSON Format ==
	94	+
84	84	Liefert eine JSON formatierte Liste mit allen verfügbaren Daten zurück. Die Daten selbst werden alle in einer Key - Value - Beziehung zurückgegeben. Einzelne Werte wie die Daten zum Personalschlüssel oder die einzelnen Personalgruppen sind zur besseren Zuordnung jeweils in einem Unterobjekt zusammengefasst.
85	85	**Beispiel**
86	86	{{code language="js"}}[
87		- {
88		- "id":"0013",
89		- "name":"Marion Musterfrau",
90		- "key":{
91		- "id":"DF9876543210",
92		- "valid_from":"2016-01-01 00:00:00",
93		- "valid_to":null
94		- },
95		- "card_nr":null,
96		- "groups":[
97		- "Fahrer",
98		- "Berlin"
99		- ],
100		- "deleted":null,
101		- "drv_licence":{
102		- "id":"asd09472845",
103		- "valid_to":"2017-02-24 23:59:59"
104		- },
105		- "identity_card":{
106		- "id":"hal2001",
107		- "valid_to":"2017-01-11 23:59:59"
108		- },
109		- "passport":{
110		- "id":null,
111		- "valid_to":null
112		- },
113		- "adr_certificate":{
114		- "id":null,
115		- "valid_to":"2019-05-23 23:59:59"
116		- },
117		- "bkfqg":{
118		- "valid_to":null
119		- },
120		- "birthdate":"1998-05-13 00:00:00",
121		- "job_start_date":"2016-09-01 00:00:00"
122		- },
123		- {
124		- "id":"0014",
125		- "name":"Patrick Berger",
126		- "key":{
127		- "id":"00047392",
128		- "valid_from":"2017-07-05 13:20:00",
129		- "valid_to":null
130		- },
131		- "card_nr":"7937102",
132		- "groups":[
133		- "B\u00fcro",
134		- "Berlin"
135		- ],
136		- "deleted":null,
137		- "drv_licence":{
138		- "id":jvg7820185",
139		- "valid_to":"2014-07-18 23:59:59"
140		- },
141		- "identity_card":{
142		- "id":"ppa4711",
143		- "valid_to":"2014-07-19 23:59:59"
144		- },
145		- "passport":{
146		- "id":null,
147		- "valid_to":null
148		- },
149		- "adr_certificate":{
150		- "id":null,
151		- "valid_to":null
152		- },
153		- "bkfqg":{
154		- "valid_to":"2019-07-18 25:59:59"
155		- },
156		- "birthdate":"1996-07-17 00:00:00",
157		- "job_start_date":"2014-07-17 00:00:00",
158		- "drv_licence_check": {
	98	+ {
	99	+ "id":"0013",
	100	+ "name":"Marion Musterfrau",
	101	+ "key":{
	102	+ "id":"DF9876543210",
	103	+ "valid_from":"2016-01-01 00:00:00",
	104	+ "valid_to":null
	105	+ },
	106	+ "card_nr":null,
	107	+ "groups":[
	108	+ "Fahrer",
	109	+ "Berlin"
	110	+ ],
	111	+ "deleted":null,
	112	+ "drv_licence":{
	113	+ "id":"asd09472845",
	114	+ "valid_to":"2017-02-24 23:59:59"
	115	+ },
	116	+ "identity_card":{
	117	+ "id":"hal2001",
	118	+ "valid_to":"2017-01-11 23:59:59"
	119	+ },
	120	+ "passport":{
	121	+ "id":null,
	122	+ "valid_to":null
	123	+ },
	124	+ "adr_certificate":{
	125	+ "id":null,
	126	+ "valid_to":"2019-05-23 23:59:59"
	127	+ },
	128	+ "bkfqg":{
	129	+ "valid_to":null
	130	+ },
	131	+ "birthdate":"1998-05-13 00:00:00",
	132	+ "job_start_date":"2016-09-01 00:00:00"
	133	+ },
	134	+ {
	135	+ "id":"0014",
	136	+ "name":"Patrick Berger",
	137	+ "key":{
	138	+ "id":"00047392",
	139	+ "valid_from":"2017-07-05 13:20:00",
	140	+ "valid_to":null
	141	+ },
	142	+ "card_nr":"7937102",
	143	+ "groups":[
	144	+ "B\u00fcro",
	145	+ "Berlin"
	146	+ ],
	147	+ "deleted":null,
	148	+ "drv_licence":{
	149	+ "id":jvg7820185",
	150	+ "valid_to":"2014-07-18 23:59:59"
	151	+ },
	152	+ "identity_card":{
	153	+ "id":"ppa4711",
	154	+ "valid_to":"2014-07-19 23:59:59"
	155	+ },
	156	+ "passport":{
	157	+ "id":null,
	158	+ "valid_to":null
	159	+ },
	160	+ "adr_certificate":{
	161	+ "id":null,
	162	+ "valid_to":null
	163	+ },
	164	+ "bkfqg":{
	165	+ "valid_to":"2019-07-18 25:59:59"
	166	+ },
	167	+ "birthdate":"1996-07-17 00:00:00",
	168	+ "job_start_date":"2014-07-17 00:00:00",
	169	+ "drv_licence_check": {
159	159	"tag_id": "4729000A3341",
160	160	"last_check": "2020-03-01 10:43:00",
161	161	"next_check": "2019-03-15",
162	162	"interval": 1209600
163	163	}
164		- }
	175	+ }
165	165	]{{/code}}
166	166
167	167	= XML Format =
	179	+
168	168	Liefert einen XML formatierten String zurück. Unter dem Hauptschlüssel "<persons>" ist jede einzelne Person als "<person>" Objekt erfasst. Einzelne Werte wie die Daten zum Personalschlüssel oder die einzelnen Personalgruppen sind zur besseren Zuordnung jeweils in einem Unterobjekt zusammengefasst.
169	169	**Beispiel**
170	170	{{code language="xml"}}<?xml version="1.0"?>
...	...	@@ -182,7 +182,7 @@
182	182	<group>Fahrer</group>
183	183	<group>Dresden</group>
184	184	</groups>
185		- <deleted/>
	197	+ <deleted/>
186	186	<drv_licence>
187	187	<id>asd09472845</id>
188	188	<valid_to>2020-04-23 23:59:59</valid_to>
...	...	@@ -218,7 +218,7 @@
218	218	<group>Fahrer</group>
219	219	<group>Berlin</group>
220	220	</groups>
221		- <deleted/>
	233	+ <deleted/>
222	222	<drv_licence>
223	223	<id>asd09472845</id>
224	224	<valid_to>2020-04-23 23:59:59</valid_to>
...	...	@@ -240,7 +240,7 @@
240	240	</bkfqg>
241	241	<birthdate/>
242	242	<job_start_date>2012-05-01 00:00:00</job_start_date>
243		- <drv_licence_check>
	255	+ <drv_licence_check>
244	244	<tag_id>4729000A3341</tag_id>
245	245	<last_check>2020-03-01 10:43:00</last_check>
246	246	<next_check>2020-03-15</next_check>
...	...	@@ -250,12 +250,13 @@
250	250	</persons>{{/code}}
251	251
252	252	== Beispiele ==
	265	+
253	253	**Abfrage aller Personen im CSV Format**
254		-{{code language="xml"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
	267	+{{code language="js"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
255	255
256	256	**Abfrage aller Personen der Gruppe "Fahrer" mit allen Schlüsseln**
257		-{{code language="xml"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=xml&group=Fahrer&history=1{{/code}}
	270	+{{code language="js"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=xml&group=Fahrer&history=1{{/code}}
258	258
259	259	**Abfrage der Daten einer Person mit einer bestimmten ID**
260		-{{code language="xml"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1{{/code}}
	273	+{{code language="js"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1{{/code}}
261	261