Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:vacation [2017/02/07 17:26]
maik [crmsearchVacations]
webservices:soap_webservices:vacation [2020/05/06 14:12] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Vacation ====== ====== Vacation ======
  
- +Bitte besuchen Sie unsere neue Entwickler-Dokumentation unter [[https://docs.tecart.de/display/public/WIKI/Vacation+SOAP]]
- +
-===== WSDL-URI ====== +
- +
- +
-<​code>​http://​hostname/​dirname/​soap/​index.php?​op=vacation&​wsdl</​code>​ +
- +
-z.B. [[https://test.tecart-system.de/soap/index.php?​op=vacation&​wsdl|https:​//test.tecart-system.de/​soap/​index.php?​op=vacation&​wsdl]] +
- +
- +
-===== Methoden ====== +
- +
- +
-==== crmgetVacationDates ===== +
- +
-**Syntax**:​ +
-  array crmgetVacationDates( string $session_id,​ int $userid, int $year ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit vacation day Objekten zurück. +
- +
- +
-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 Objekte//​**:​ +
-   +
-  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**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
-  $client_logon = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$client_vacation = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=vacation&​wsdl"​);​ +
- +
-   //Get vacation days of the year 2008 for user ID 4: +
-   ​$result = $client_vacation->​crmgetVacationDates($session_id,​ 4, 2008); +
- +
-   ​foreach($result as $vacation) { +
- +
-       ​foreach($vacation as $key => $val) { +
-           echo "$key => $val<​br>​\n";​ +
-       } +
- +
-       echo "<​hr/>";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetVacationIds ===== +
- +
- +
-(Version > 3.7) +
- +
-**Syntax**:​ +
-  array crmgetVacationIds( string $session_id,​ int $userid, int $year ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit vacation ID Objekten zurück. +
- +
- +
-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. +
- +
- +
-**Eigenschaften der zurückgegebenen ****//​vacation id Objekte//​**:​ +
-   +
-  Type(Length) ​           Eigenschaft ​              ​Beschreibung +
-  --------------------------------------------------------------------------------------------- +
-  int                     ​$id ​                      Vacation ​Id +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
- +
-   //Get vacation IDs of the year 2008 for user ID 4: +
-   ​$result = $client_vacation->​crmgetVacationIds($session_id,​ 4, 2008); +
- +
-   ​foreach($result as $vacation) { +
- +
-       echo "ID: ". $vacation->​id. "<​br>​\n";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetVacationById ===== +
- +
- +
-(Version > 3.7) +
- +
-**Syntax**:​ +
-  array crmgetVacationById( string $session_id,​ int $id ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit vacation Objekt zurück. +
- +
- +
-**Eigenschaften der zurückgegebenen ****//​vacation Objekt//​**:​ +
- +
-sind die selben wie **[[#​crmgetVacationDates]]** +
- +
-plus +
-   +
-  Type(Length) ​           Eigenschaft ​                 Beschreibung +
-  --------------------------------------------------------------------------------------------- +
-  int                     ​$userid ​                     Benutzer Id +
- +
- +
-**Beispiel**:​ +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-try { +
- +
-   //Get vacation with ID: 123 +
-   ​$result = $client_vacation->​crmgetVacationById($session_id,​ 123); +
- +
-   ​foreach($result[0] as $k => $v) { +
- +
-       echo $k." => ". $v ."<​br>​\n";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmsearchVacations ===== +
- +
- +
-(Version >= 3.7)  +
- +
-**Syntax:​** +
- +
-<​code>​ array crmsearchVacations( string $session_id,​ crmvacationsSearchTerms $crmvacationsSearchTerms,​ int $count, int $offset ) </​code>​ +
- +
-**Beschreibung:​**  +
- +
-Gibt ein Array mit Urlaubstage zurück.  +
- +
- +
-//​$search_terms//​ ist ein assoziatives Array oder ein Objekt, 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 von crmvacationsSearchTerms:​** +
-   +
-  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 Objekten:​** +
-die gleichen wie für **[[#​crmgetVacationById]]** +
- +
-**Beispiel:​**  +
- +
-<sxh php> +
-<?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 ); +
- +
-    $result = $client_vacation->​crmsearchVacations($session_id,​ $search, 10, 0); +
-+
-catch (SOAPFault $f) { +
-    print $f->​faultstring;​ +
-+
- +
-foreach( $vacations as $vacation) { +
-    foreach( $vacation as $key => $val) { +
-        echo "$key => $val<​br/>​\n";​ +
-    } +
- +
-    echo '<​hr>';​ +
-+
-?> +
-</​sxh>​ +
----------------------------- +