You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 21 Next »

Getting data for personnel set in personnel administration

Description

get_personnel.php?company=RTI_COMPANYKEY&import=RTI_VEHICLEKEY&format=csv

Parameters

parameterdescriptiontypehintmandatory
companyRTI company keystring 

yes

importRTI import keystring yes
formatAusgabeformat der Listestring

unterstützte Formate sind:

  • csv - Ausgabe im CSV Format
  • json - Ausgabe im JSON Format
  • xml - Ausgabe im XML Format

Standard: csv

 

nein
historyAusgabe aller Personalschlüssel einer Person oder nur des aktuellstenint
  • 0 - nur den aktuellen Schlüssel ausgeben
  • 1 - alle Personalschlüssel ausgeben
    • Ein Eintrag pro Schlüssel

Standard: 0

nein
idEingrenzung der Ausgabe auf die angegebene Personal-IDstringsiehe strict Parameternein
nameEingrenzung der Ausgabe auf Personen mit dem angegebenen Namenstringsiehe strict Parameternein
pkeyEingrenzung der Ausgabe auf den angegebenen Personalschlüsselstringsiehe strict Parameternein
groupEingrenzung der Ausgabe auf Personen mit der angegebenen Gruppestringsiehe strict Parameternein
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/XMLBezeichnung Personalverwaltung
Beschreibung
Hinweis
 
IDidMA-Nummerselbstdefinierte eindeutige Mitarbeiternummer  
NAMEnameNamevollständiger Name der Person  
KEYkey[id]PersonalschlüsselPersonalschlüssel (für Buchungen über YellowFox)  
VALID_FROMkey[valid_from]Personalschlüssel gültig abGültigkeitsbeginn des Personalschlüssels Format: YYYY-MM-DD HH:MM:SS
VALID_TOkey[valid_to]Personalschlüssel gültig bisGültigkeitsende des Personalschlüssels Format: YYYY-MM-DD HH:MM:SS
GROUPSgroups[group]PersonalgruppenKomma getrennte Liste mit den Bezeichnungen der zugewiesenen Personalgruppen  
CARD_NRcard_nrAusweisnummerEntspricht der optioPASSnale zuweisbaren Ausweisnummer, welche zur Erfassung von Buchungen mittels ReinerSCT genutzt wird  
DRV_LICENCE_NRdrv_licence[id]FührerscheinFührerscheinnummer der PersonDaten nur bei gebuchtem Tacho Archiv 
DRV_LICENCE_VALID_TOdrv_licence[valid_to]Führerschein gültig bisAblaufdatum des FührerscheinsDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
IDENTITY_CARD_NRidentity_card[id]PersonalausweisPersonalausweisnummerDaten nur bei gebuchtem Tacho Archiv 
IDENTITY_CARD_VALID_TOidentity_card[valid_to]Personalausweis gültig bisAblaufdatum des PersonalausweisesDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
PASSPORT_NRpassport[id]ReisepassReisepass NummerDaten nur bei gebuchtem Tacho Archiv 
PASSPORT_VALID_TOpassport[valid_to]Reisepass gültig bisAblaufdatum des ReisepassesDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
ADR_CERTIFICATE_NRadr_certificate[id]ADR BescheinigungNummer der ADR BescheinigungDaten nur bei gebuchtem Tacho Archiv 
ADR_CERTICATE_VALID_TOadr_certificate[valid_to]ADR Bescheinigung gültig bisAblaufdatum der ADR BescheinigungDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
BKRFQG_VALID_TObkrfqg[valid_to]Qualifikation laut Schlüsselzahl 95 gültig bisGültigkeit der Schulung zum BerufskraftfahrerqualifikationsgesetzDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
BIRTHDATEbirthdateGeburtsdatumGeburtsdatum der PersonDaten nur bei gebuchtem Tacho ArchivFormat: YYYY-MM-DD HH:MM:SS
JOB_START_DATEjob_start_dateEinstellungsdatumEinstellungsdatum der PersonDaten nur bei gebuchtem Tacho ArchivFormat: 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

TrennzeichenSemikolon ( ; )
TextbegrenzerDoppeltes Hochkomma ( " )
Zeilenende0x0D 0x0A (CarriageReturn LineFeed)
HeaderZeile 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

Abfrage aller Personen im CSV Format
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
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
map.yellowfox.de/rti/get_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&format=json&history=1&id=1234&strict=1
  • No labels