- Created by YellowFox R&D, last modified on Feb 08, 2018
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 14 Next »
You have English selected as language but this page has not been translated yet. Translate the page or view the content in the default space language below.
Display defaultAbfrage der aktuell engelegten Personen der der Personalverwaltung
Beschreibung
get_persons_v2.php?company=RTI_COMPANYKEY&import=RTI_VEHICLEKEY&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:
Standard: csv
| nein |
history | Ausgabe aller Personalschlüssel einer Person oder nur des aktuellsten | int |
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 |
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.
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" "0012";"Max Mustermann";"DF1234567890";"2018-01-01 06:43:00";"";"Fahrer,Dresden";""
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":[{"group":"Fahrer"},{"group":"Berlin"}]},{"id":"0014","name":"Patrick Berger","key":{"id":"00047392","valid_from":"2017-07-05 13:20:00","valid_to":null},"card_nr":"7937102","groups":[{"group":"B\u00fcro"},{"group":"Berlin"}]}]
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> </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> </person> </persons>
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 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 |
Beispiele
map.yellowfox.de/rti/get_persons_v2.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv
map.yellowfox.de/rti/get_persons_v2.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=xml&group=Fahrer&history=1
map.yellowfox.de/rti/get_persons_v2.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1
- No labels