Wiki-Quellcode von timerecording/set_costcenter.php
Version 1.1 von YellowFox_RD am 2024/12/19 10:11
Zeige letzte Bearbeiter
author | version | line-number | content |
---|---|---|---|
1 | (% class="box" %) | ||
2 | (((Inhaltsverzeichnis))) | ||
3 | {{toc/}} | ||
4 | |||
5 | (% class="box" %) | ||
6 | ((( | ||
7 | **Kompatibilität | ||
8 | **Diese Funktion ist nur für Kunden mit aktivierter Zeiterfassung V3 verfügbar. | ||
9 | ))) | ||
10 | |||
11 | Erlaubt das anlegen, bearbeiten und löschen von Kostenstellen. | ||
12 | = Beschreibung = | ||
13 | **(% class="blue mark" %)POST(%%)**** **//**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//// | ||
14 | = //Parameter// = | ||
15 | // | ||
16 | // | ||
17 | |||
18 | |=Parameter|=Beschreibung|=Typ|=Hinweis|=Pflicht | ||
19 | |company|RTI Firmenschlüssel|string||ja | ||
20 | |import|RTI Importschlüssel|string||ja | ||
21 | |action|Unterscheidung der verschiedenen Aktionen|string|zulässige Modi sind: | ||
22 | ((( | ||
23 | * new: eine neue Kostenstelle anlegen | ||
24 | * update: Daten einer angelegten Kostenstelle ändern | ||
25 | * delete: eine angelegte Kostenstelle löschen | ||
26 | )))|ja | ||
27 | |ident|Kennung der Kostenstellen|string|Eindeutige Kennung der Kostenstelle. | ||
28 | Nur mit dieser Kennung ist später möglich eine Kostenstelle wieder zu bearbeiten oder zu löschen.|ja | ||
29 | |name|Name der Kostenstelle|string||ja(1) | ||
30 | |valid_from|Beginn der Gültigkeit der Kostenstelle|string|YYYYmmddHHiiss|ja(1) | ||
31 | |valid_to|Ende der Gültigkeit der Kostenstelle|string|YYYYmmddHHiiss|nein | ||
32 | |planned_duration|Geplante Dauer der Kostenstelle|integer|in Minuten|nein | ||
33 | |defined_activities|Festgelegte Tätigkeiten der Kostenstellen|array|Ein Array von Objekten die die Kennung (string) und eine optionale Planungsdauer in Minuten (integer oder string) pro Tätigkeit enthalten. | ||
34 | Die Kennung der Tätigkeiten muss eindeutig sein und bereits im System hinterlegt sein. | ||
35 | Beispiel: | ||
36 | |||
37 | {{code language="js"}}[ | ||
38 | { | ||
39 | "ident": "A100", | ||
40 | "duration": 2000 | ||
41 | }, | ||
42 | { | ||
43 | "ident": "A200", | ||
44 | "duration": null | ||
45 | }, | ||
46 | { | ||
47 | "ident": "A300" | ||
48 | } | ||
49 | ]{{/code}}|nein | ||
50 | |allow_other_activities|Diese Option legt fest ob neben den übergebenen Tätigkeiten "defined_activities" auch andere Tätigkeiten für die Buchung erlaubt sind.|integer|Mögliche Werte: 0 oder 1 | ||
51 | Standard: 0|nein | ||
52 | |defined_persons|Festgelegte Personen der Kostenstelle|array|Ein Array von Mitarbeiternummern(string). | ||
53 | Werden Personen für eine Kostenstelle festgelegt, so ist es nur noch diesen Personen möglich auf diese Kostenstelle zu buchen. | ||
54 | Die Mitarbeiternummer wird über die Personalverwaltung für jede Person separat festgelegt. | ||
55 | Beispiel: | ||
56 | |||
57 | {{code language="js"}}[ "M1000", "M1001", "M1002" ]{{/code}}|nein | ||
58 | |||
59 | Hinweise: | ||
60 | (1) Pflichtfeld beim Anlegen einer Kostenstelle | ||
61 | |||
62 | Werden Felder beim Bearbeiten von Kostenstellen nicht übermittelt, so werden diese nicht verändert. | ||
63 | |||
64 | = Rückgabe = | ||
65 | Beim Anlegen und Bearbeiten wird im Erfolgsfall "**COSTCENTER_DATA_SAVED**" zurückgegeben. | ||
66 | Beim Löschen einer Kostenstellen wird im Erfolgsfall "**COSTCENTER****_DELETED**" zurückgegeben. | ||
67 | Bei fehlenden oder fehlerhaften Eingaben wird ein "(% class="error" %)**ERROR:Beschreibung**(%%)" zurückgegeben. | ||
68 | = Beispiele = | ||
69 | **Anlegen einer Kostenstellen mit allen Feldern** | ||
70 | {{code language="java"}}https://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}} | ||
71 | |||
72 | **Bearbeiten des Namens einer Kostenstellen** | ||
73 | {{code language="java"}}https://map.yellowfox.de/rti/timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&ident=B1234&action=update&name=Büro{{/code}} | ||
74 | |||
75 | **Löschen einer Kostenstellen** | ||
76 | {{code language="java"}}https://map.yellowfox.de/rti/timerecording/set_costcenter.php?company=COMPANY_RTIKEY&import=COMPANY_IMPORTKEY&ident=B1234&action=delete{{/code}} | ||
77 |