get_personnel.php

Zuletzt geändert von YellowFox_RD am 2025/01/23 10:19

Inhaltsverzeichnis

Beschreibung
Parameter
Rückgabe
XML Format
- Beispiele

Abfrage der aktuell angelegten Personen der der Personalverwaltung

Beschreibung

GET get_personnel.php?company=RTI_COMPANYKEY&import=RTI_IMPORTKEY&format=csv

Parameter

Parameter	Beschreibung	Typ	Hinweis	Pflicht
company	RTI Firmenschlüssel	string		ja
import	RTI Importschlüssel	string		ja
format	Ausgabeformat der Liste	string	unterstützte Formate sind: csv - Ausgabe im CSV Format json - Ausgabe im JSON Format xml - Ausgabe im XML Format Standard: csv	nein
history	Ausgabe aller Personalschlüssel einer Person oder nur des aktuellsten	int	0 - nur den aktuellen Schlüssel ausgeben 1 - alle Personalschlüssel ausgeben Ein Eintrag pro Schlüssel Standard: 0	nein
id	Eingrenzung der Ausgabe auf die angegebene Personal-ID	string	siehe strict Parameter	nein
name	Eingrenzung der Ausgabe auf Personen mit dem angegebenen Namen	string	siehe strict Parameter	nein
pkey	Eingrenzung der Ausgabe auf den angegebenen Personalschlüssel	string	siehe strict Parameter	nein
group	Eingrenzung der Ausgabe auf Personen mit der angegebenen Gruppe	string	siehe strict Parameter	nein
strict	Unterscheidung ob genau das Suchwort gefunden werden soll oder alle Ergebnisse, die das Suchwort enthalten	int	0 - liefert alle Ergebnisse, die den gesuchten Begriff enthalten 1 - liefert nur die Ergebnisse, die genau zum gesuchten Wert passen Standard: 1 Betrifft die Parameter: id, name, pkey, group	nein

Rückgabe

Es wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "403 - Verboten: Zugriff verweigert." HTTP-Header gesendet.

Spalten

Spalte CSV	Spalte JSON/XML	Bezeichnung Personalverwaltung	Beschreibung	Hinweis
ID	id	MA-Nummer	selbstdefinierte eindeutige Mitarbeiternummer
NAME	name	Name	vollständiger Name der Person
KEY	key[id]	Personalschlüssel	Personalschlüssel (für Buchungen über YellowFox)
VALID_FROM	key[valid_from]	Personalschlüssel gültig ab	Gültigkeitsbeginn des Personalschlüssels		Format: YYYY-MM-DD HH:MM:SS
VALID_TO	key[valid_to]	Personalschlüssel gültig bis	Gültigkeitsende des Personalschlüssels		Format: YYYY-MM-DD HH:MM:SS
GROUPS	groups[group]	Personalgruppen	Komma getrennte Liste mit den Bezeichnungen der zugewiesenen Personalgruppen
CARD_NR	card_nr	Ausweisnummer	Entspricht der optional zuweisbaren Ausweisnummer, welche zur Erfassung von Buchungen mittels ReinerSCT genutzt wird
DRV_LICENCE_NR	drv_licence[id]	Führerschein	Führerscheinnummer der Person	Daten nur bei gebuchtem Tacho Archiv
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
IDENTITY_CARD_NR	identity_card[id]	Personalausweis	Personalausweisnummer	Daten nur bei gebuchtem Tacho Archiv
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
PASSPORT_NR	passport[id]	Reisepass	Reisepass Nummer	Daten nur bei gebuchtem Tacho Archiv
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
ADR_CERTIFICATE_NR	adr_certificate[id]	ADR Bescheinigung	Nummer der ADR Bescheinigung	Daten nur bei gebuchtem Tacho Archiv
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
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
BIRTHDATE	birthdate	Geburtsdatum	Geburtsdatum der Person	Daten nur bei gebuchtem Tacho Archiv Wenn Tag und/oder Monat unbekannt, wird der Geburtstag mit "XX" für die unbekannten Werte aufgefüllt entsprechend deutschem Ausweisgesetz (Bsp: 1980-06-XX oder 1980-XX-XX)	Format: YYYY-MM-DD HH:MM:SS
JOB_START_DATE	job_start_date	Einstellungsdatum	Einstellungsdatum der Person	Daten nur bei gebuchtem Tacho Archiv	Format: YYYY-MM-DD HH:MM:SS
DRV_LICENCE_CHECK_TAG_ID	drv_licence_check[tag_id]	NFC Tag ID	NFC Tag ID zur Führerscheinkontrolle
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
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
DRV_LICENCE_CHECK_INTERVAL	drv_licence_check[interval]	Kontrollintervall	Kontrollintervall zwischen 2 Abfragen in Sekunden

CSV Format

Bei einer korrekten Anfrage werden die Personaldaten im CSV (Comma Separated Value) Format ausgeliefert wobei die erste
Anwortzeile immer die Kopfzeile ist, die die Feld-/Spalten Namen festlegt. Dannach folgen dann die Daten

Metainformationen

