Versions Compared

Old Version 9

changes.mady.by.user YellowFox R&D

Saved on

compared with

New Version Current

changes.mady.by.user YellowFox R&D

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Sv translation
languagede


Info
titleKompatibilität

Diese Funktion ist nur für Kunden mit aktivierter Zeiterfassung V3 verfügbar.


Erlaubt das anlegen, bearbeiten und löschen von Kostenstellen.

Beschreibung

Status
colourBlue
titlePOST
 timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&action=ACTION_TYPE&name=COSTCENTER_IDENT&name=COSTCENTER_NAME&valid_from=COSTCENTER_VALIDFROM_DATETIME&valid_to=COSTCENTER_VALIDTO_DATETIME&planned_duration=COSTCENTER_DURATION&defined_activities=COSTCENTER_ACTIVITIES&allow_other_activities=COSTCENTER_OTHER_ACTIVITIES_OPTION&defined_persons=COSTCENTER_PERSONS

Parameter



ParameterBeschreibungTypHinweisPflicht
companyRTI Firmenschlüsselstring
ja
importRTI Importschlüsselstring

ja

actionUnterscheidung der verschiedenen Aktionenstring

zulässige Modi sind:

  • new: eine neue Kostenstelle anlegen
  • update: Daten einer angelegten Kostenstelle ändern
  • delete: eine angelegte Kostenstelle löschen


ja

identKennung der KostenstellenstringEindeutige Kennung der Kostenstelle.
Nur mit dieser Kennung ist später möglich eine Kostenstelle wieder zu bearbeiten oder zu löschen.		ja
nameName der Kostenstellestring
ja(1)
valid_fromBeginn der Gültigkeit der KostenstellestringYYYYmmddHHiissja(1)
valid_toEnde der Gültigkeit der Kostenstelle stringYYYYmmddHHiissnein
planned_durationGeplante Dauer der Kostenstelleintegerin Minutennein
defined_activitiesFestgelegte Tätigkeiten der Kostenstellenarray

Ein Array von Objekten die die Kennung (string) und eine optionale Planungsdauer in Minuten (integer oder string) pro Tätigkeit enthalten.
Die Kennung der Tätigkeiten muss eindeutig sein und bereits im System hinterlegt sein.
Beispiel:

Code Block
languagejs
[
	{
		"ident": '"A100'",
		"duration": 2000
	},
	{
		"ident": '"A200'",
		"duration": null
	},
	{
		"ident": '"A300'"
	}
]


nein
allow_other_activitiesDiese Option legt fest ob neben den übergebenen Tätigkeiten "defined_activities" auch andere Tätigkeiten für die Buchung erlaubt sind.integerMögliche Werte: 0 oder 1
Standard: 0		nein
defined_personsFestgelegte Personen der Kostenstellearray

Ein Array von Mitarbeiternummern(string).
Werden Personen für eine Kostenstelle festgelegt, so ist es nur noch diesen Personen möglich auf diese Kostenstelle zu buchen.
Die Mitarbeiternummer werden wird über die Personalverwaltung für jede Person separat festgelegt.

Beispiel:

Code Block
languagejs
[ '"M1000'", '"M1001'", '"M1002'" ]


nein

Hinweise:

(1) Pflichtfeld beim Anlegen einer Kostenstelle

Werden Felder beim Bearbeiten von Kostenstellen nicht übermittelt, so werden diese nicht verändert.


Rückgabe

Beim Anlegen und Bearbeiten wird im Erfolgsfall "COSTCENTER_DATA_SAVED" zurückgegeben.

Beim Löschen einer Kostenstellen wird im Erfolgsfall "COSTCENTER_DELETED" zurückgegeben.

Bei fehlenden oder fehlerhaften Eingaben wird ein "ERROR:Beschreibung" zurückgegeben.

Beispiele

Code Block
titleAnlegen einer Kostenstellen mit allen Feldern
httphttps://map.yellowfox.de/rti/timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&action=new&ident=B1234&name=Baustelle&valid_from=20210101000000&valid_to=20211231235959&planned_duration=10000&defined_activities=[{"ident":'"A100'","duration":5000},{"ident":'"A200'",duration:5000}]&allow_other_activities=0&defined_persons=['"M1000'",'"M1001'"]


