Getting data for personnel set in personnel administration Description getget_personnel.php?company=RTI_COMPANYKEY&import=RTI_VEHICLEKEY&format=csv Parametersparameter | description | type | hint | mandatory |
---|
company | RTI company key | string | | yes | import | RTI import key | string | | yes | 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ückgabeEs wird eine Zeichenkette zurück gegebenBei einem Fehler wird der "403 - Verboten: Zugriff verweigert." HTTP-Header gesendet. SpaltenParameter | Description | Type | Note | Mandatory |
---|
company | RTI company key | string |
| yes | import | RTI import key | string |
| yes | format | export format for list | string | supported output formats: - csv - export as csv formatted file
- json - export as json
- xml - export as xml
default: csv
| no | history | show only latest personnel key for each person or all keys for each person | int | - 0 - return only latest key
- 1 - return all keys
- will return one entry per key
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 | - 0 - return all results containing the searched string
- 1 - return only results matching exactly the searched string
default: 1 this setting modifies the behaviour for parameters: id, name, pkey, group | no |
ReturnReturning a string in selected format. On error returning "403 - Verboten: Zugriff verweigert." as HTTP-Header. Column | JSON/XML key name | Name in personnel administration | | Note | |
---|
ID | id | employee number | self defined employee number |
|
| NAME | name | Name | complete name of the person |
|
| KEY | key[id] | personnel key | personnel key (for bookings via YellowFox) |
|
| VALID_FROM | key[valid_from] | personnel key valid from | validity start for the personnel key |
| format: YYYY-MM-DD HH:MM:SS | VALID_TO | key[valid_to] | personnel key valid to | validity end for the personnel key |
| format: YYYY-MM-DD HH:MM:SS | GROUPS | groups[group] | personnel groups | comma separated list with all personnel groups assigned to the person |
|
| CARD_NR | card_nr | employee licence number | optional licence number to assign bookings to ReinerSCT |
|
| DRV_LICENCE_NR | drv_licence[id] | driver licence | driver licence number | only filled, if tacho archive active |
| DRV_LICENCE_VALID_TO | drv_licence[valid_to] | driver licence valid to | expiration date of driver licence | only filled, if tacho archive active | format |
| Spalte JSON/XML | Bezeichnung Personalverwaltung | | 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 | IDENTITY_CARD_NR | identity_card[id] | identity card | identity card number | only filled, if tacho archive active |
| IDENTITY_CARD_VALID_TO | keyPersonalschlüssel gültig bis | Gültigkeitsende des Personalschlüssels | | identity card valid to | expiration date of identity card | only filled, if tacho archive active | format | FormatGROUPSgroupsgroupPersonalgruppen | 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 | passport | passport number | only filled, if tacho archive active |
| PASSPORT_VALID_TO | passport[valid_to] | passport valid to | expiration date of passort | only filled, if tacho archive active | format: YYYY-MM-DD HH:MM:SS | ADR_CERTIFICATE_NR | adr_certificate[id] | ADR certificate | number of ADR certificate (carriage of dangerous goods by road) | only filled, if tacho archive active |
| ADR_CERTICATE_VALID_TO | adr_certificate[valid_to] | ADR cetificate valid to | expiration date of ADR certificate | only filled, if tacho archive active | format | FormatIDENTITY_CARD_IDENTITY_CARD_NR | identity_card[id] | Personalausweis | Personalausweisnummer | Daten nur bei gebuchtem Tacho Archiv | | identity_cardPersonalausweis gültig bis | Ablaufdatum des Personalausweises | Daten nur bei gebuchtem Tacho Archiv | qualification by keynumber 95 valid to | expiration date of german "Berufskraftfahrerqualifikationsgesetz" | only filled, if tacho archive active | format | FormatPASSPORT_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 | BIRTHDATE | birthdate | date of birth | date of birth of person | only filled, if tacho archive active If day and/or month are unknown, the birthdate is filled up with "XX" for the unknown values according to german passport law
(example: 1980-06-XX or 1980-XX-XX) | format | FormatADRCERTIFICATENRadr_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 | job_start_date | employee since | start date of beeing an employee at this company | only filled, if tacho archive active | format | FormatBKRFQG_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 | DRV_LICENCE_CHECK_TAG_ID | drv_licence_check[tag_id] | NFC tag id | id of nfc tag for driver licence check |
|
| DRV_LICENCE_CHECK_LAST_CHECK | drv_licence_check[last_check] | last [driver licence] check | date of latest driver licence check |
| format | FormatBIRTHDATE | birthdate | Geburtsdatum | Geburtsdatum der Person | Daten nur bei gebuchtem Tacho Archiv | DRV_LICENCE_CHECK_NEXT_CHECK | drv_licence_check[next_check] | next [driver licence] check | date of next driver licence check |
| format | Format: HH:MM:SSJOB_START_DATE | job_start_date | Einstellungsdatum | Einstellungsdatum der Person | Daten nur bei gebuchtem Tacho Archiv | Format: YYYY-MM-DD HH:MM:SS | 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 | DRV_LICENCE_CHECK_INTERVAL | drv_licence_check[interval] | [driver licence] check interval | timerange between 2 driver licence checks in seconds |
|
|
Sending a correct request will return a csv formatted file with a headline as first line containing column names. The data itself will be returned in following rows. Separator | semicolon ( ; ) |
---|
text limiter | double quote ( " ) |
---|
line brak |
---|
Trennzeichen | Semikolon ( ; ) |
---|
Textbegrenzer | Doppeltes Hochkomma ( " ) | Zeilenende | 0x0D 0x0A (CarriageReturn LineFeed) |
---|
HeaderZeile Header Informationen Code Block |
---|
title | 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
Code Block |
---|
| "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" |
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 zusammengefasstRetrun a json formatted string with all the available data matching the request parameters. The entries will be returned as key - value relation. Some data such as personnel key or personnel groups are grouped in a sub object. Beispiel Code Block |
---|
| [
{
"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":":null2019-07-18 25:59:59"
},
"birthdate"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":"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
}
}
] |
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 zusammengefasstReturn an xml formatted string with main key "<persons>" and data for each single person then grouped in a "<person>" object. Some data such as personnel key or personnel groups are grouped in a sub object. Beispiel Code Block |
---|
| <?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>yfdd01723<<id/id>>
<valid_to>2023to>2018-09-1730 23:59:59</valid_to>
</passport>adr_certificate>
<adr_certificate><bkfqg>
<id<valid_to/>
</bkfqg>
<birthdate/>
<valid_to>2018-09-30 23:59:59</valid_to>
<job_start_date>2012-05-01 00:00:00</job_start_date>
<drv_licence_check>
<tag_id>4729000A3341</tag_id>
</adr_certificate>
<bkfqg><last_check>2020-03-01 10:43:00</last_check>
<valid_to/><next_check>2020-03-15</next_check>
</bkfqg>
<birthdate/><interval>1209600</interval>
<job_start_date>2012-05-01 00:00:00</job_start_date></drv_licence_check>
</person>
</persons> |
ExamplesBeispiele Code Block |
---|
language | xml |
---|
title | Abfrage aller Personen im CSV Format |
---|
| https://map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=csv |
Code Block |
---|
language | xml |
---|
title | 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 |
Code Block |
---|
language | xml |
---|
title | 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 |
|