Getting data for personnel set in personnel administration
Description
get_personnel.php?company=RTI_COMPANYKEY&import=RTI_VEHICLEKEY&format=csv
Parameters
parameter | description | type | remark | mandatory |
---|---|---|---|---|
company | RTI company key | string | yes | |
import | RTI import key | string | yes | |
format | export format for list | string | supported output formats:
default: csv
| no |
history | show only latest personnel key for each person or all keys for each person | int |
default: 0 | no |
id | limit exported persons list to given id | string | see strict parameter | no |
name | limit exported persons list to given name | string | see strict parameter | no |
pkey | limit exported persons list to given personnel key | string | see strict parameter | no |
group | limit exported persons list to given personnel group | string | see strict parameter | no |
strict | switch search between finding the exact given value or return all results where the search string is part of the result
| int |
default: 1 this setting modifies the behaviour for parameters: id, name, pkey, group | no |
Return
Returning a string in selected format. On error returning "403 - Verboten: Zugriff verweigert." as HTTP-Header.
Spalten
CSV column name | JSON/XML key name | name in personnel administration | description | remark | |
---|---|---|---|---|---|
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 optioPASSnale 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 | 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 |
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" "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"
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" } ]
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> </person> </persons>
Beispiele
map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv
map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=xml&group=Fahrer&history=1
map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1