Änderungen von Dokument get_personnel.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:19
Von Version 4.1
bearbeitet von YellowFox_RD
am 2025/01/20 11:21
Änderungskommentar: Replaced user [XWiki.yf-dominic] in fields [author, contentAuthor] to user [XWiki.YellowFox_RD]
Auf Version 1.1
bearbeitet von YellowFox_RD
am 2024/12/19 10:11
Änderungskommentar: Imported from XAR

Zusammenfassung

Details

Seiteneigenschaften
Inhalt
... ... @@ -1,32 +1,28 @@
1 1  (% class="box" %)
2 -(((
3 -Inhaltsverzeichnis
4 -)))
5 -
2 +(((Inhaltsverzeichnis)))
6 6  {{toc/}}
7 7  
8 8  Abfrage der aktuell angelegten Personen der der Personalverwaltung
9 -
10 10  = Beschreibung =
11 -
12 -(% class="green mark" %)//**GET**//(%%)//** get_personnel.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY&**format=**csv//
13 -
7 +//**(% class="green mark" %)GET(%%) get_personnel.php?company**=RTI_COMPANYKEY**&import**=RTI_IMPORTKEY&**format=**csv//
14 14  = Parameter =
15 -
16 16  |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht
17 -|company|RTI Firmenschlüssel|string| |ja
18 -|import|RTI Importschlüssel|string| |ja
19 -|format|Ausgabeformat der Liste|string|unterstützte Formate sind:(((
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 +(((
20 20  * csv - Ausgabe im CSV Format
21 21  * json - Ausgabe im JSON Format
22 22  * xml - Ausgabe im XML Format
23 -)))Standard: csv|nein
17 +)))
18 +Standard: csv|nein
24 24  |history|Ausgabe aller Personalschlüssel einer Person oder nur des aktuellsten|int|(((
25 25  * 0 - nur den aktuellen Schlüssel ausgeben
26 26  * 1 - alle Personalschlüssel ausgeben(((
27 27  * Ein Eintrag pro Schlüssel
28 28  )))
29 -)))Standard: 0|nein
24 +)))
25 +Standard: 0|nein
30 30  |id|Eingrenzung der Ausgabe auf die angegebene Personal-ID|string|siehe //strict// Parameter|nein
31 31  |name|Eingrenzung der Ausgabe auf Personen mit dem angegebenen Namen|string|siehe //strict// Parameter|nein
32 32  |pkey|Eingrenzung der Ausgabe auf den angegebenen Personalschlüssel|string|siehe //strict// Parameter|nein
... ... @@ -34,30 +34,28 @@
34 34  |strict|Unterscheidung ob genau das Suchwort gefunden werden soll oder alle Ergebnisse, die das Suchwort enthalten|int|(((
35 35  * 0 - liefert alle Ergebnisse, die den gesuchten Begriff enthalten
36 36  * 1 - liefert nur die Ergebnisse, die genau zum gesuchten Wert passen
37 -)))Standard: 1
38 -Betrifft die Parameter: id, name, pkey, group|nein
33 +)))
34 +Standard: 1
35 +Betrifft die Parameter:// id, name, pkey, group//|nein
39 39  
40 40  = Rückgabe =
41 -
42 -Es wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "(% class="error" %)**403 - Verboten: Zugriff verweigert.**(%%)" HTTP-Header gesendet.
43 -
38 +Es wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "**(% class="error" %)403 - Verboten: Zugriff verweigert.(%%)**" HTTP-Header gesendet.
44 44  == Spalten ==
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|
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|
55 55  |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
56 -|IDENTITY_CARD_NR|identity_card[id]|Personalausweis|Personalausweisnummer|Daten nur bei gebuchtem Tacho Archiv|
50 +|IDENTITY_CARD_NR|identity_card[id]|Personalausweis|Personalausweisnummer|Daten nur bei gebuchtem Tacho Archiv|
57 57  |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
58 -|PASSPORT_NR|passport[id]|Reisepass|Reisepass Nummer|Daten nur bei gebuchtem Tacho Archiv|
52 +|PASSPORT_NR|passport[id]|Reisepass|Reisepass Nummer|Daten nur bei gebuchtem Tacho Archiv|
59 59  |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
60 -|ADR_CERTIFICATE_NR|adr_certificate[id]|ADR Bescheinigung|Nummer der ADR Bescheinigung|Daten nur bei gebuchtem Tacho Archiv|
54 +|ADR_CERTIFICATE_NR|adr_certificate[id]|ADR Bescheinigung|Nummer der ADR Bescheinigung|Daten nur bei gebuchtem Tacho Archiv|
61 61  |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
62 62  |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
63 63  |BIRTHDATE|birthdate|Geburtsdatum|Geburtsdatum der Person|Daten nur bei gebuchtem Tacho Archiv
... ... @@ -64,18 +64,15 @@
64 64  Wenn Tag und/oder Monat unbekannt, wird der Geburtstag mit "XX" für die unbekannten Werte aufgefüllt entsprechend deutschem Ausweisgesetz
65 65  (Bsp: 1980-06-XX oder 1980-XX-XX)|Format: YYYY-MM-DD HH:MM:SS
66 66  |JOB_START_DATE|job_start_date|Einstellungsdatum|Einstellungsdatum der Person|Daten nur bei gebuchtem Tacho Archiv|Format: YYYY-MM-DD HH:MM:SS
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| |
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||
71 71  
72 72  == CSV Format ==
73 -
74 74  Bei einer korrekten Anfrage werden die Personaldaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
75 75  Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Dannach folgen dann die Daten
76 -
77 77  === Metainformationen ===
78 -
79 79  |=Trennzeichen|Semikolon ( ; )
80 80  |=Textbegrenzer|Doppeltes Hochkomma ( " )
81 81  |=Zeilenende|0x0D 0x0A (CarriageReturn LineFeed)
... ... @@ -82,7 +82,6 @@
82 82  |=Header|Zeile 1
83 83  
84 84  === Header ===
85 -
86 86  **Header Informationen**
87 87  {{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}}
88 88  
... ... @@ -91,92 +91,90 @@
91 91  "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}}
92 92  
93 93  == JSON Format ==
94 -
95 95  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.
96 96  **Beispiel**
97 97  {{code language="js"}}[
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": {
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": {
170 170   "tag_id": "4729000A3341",
171 171   "last_check": "2020-03-01 10:43:00",
172 172   "next_check": "2019-03-15",
173 173   "interval": 1209600
174 174   }
175 - }
164 + }
176 176  ]{{/code}}
177 177  
178 178  = XML Format =
179 -
180 180  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.
181 181  **Beispiel**
182 182  {{code language="xml"}}<?xml version="1.0"?>
... ... @@ -194,7 +194,7 @@
194 194   <group>Fahrer</group>
195 195   <group>Dresden</group>
196 196   </groups>
197 - <deleted/>
185 + <deleted/>
198 198   <drv_licence>
199 199   <id>asd09472845</id>
200 200   <valid_to>2020-04-23 23:59:59</valid_to>
... ... @@ -230,7 +230,7 @@
230 230   <group>Fahrer</group>
231 231   <group>Berlin</group>
232 232   </groups>
233 - <deleted/>
221 + <deleted/>
234 234   <drv_licence>
235 235   <id>asd09472845</id>
236 236   <valid_to>2020-04-23 23:59:59</valid_to>
... ... @@ -252,7 +252,7 @@
252 252   </bkfqg>
253 253   <birthdate/>
254 254   <job_start_date>2012-05-01 00:00:00</job_start_date>
255 - <drv_licence_check>
243 + <drv_licence_check>
256 256   <tag_id>4729000A3341</tag_id>
257 257   <last_check>2020-03-01 10:43:00</last_check>
258 258   <next_check>2020-03-15</next_check>
... ... @@ -262,13 +262,12 @@
262 262  </persons>{{/code}}
263 263  
264 264  == Beispiele ==
265 -
266 266  **Abfrage aller Personen im CSV Format**
267 -{{code language="js"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
254 +{{code language="xml"}}https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv{{/code}}
268 268  
269 269  **Abfrage aller Personen der Gruppe "Fahrer" mit allen Schlüsseln**
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}}
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}}
271 271  
272 272  **Abfrage der Daten einer Person mit einer bestimmten ID**
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}}
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}}
274 274