API Vacations – TecArt-CRM Developer-Wiki

API Vacations

Aus TecArt-CRM Developer-Wiki

Wechseln zu: Navigation, Suche

Hinweis

API Klassen und deren Funktionen können nur mit CRM System mit Version >= 3.2 genutzt werden

Methods

getVacationDates

Syntax:

array getVacationDates( int $userid, int $year )


Beschreibung:

Gibt ein Array mit Urlaubstagen zurück.

Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.

Wenn userid gegeben ist werden die Urlaubstage dieses Benutzers zurückgegeben ( nur wenn der authentifizierte Benutzer über ausreichende Berechtigungen verfügt). Wenn userid auf 0 gesetzt ist werden die Urlaubstage des authentifizierten Benutzers zurückgegeben.

Wenn year gegeben ist, werden nur Urlaubstage aus diesem Jahr zurückgegeben. Ist year auf 0 gesetzt werden Urlaubstage für das aktuelle Jahr zurückgegeben.


Eigenschaften der zurückgegebenen vacation period array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     $id                       vacation day Id
int                     $start                    Timestamp des Beginns
int                     $stop                     Timestamp des Endes
int                     $createuser               Userid der Erstellung
int                     $createtime               Unix-Timestamp der Erstellung
int                     $chguser                  Userid der letzten Änderung
int                     $chgtime                  Unix-Timestamp der letzten Änderung
int                     $supervisor               Userid des Abteilungsleiters
int                     $supervisor_date          Unix-Timestamp der letzten Abteilungsleiteränderung
int                     $chief                    Userid des Geschäftsführers
int                     $chief_date               Unix-Timestamp der letzten Änderung des Geschäftsführers
int                     $kind                     Art des Sonderurlaubs aus der Liste.
int                     $status                   Status der Urlaubsperiode: 
                                                  0 = angefordert
                                                  1 = genehmigt von Abteilungsleiter
                                                  2 = genehmigt
                                                  3 = Sonderurlaub genehmigt
                                                  4 = abgelehnt
                                                  5 = storniert
                                                  6 = krank
                                                  7 = Wunsch
                                                  8 = stornierter Wunsch
int                     $requested                Unix-Timestamp der Anfrage des Nutzers
string(255)             $notes                    Notizen vom Abteilungsleiter oder Geschäftsführer
string(255)             $usernotes                Notizen des Nutzers

Beispiel:

<?php
 
try {
    $crmapi_vacation = crmapi::vacation();
 
    //Get vacation days of the year 2008 for user with ID 4:
    $result = $crmapi_vacation->getVacationDates(4, 2008);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $vacation) {
    foreach($vacation as $key => $val) {
        echo "$key => $val<br/>\n";
    }
    echo "<hr/>";
}
 
?>