Trennzeichen	Semikolon ( ; )
Textbegrenzer	Doppeltes Hochkomma ( " )
Zeilenende	0x0D 0x0A (CarriageReturn LineFeed)
Header	Zeile 1

Header

Header Informationen

"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"

Beispiel

"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";"DRV_LICENCE_CHECK_TAG_ID";"DRV_LICENCE_CHECK_LAST_CHECK";"DRV_LICENCE_CHECK_NEXT_CHECK";"DRV_LICENCE_CHECK_INTERVAL"
"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"

JSON Format

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.
Beispiel

[
{
"id":"0013",
"name":"Marion Musterfrau",
"key":{
  "id":"DF9876543210",
  "valid_from":"2016-01-01 00:00:00",
  "valid_to":null
  },
"card_nr":null,
"groups":[
  "Fahrer",
  "Berlin"
  ],
"deleted":null,
"drv_licence":{
  "id":"asd09472845",
  "valid_to":"2017-02-24 23:59:59"
  },
"identity_card":{
  "id":"hal2001",
  "valid_to":"2017-01-11 23:59:59"
  },
"passport":{
  "id":null,
  "valid_to":null
  },
"adr_certificate":{
  "id":null,
  "valid_to":"2019-05-23 23:59:59"
  },
"bkfqg":{
  "valid_to":null
  },
"birthdate":"1998-05-13 00:00:00",
"job_start_date":"2016-09-01 00:00:00"
},
{
"id":"0014",
"name":"Patrick Berger",
"key":{
  "id":"00047392",
  "valid_from":"2017-07-05 13:20:00",
  "valid_to":null
  },
"card_nr":"7937102",
"groups":[
  "B\u00fcro",
  "Berlin"
  ],
"deleted":null,
"drv_licence":{
  "id":jvg7820185",
   "valid_to":"2014-07-18 23:59:59"
  },
  "identity_card":{
   "id":"ppa4711",
   "valid_to":"2014-07-19 23:59:59"
  },
  "passport":{
   "id":null,
   "valid_to":null
  },
  "adr_certificate":{
   "id":null,
   "valid_to":null
   },
  "bkfqg":{
   "valid_to":"2019-07-18 25:59:59"
  },
  "birthdate":"1996-07-17 00:00:00",
  "job_start_date":"2014-07-17 00:00:00",
  "drv_licence_check": {
            "tag_id": "4729000A3341",
            "last_check": "2020-03-01 10:43:00",
            "next_check": "2019-03-15",
            "interval": 1209600
        }
}
]

XML Format

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.
Beispiel

<?xml version="1.0"?>
<persons>
   <person>
       <id>0012</id>
       <name>Max Mustermann</name>
       <key>
           <id>DF1234567890</id>
           <valid_from>2018-01-01 06:43:00</valid_from>
           <valid_to/>
       </key>
       <card_nr/>
       <groups>
           <group>Fahrer</group>
           <group>Dresden</group>
       </groups>
<deleted/>
       <drv_licence>
           <id>asd09472845</id>
           <valid_to>2020-04-23 23:59:59</valid_to>
       </drv_licence>
       <identity_card>
           <id/>
           <valid_to/>
       </identity_card>
       <passport>
           <id>yfdd01723</id>
           <valid_to>2023-09-17 23:59:59</valid_to>
       </passport>
       <adr_certificate>
           <id/>
           <valid_to>2018-09-30 23:59:59</valid_to>
       </adr_certificate>
       <bkfqg>
           <valid_to/>
       </bkfqg>
       <birthdate/>
       <job_start_date>2012-05-01 00:00:00</job_start_date>
   </person>
   <person>
       <id>0013</id>
       <name>Marion Musterfrau</name>
       <key>
           <id>DF9876543210</id>
           <valid_from>2016-01-01 00:00:00</valid_from>
           <valid_to>2019-01-01 00:00:00</valid_to>
       </key>
       <card_nr/>
       <groups>
           <group>Fahrer</group>
           <group>Berlin</group>
       </groups>
<deleted/>
       <drv_licence>
           <id>asd09472845</id>
           <valid_to>2020-04-23 23:59:59</valid_to>
       </drv_licence>
       <identity_card>
           <id/>
           <valid_to/>
       </identity_card>
       <passport>
           <id>yfdd01723</id>
           <valid_to>2023-09-17 23:59:59</valid_to>
       </passport>
       <adr_certificate>
           <id/>
           <valid_to>2018-09-30 23:59:59</valid_to>
       </adr_certificate>
       <bkfqg>
           <valid_to/>
       </bkfqg>
       <birthdate/>
       <job_start_date>2012-05-01 00:00:00</job_start_date>
<drv_licence_check>
           <tag_id>4729000A3341</tag_id>
           <last_check>2020-03-01 10:43:00</last_check>
           <next_check>2020-03-15</next_check>
           <interval>1209600</interval>
       </drv_licence_check>
   </person>
</persons>

Beispiele

Abfrage aller Personen im CSV Format

https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv

Abfrage aller Personen der Gruppe "Fahrer" mit allen Schlüsseln

https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=xml&group=Fahrer&history=1

Abfrage der Daten einer Person mit einer bestimmten ID

https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1