Page tree
Skip to end of metadata
Go to start of metadata

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

1. Methods

1.1. 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/>";
}



1.2. getVacationIds

(Version >= 3.7)

Syntax:

array getVacationIds( int $userid, int $year )

Beschreibung:

Gibt ein Array mit Ids der Urlaubstagen zurück.

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

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

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

Beispiel:

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



1.3. getVacationById

(Version >= 3.7)

Syntax:

array getVacationById( int $id )

Beschreibung:

Gibt ein Array mit Info eines Urlaubstages anhand der $id zurück.

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

Eigenschaften der zurückgegebenen vacation array:

sind die selben wie getVacationDates

plus

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                      Benutzer Id

Beispiel:

<?php
 
try {
	$crmapi_vacation = crmapi::vacation();
 
	//Get vacation with ID 123:
	$vacation = $crmapi_vacation->getVacationById(123);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($vacation as $key => $val) {
	echo "$key => $val<br>  \n";
}
echo "<hr/>";



1.4. searchVacations

(Version >= 3.7)

Syntax:

array searchVacations(array $search_terms, int $count = 0, int $offset = 0)

Beschreibung:

Gibt ein Array mit Urlaubstage zurück.

$search_terms ist ein assoziatives Array, das die Suchfeld und Suchwert enthält.

$count ist die maximale Anzahl, die zurückgegeben wird. Wenn es auf 0 gesetzt wird, werden alle passende Ergebnisse zurückgegeben

$offset ist die Offset Position der Ergebnisse, die zurückgegeben werden sollen. Wenn es auf 0 gesetzt wird, werden Ergebnisse ab Position 0 zurückgegeben

Eigenschaften des $search_terms Array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     year                         Das Jahr
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                     userid                       Das Benutzer-ID
int                     department                   Das Abteilung-ID

Eigenschaften des zurückgegebenen Array: die gleichen wie für getVacationById

Beispiel:

<?php
 
try {
	$crmapi_offers = crmapi::offers();
 
    // Get the first 10 vacations with userid = 4 AND for the year: 2013
    $search = array( 'userid' => 4, 'year' => 2013 );
 
    $vacations  = $crmapi_vacation->searchVacations($search, 10, 0);
 
    // Get all vacations for department with id = 5
    $search = array( 'department' => 5 );
 
    $vacations  = $crmapi_vacation->searchVacations($search, 0, 0);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach( $vacations as $vacation) {
    foreach( $vacation as $key => $val) {
        echo "$key => $val<br/>\n";
    }
 
    echo '<hr>';
}
  • No labels