Code Block
titleBearbeiten des Namens einer Kostenstellen
httphttps://map.yellowfox.de/rti/timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&ident=B1234&action=update&name=Büro


Code Block
titleLöschen einer Kostenstellen
httphttps://map.yellowfox.de/rti/timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&ident=B1234&action=delete


Sv translation
languageen


Info
titleCompatibility

This function is only available for customers with activated time recording V3.


Allows you Provide functions to create, edit and delete personnel specific datacost centers.

Description

Status
colourBlue
titlePOST
 timerecording/set_

personnel

costcenter.php?company=

RTI

COMPANY_

COMPANYKEY

RTIKEY&import=

RTI_VEHICLEKEY&mode=new&id=01234&key_from=YYYYMMDDHHMMSS&pkey=DF123456789012&name=Max%20Mustermann&groups=Fahrer,Dresden

COMPANY_IMPORTKEY&action=ACTION_TYPE&name=COSTCENTER_IDENT&name=COSTCENTER_NAME&valid_from=COSTCENTER_VALIDFROM_DATETIME&valid_to=COSTCENTER_VALIDTO_DATETIME&planned_duration=COSTCENTER_DURATION&defined_activities=COSTCENTER_ACTIVITIES&allow_other_activities=COSTCENTER_OTHER_ACTIVITIES_OPTION&defined_persons=COSTCENTER_PERSONS

Parameters


Parameters

parametername in personnel administrationdesciptiontyperemarkmandatory
ParameterDescriptionTypeNoteMandatory
companyRTI company keystring
yes
importRTI import keystring

yes

mode
actionPossible request modes
differentiate between available actions
string
valid

permissible modes are:

  • new: create a new
person
  • cost center
  • update:
change data of an already available person
  • edit an existing cost center
  • delete:
remove
  • delete a
person
  • append_key: add a foreign personnel key to a person
    • cost center


    yes

    identIdentifier of the cost centerstringUnique identifier of the cost center.
    Only with this ID is it possible to edit or delete a cost center later.

    yes

    idemployee numberself defined employee numberstringthe employee number must be a self defined string for further identification of the person
    yes
    nameName
    complete name
    of the
    person
    cost centerstring
    		yes(1)
    pkeypersonnel keypersonnel key for bookingsstring
    valid_fromStart of the cost center's validitystringYYYYmmddHHiiss
    this may be a transponder or driver card to identify the person and assign booked times correctly
    yes(1
    ,2
    )
    key
    valid_
    from
    toEnd of the cost center's validity
    personnel key valid from
    string
    format: YYYYMMDDHHMMSS
    YYYYmmddHHiiss
    if
    no
    value set, the current timestamp will be usednokey_topersonnel key valid tostring

    format: YYYYMMDDHHMMSS

    nogroupspersonnel groupsnames of personnel groups to assignstring

    names of assigned personnel groups

    • set multiple groups by submit as comma separated string
    • on edit a person, we set only the selected groups (previous assignments will be removed)
    nocard_nremployee licence numberself defined number for assignment to an external timerecording softwarestringrequired especially for correct assignment to ReinerSCT time card softwarenodrv_licence_nrdriver licencenumber of driver licencestringno(3)
    planned_durationPlanned duration of the cost centerintegerin minutesno
    defined_activitiesDefined activities of the cost centerarray

    An array of objects containing the identifier and an optional planning time in minutes per activity.
    The identification of the activities must be unique and already stored in the system.
    Example:

    Code Block
    languagejs
    [
	{
		"ident": "A100",
		"duration": 2000
	},
	{
		"ident": "A200",
		"duration": null
	},
	{
		"ident": "A300"
	}
]


    		no
    allow_other_activitiesThis option determines whether other activities are allowed for the booking in addition to the "defined_activities".integerPossible values: 0 or 1
    default: 0    		no
    defined_personsDefined persons of the cost centerarray

    An array of employee numbers (string).
    If persons are specified for a cost center, it is only possible for these persons to create a time booking to this cost center.
    The employee number is determined separately for each person via the personnel administration.

    Code Block
    languagejs
    [ "M1000", "M1001", "M1002" ]


    		no

    Hints:

    (1) Mandatory field when creating a cost center

    If fields are not transmitted when editing cost centers, they will not be changed.


    Return

    When creating and editing, "COSTCENTER_DATA_SAVED" is returned if successful.

    When deleting a cost center, "COSTCENTER_DELETED" is returned if successful..

    If entries are missing or incorrect, an "ERROR:description" is returned

    drv_licence_valid_todriver licence valid toexpiration date of driver licencestringformat: YYYYMMDDHHMMSSno(3)identity_card_nridentity cardidentity card numberstringno(3)identity_card_valid_toidentity card valid toexpiration date of identity cardstringformat: YYYYMMDDHHMMSSno(3)passport_nrpassportpassport numberstringno(3)passport_valid_topassport valid toexpiration date of passportstringformat: YYYYMMDDHHMMSSno(3)adr_cer_nrADR certificatenumber of adr certificatestringno(3)adr_cert_valid_toADR certificate valid toexpiration date of ADR certificatestringformat: YYYYMMDDHHMMSSno(3)bkrfqg_valid_toqualification by keynumber 95 valid toexpiration date of german "Berufskraftfahrerqualifikationsgesetz"stringthe expiration date of this qualification is printed at driver licence at key number 95no(3)birthdate of birthbirthdate of personstringformat: YYYYMMDDHHMMSS(4)no(3)job_fromemployee sincestart date of beeing an employee at this companystringformat: YYYYMMDDHHMMSSno(3)

    Remarks:

    (1) mandatory on add a new person

    (2) mandatory on add a following card

    (3) will be only stored, if tacho archive extension active

    (4) If day and/or month are unknown, the birthdate is filled up with "XX" for the unknown values according to german passport law (example: 198006XX or 1980XXXX)

    Return

    On succesful create, edit or assignment of a following key the return string will be "PERSON_DATA_SAVED".

    On successful delete of a person the return string will be "PERSON_DELETED".

    In case of an error, return the string "ERROR:Description"

    .

    Examples

    Code Block
    titleCreate
    new personhttp
    a new cost center with all possible fields
    https://map.yellowfox.de/rti/timerecording/set_
    personnel
    costcenter.php?company=COMPANY_RTIKEY&import=
    IMPORT
    COMPANY_
    RTIKEY
    IMPORTKEY&
    mode
    action=new&
    id
    ident=
    1234
    B1234&name=
    Maria%20Musterfrau
    Baustelle&
    pkey
    valid_from=
    98765&group=Aussendienst
    20210101000000&valid_to=20211231235959&planned_duration=10000&defined_activities=[{"ident":"A100","duration":5000},{"ident":"A200","duration":5000}]&allow_other_activities=0&defined_persons=["M1000","M1001"]


    Code Block
    titleEdit the name of a cost center
    https
    Code Block
    titleEdit person data
    http://map.yellowfox.de/rti/set_personnel.php?company=COMPANY_RTIKEY&import=IMPORT_RTIKEY&mode=update&id=1234&name=Maria%20Musterfrau&pkey=98765&group=Aussendienst
    Code Block
    titleAssign a following card
    http
    ://map.yellowfox.de/rti/timerecording/set_
    person
    costcenter.php?company=COMPANY_RTIKEY&import=
    IMPORT
    COMPANY_
    RTIKEY
    IMPORTKEY&
    mode
    ident=
    append_key
    B1234&
    id
    action=
    1234
    update&
    pkey=98766&ekey_from=20180101000000
    name=Büro


    Code Block
    titleDelete a
    person
    cost center
    http
    https://map.yellowfox.de/rti/timerecording/set_
    personnel
    costcenter.php?company=COMPANY_RTIKEY&import=
    IMPORT
    COMPANY_
    RTIKEY
    IMPORTKEY&
    mode
    ident=
    delete
    B1234&
    id
    action=
    1234
    delete