Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:logon [2017/02/07 17:03]
127.0.0.1 Externe Bearbeitung
webservices:soap_webservices:logon [2020/05/06 14:08] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Logon ====== ====== Logon ======
  
-===== WSDL-URI ====== +Bitte besuchen Sie unsere neue Entwickler-Dokumentation unter [[https://docs.tecart.de/display/public/WIKI/Logon+SOAP]]
- +
- +
-<​code>​http://​hostname/​dirname/​soap/​index.php?​op=logon&​wsdl</​code>​ +
- +
-z.B. [[https://test.tecart-system.de/soap/​index.php?​op=logon&​wsdl|https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl]] +
- +
- +
-===== Methoden ====== +
- +
- +
- +
-==== crmLogin ===== +
- +
-**Syntax**:​ +
-  string crmLogin ( string $login, string $pass ) +
- +
-**Beschreibung**:​ +
- +
-Liefert die session_id , die in allen anderen Funktionen zur Authentifizierung verwendet wird. +
- +
- +
-Wenn die Authentifizierung fehlschlägt wird 0 zurückgegeben. +
- +
- +
-**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"​);​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmLoginToken ===== +
- +
-**Syntax**:​ +
-  string crmLoginToken ( string $login, string $pass ) +
- +
-**Beschreibung**:​ +
- +
-Liefert die session_id und einen token zur Authentifizierung. +
- +
- +
-**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"​);​ +
-   +
-     ​$result = $client_logon->​crmLoginToken('​test',​ '​test'​);​ +
- +
-   if (!$result) die("​invalid auth"​);​ +
- +
-   $res = explode(":",​ $result, 2); +
- +
-   ​$session_id = $res[0]; +
-   ​$token ​     = $res[1]; +
- +
-   // Weiterleiten ins TecArt-System +
-   ​header("​Location:​ https://​test.tecart-system.de/public/index.php?​id={$sessionid}&​token="​.rawurlencode($token));​ +
-   ​exit;​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</sxh> +
- +
----- +
- +
- +
-==== crmLoginExternal ===== +
- +
- +
-(Version >= 3.4.5404) +
- +
-**Syntax**:​ +
-  string crmLoginExternal ( string $login, string $pass ) +
- +
-**Beschreibung**:​ +
- +
-Authentifizierung mit extern Passwort. +
- +
- +
-Liefert die session_id , die in allen anderen Funktionen zur Authentifizierung verwendet wird. +
- +
- +
-Wenn die Authentifizierung fehlschlägt wird 0 zurückgegeben. +
- +
- +
-**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->​crmLoginExternal('​test',​ '​test'​);​ +
- +
-   if (!$session_id) die("​invalid login"​);​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmLoginMD5 ===== +
- +
- +
-<WRAP alert> +
-Diese Funktion ist veraltet und ist ab Version 4.6 nicht mehr verfügbar. Bitte verwenden Sie die Funktion **[[#​crmLogin]]** +
-</​WRAP>​ +
- +
-(Version >= 3.0.1420) +
- +
-**Syntax**:​ +
-  string crmLoginMD5 ( string $login, string $md5pass ) +
- +
-**Beschreibung**:​ +
- +
-Liefert die session_id , die in allen anderen Funktionen zur Authentifizierung verwendet wird. +
- +
- +
-Wenn die Authentifizierung fehlschlägt wird 0 zurückgegeben. +
- +
- +
-**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->​crmLoginMD5('​test',​ '​d41d8cd98f00b204e9800998ecf8427e'​);​ +
- +
-   if (!$session_id) die("​invalid login"​);​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmLogoff ===== +
- +
-**Syntax**:​ +
-  boolean crmLogoff( string $session_id ​ ) +
- +
-**Beschreibung**:​ +
- +
-Löscht die Session. +
- +
- +
-Liefert 1 bei Erfolg, 0 im Fehlerfall. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$success = $client_logon->​crmLogoff($session_id);​ +
-if ($success) echo "​logout successfully";​ +
-else          echo "​logout failed";​ +
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetLanguage ===== +
- +
-**Syntax**:​ +
-  string crmgetLanguage ( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Gibt den [[http://​en.wikipedia.org/​wiki/​List_of_ISO_639-1_codes|ISO-639-1]] Sprach-Code der momentan verwendeten Sprache zurück. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$language = $client_logon->​crmgetLanguage($session_id);​ +
-echo $language;​ +
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetList ===== +
- +
-**Syntax:​** +
-  array crmgetList ( string $session_id,​ string $list ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array von Listenelementen für eine definierte Liste. +
- +
- +
-Hinweis: Sie können den Namen der Liste erhalten, indem Sie im TecArt-System unter Administration->​Listen auf Liste->​Öffnen Rechtsklicken. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-echo "Get List '​categories':<​br>​\n";​ +
-$result = $client_logon->​crmgetList($session_id,​ '​categories'​);​ +
-foreach($result as $list_element) { +
-  echo "​{$list_element->​id},​ {$list_element->​name}<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetUsers ===== +
- +
-**Syntax:​** +
-  array crmgetUsers ( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array von Benutzer-Objekte mit allen Benutzern. +
- +
- +
-**Eigenschaften**:​ +
-   +
-  Type            Eigenschaft ​        ​Beschreibung +
-  ------------------------------------------------------------------- +
-  int   ​  ​       $id   ​  ​           Userid +
-  string ​  ​ $name ​  ​  ​   Angezeigter Nutzername +
-  string ​   $address ​       Addresse +
-  int   ​  ​       $birthday ​  ​  ​   Geburtstag (Unix Timestamp) +
-  int   ​  ​       $chgtime ​  ​  ​   Unix-Timestamp der letzten Änderung +
-  int   ​  ​       $chguser ​  ​  ​   Userid der letzten Änderung +
-  string ​  ​ $city ​  ​  ​   Stadt +
-  string ​  ​ $company ​  ​  ​   Firmenname +
-  string ​  ​ $country ​  ​  ​   Land +
-  int   ​  ​       $createtime ​  ​  ​   Unix-Timestamp der Erstellung +
-  int   ​  ​       $createuser ​  ​  ​   Userid der Erstellung +
-  string ​  ​ $department ​  ​  ​   Abteilung +
-  string ​  ​ $description ​  ​  ​   Notizen +
-  string ​  ​ $email ​  ​  ​   E-Mail-Addresse +
-  string ​  ​ $fax ​  ​  ​           Faxnummer +
-  string ​  ​ $firstname ​  ​  ​   Vorname +
-  string ​  ​ $group_id ​  ​  ​   Group-Ids, Format: Groupid1:​Groupid2 +
-  int   ​  ​       $locked ​  ​  ​   Benutzer ist gesperrt +
-  string ​  ​ $login ​  ​  ​   Login +
-  string ​  ​ $tel1 ​  ​  ​   Telefonnummer +
-  string ​  ​ $tel2 ​  ​  ​   Mobilnummer +
-  string ​  ​ $postcode ​  ​  ​   Postleitzahl +
-  string ​  ​ $profession ​        ​Beruf +
-  string ​  ​ $remoteaddr ​        ​Remote-IP für Zugriffs-Beschränkungen +
-  string ​  ​ $surname ​  ​  ​   Nachname +
-  int   ​  ​       $take_rights ​  ​  ​   Rechte von Gruppen übernehmen +
-  binary ​  ​ $userpic_data ​      Daten des Benutzerbilds - base64-codiert +
-  string ​  ​ $userpic_name ​      Name des Benutzerbilds +
-  string ​  ​ $website ​  ​  ​   Website +
-   +
-   +
-  (Version >= 3.1.2314) +
-   +
-  string ​  ​ $middlename ​        ​Zweiter Vorname +
-  string ​  ​ $suffix ​            ​Suffix +
-  string ​  ​ $spouce ​            Name des Ehepartners +
-  string ​  ​ $children ​          Namen der Kinder +
-  string ​  ​ $email1 ​            ​E-Mail 1 +
-  string ​  ​ $email2 ​            ​E-Mail 2 +
-  string ​  ​ $email3 ​            ​E-Mail 3 +
-  string ​  ​ $nickname ​          ​Spitzname +
-  string ​  ​ $screenname1 ​       Screenname 1 +
-  string ​  ​ $screenname2 ​       Screenname 2 +
-  string ​  ​ $screenname3 ​       Screenname 3 +
-  string ​  ​ $home_address1 ​     Private Adresse 1 +
-  string ​  ​ $home_address2 ​     Private Adresse 2 +
-  string ​  ​ $home_postcode ​     Private Adresse PLZ +
-  string ​  ​ $home_city ​         Private Adresse Stadt +
-  string ​  ​ $home_region ​       Private Adresse Region +
-  string ​  ​ $home_country ​      ​Private Adresse Land +
-  string ​  ​ $home_website ​      ​Private Adresse Website +
-  string ​  ​ $other_address1 ​    ​Andere Adresse 1 +
-  string ​  ​ $other_address2 ​    ​Andere Adresse 2 +
-  string ​  ​ $other_postcode ​    ​Andere Adresse PLZ +
-  string ​  ​ $other_city ​        ​Andere Adresse Stadt +
-  string ​  ​ $other_region ​      ​Andere Adresse Region +
-  string ​  ​ $other_country ​     Andere Adresse Land +
-  string ​  ​ $phone_work ​        ​Telefonnummer geschäftlich 1 +
-  string ​  ​ $phone_work2 ​       Telefonnummer geschäftlich 2 +
-  string ​  ​ $phone_home ​        ​Telefonnummer privat 1 +
-  string ​  ​ $phone_home2 ​       Telefonnummer privat 2 +
-  string ​  ​ $phone_fax ​         Telefonnummer Fax +
-  string ​  ​ $phone_fax_work ​    ​Telefonnummer Fax geschäftlich +
-  string ​  ​ $phone_pager ​       Telefonnummer Pager +
-  string ​  ​ $phone_mobil ​       Telefonnummer Mobil +
-  string ​  ​ $phone_mms ​         Telefonnummer MMS +
-  string ​  ​ $phone_sms ​         Telefonnummer SMS +
-  string ​  ​ $phone_car ​         Telefonnummer Auto +
-  string ​  ​ $phone_radio ​       Telefonnummer Radio +
-  string ​  ​ $phone_assistant ​   Telefonnummer Assistant +
-  string ​  ​ $managername ​       Managername +
-  string ​  ​ $assistantname ​     $assistantname +
-  string ​  ​ $customer_id ​       Kunden-ID +
-  string ​  ​ $accountname ​       Account-Name +
-  string ​  ​ $custom1 ​           Benutzerdefiniert 1 +
-  string ​  ​ $custom2 ​           Benutzerdefiniert 2 +
-  string ​  ​ $custom3 ​           Benutzerdefiniert 3 +
-  string ​  ​ $custom4 ​           Benutzerdefiniert 4 +
-  string ​  ​ $custom5 ​           Benutzerdefiniert 5 +
-  string ​  ​ $custom6 ​           Benutzerdefiniert 6 +
-  string ​  ​ $custom7 ​           Benutzerdefiniert 7 +
-  string ​  ​ $custom8 ​           Benutzerdefiniert 8 +
-  string ​  ​ $custom9 ​           Benutzerdefiniert 9 +
-  string ​  ​ $custom10 ​          ​Benutzerdefiniert 10 +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetUsers($session_id);​ +
-foreach($result as $user) { +
-  echo $user->​id."​ "​.$user->​name."​ "​.$user->​email."<​br> ​ "; +
-+
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetUserIdsString ===== +
- +
- +
-(Version >= 3.0.1549) +
- +
-**Syntax:​** +
-  string crmgetUserIdsString ( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert eine Liste aller user_ids als Doppelpunkt-getrennten String. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetUserIdsString($session_id);​ +
- +
-$user_ids = explode(":",​ $result); +
- +
-foreach($user_ids as $user_id) { +
-  echo $user_id."<​br> ​ "; +
-+
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetChangedUsers ===== +
- +
-**Syntax:​** +
-  array crmgetChangedUsers ( string $session_id,​ int $timestamp ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit Benutzer-Objekte von Nutzern, die sich seit //​timestamp//​ verändert haben. Benutzer-Objekt-Eigenschaften sind die gleichen wie oben. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetChangedUsers($session_id,​ mktime(0, 0, 0, 5, 18, 2007)); +
-foreach($result as $user) { +
-  foreach($user as $var => $value) echo "$var => $value<​br> ​ \n"; +
- +
-   if ($user->​userpic_name) { +
-       $fp = fopen($user->​userpic_name,​ "​w"​);​ +
-       if (!$fp) continue; ​         +
-       ​fwrite($fp,​ base64_decode($user->​userpic_data));​ +
-       ​fclose($fp);​ +
-       echo " +
-\n<img src=\"​{$user->​userpic_name}\"><​br>​\n";​ +
-   } +
-   echo "<​br>​\n";​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetChangedLists ===== +
- +
-**Syntax:​** +
-  array crmgetChangedLists ( string $session_id,​ int $timestamp ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit Listen-Objekten von Listen, die sich seit //​timestamp//​ verändert haben. +
- +
- +
-**Eigenschaften**:​ +
-   +
-  string ​   $list_name ​   // list identifier +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetChangedLists($session_id,​ 1175269610);​ +
-foreach($result as $list) { +
-  echo $list->​list_name."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmPing ===== +
- +
-**Syntax**:​ +
-  boolean crmPing( string $session_id ​ ) +
- +
-**Beschreibung**:​ +
- +
-Erneuert die Session. +
- +
- +
-Liefert 1 bei Erfolg. Im Fehlerfall wird ein SOAP Exception geworfen. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $success = $client_logon->​crmPing($session_id);​ +
-   +
-     if ($success == 1) echo "​session renewed";​ +
-     ​else ​              echo "​session lost";​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmPingMD5 ===== +
- +
-**Syntax**:​ +
-  boolean crmPingMD5( string $realm ​ ) +
- +
-**Beschreibung**:​ +
- +
-Erneuert die Session anhand einer md5 String von Benutzername und Passwort. +
- +
- +
-Liefert 1 bei Erfolg. Im Fehlerfall wird ein SOAP Exception geworfen. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $username = '​testuser';​ +
-     ​$password = '​password';​ +
- +
-   ​$success = $client_logon->​crmPingMD5( md5($username.$password) ); +
- +
-   if ($success == 1) echo "​session renewed";​ +
-   ​else ​              echo "​session lost";​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetHolidays ===== +
- +
-**Syntax**:​ +
-  array crmgetHolidays( string $session_id,​ int $year ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit Holiday-Objekten. +
- +
- +
-**Eigenschaften von holiday**:​ +
-   +
-  Type            Eigenschaft ​    ​Beschreibung +
-  ------------------------------------------------------------------- +
-  int      $id      Id des Feiertages (nur ab der Version 3.7) +
-  int   ​  ​       $day   ​  ​       Tag des Feiertags +
-  int   ​  ​       $month ​  ​ Monat des Feiertags +
-  int            $year    Jahr des Feiertags +
-  string ​  ​ $subject ​   Name des Feiertags +
-  int   ​  ​       $type           = 0 - jedes Jahr an einem anderen Tag +
-                                  = 1 - jedes Jahr am selben Tag +
-  int   ​  ​       $groupid ​  ​ Group-Id,​ z.B. für den Fall, das User aus +
-                                  unterschiedlichen Ländern kommen +
-  string ​  ​ $description ​  ​ Beschreibung (nur ab der Version 3.7) +
-   +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetHolidays($session_id,​ 2008); +
- +
-foreach($result as $hday) { +
-  echo $hday->​day."​."​.$hday->​month."​."​.$hday->​year."​ - "​.$hday->​subject."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetHolidaysIds ===== +
- +
- +
-(Version >= 3.7) +
- +
-**Syntax**:​ +
-  array crmgetHolidaysIds( string $session_id,​ int $year ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit IDs-Objekt der Feiertagen für das gegebene Jahr zurück. +
- +
- +
-**Eigenschaften von IDs-Objekt**:​ +
-   +
-  Type            Eigenschaft ​    ​Beschreibung +
-  ------------------------------------------------------------------- +
-  int   ​  ​       $id   ​  ​       Id des Feiertages +
-   +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetHolidaysIds($session_id,​ 2010); +
- +
-foreach($result as $obj) { +
-  echo $obj->​id."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetHolidayById ===== +
- +
- +
-(Version >= 3.7) +
- +
-**Syntax**:​ +
-  array crmgetHolidayById( string $session_id,​ int $id ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array mit genau ein Objekt mit der Information des Feiertages anhand des Ids zurück. +
- +
- +
-**Eigenschaften von Holiday Objekt**: +
- +
-sind die selben wie **[[#​crmgetHolidays]]** +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetHolidayById($session_id,​ 123); +
- +
-if (isset($result[0]) && $result[0]['​id'​]) { +
-  echo "​Subject:​ ". $result[0]->​subject ."<​br> ​ "; +
-     echo "Date: ". $result[0]->​day ."​-"​. $result[0]->​month ."​-"​. $result[0]->​year;​ +
-+
-else { +
-  echo "No Holiday found for this id!";​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetHolidaysUser ===== +
- +
-**Syntax**:​ +
-  array crmgetHolidaysUser( string $session_id,​ int $userid, int $year ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit Holiday-Objekten von einem User für ein bestimmtes Jahr zurück. +
- +
- +
-Beim Fehlerfall wird ein SOAP Exception geworfen +
- +
- +
-**Eigenschaften von holiday Array**: +
-Sind gleiche wie von **[[#​crmgetHolidays]]** +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $result = $client_logon->​crmgetHolidaysUser($session_id,​ 4, 2008); +
- +
-   ​foreach($result as $hday) { +
-       echo $hday->​day."​."​.$hday->​month."​."​.$hday->​year."​ - "​.$hday->​subject."<​br>​\n";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetDepartments ===== +
- +
-**Syntax**:​ +
-  array crmgetDepartments( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit allen Abteilung. +
- +
- +
-**Eigenschaften**:​ +
-   +
-  Type            Eigenschaft ​    ​Beschreibung +
-  ------------------------------------------------------------------- +
-  int   ​  ​       $depid         ID der Abteilung  +
-  string ​  ​ $name ​   Name der Abteilung  +
-   +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetDepartments($session_id);​ +
- +
-foreach($result as $department) { +
-  echo $department->​depid."​ - "​.$department->​name."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetGroups ===== +
- +
- +
-**Syntax**:​ +
-  array crmgetGroups( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit allen Gruppen im TecArt-System. +
- +
- +
-Im Fehlerfall wird ein SOAP Exception geworfen. +
- +
- +
-**Eigenschaften zurückgelieferter Array**: +
-   +
-  Type            Eigenschaft ​    ​Beschreibung +
-  ------------------------------------------------------------------- +
-  int   ​  ​       $group_id ID der Gruppe +
-  string ​  ​ $name ​   Name der Gruppe +
-   +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $result = $client_logon->​crmgetGroups($session_id);​ +
- +
-   ​foreach($result as $group) { +
-       echo $group->​group_id."​ - "​.$group->​name."<​br>​\n";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetAdminGroups ===== +
- +
- +
-(Version >= 3.5) +
- +
-**Syntax**:​ +
-  array crmgetAdminGroups( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit den ID der Admin Gruppe im TecArt-System. +
- +
- +
-Im Fehlerfall wird ein SOAP Exception geworfen. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $result = $client_logon->​crmgetAdminGroups($session_id);​ +
- +
-   ​foreach($result as $group) { +
-       echo "Admin group id: " .$group->​id. "<​br>​\n";​ +
-   } +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetVersion ===== +
- +
- +
-(Version >= 3.0.1420) +
- +
-**Syntax**:​ +
-  string crmgetVersion( string $session_id ​ ) +
- +
-**Beschreibung**:​ +
- +
-Liefert die TecArt-System Versionsnummer. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-echo $client_logon->​crmgetVersion($session_id);​ +
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetAuthUserInfo ===== +
- +
- +
-(Version >= 3.0.1420) +
- +
-**Syntax**:​ +
-  string crmgetAuthUserInfo( string $session_id ​ ) +
- +
-**Beschreibung**:​ +
- +
-Liefert die Information des authentifizierten Benutzers. +
- +
- +
-**Eigenschaften der zurückgegenbenen Array** +
-Sind die gleiche wie von **[[#​crmgetUsers]]** +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$info = $client_logon->​crmgetAuthUserInfo($session_id);​ +
- +
-foreach($info as $user) { +
-  echo $user->​id."​ "​.$user->​name."​ "​.$user->​email."<​br> ​ "; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetDate ===== +
- +
- +
-(Version >= 3.2.3601) +
- +
-**Syntax**:​ +
-  string crmgetDate( string $session_id ​ ) +
- +
-**Beschreibung**:​ +
- +
-Liefert das TecArt-System Datum des aktuellen Benutzers als Doppelpunkt-getrennte Zeichenfolge. +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$date = $client_logon->​crmgetDate($session_id);​ +
- +
-list($year, $month, $day, $hour, $minute, $second) = explode(":",​ $date); +
- +
-echo "The time is {$hour}:​{$minute}:​{$second}";​ +
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmsetUserOption ===== +
- +
- +
-(Version >= 3.4.5156)  +
- +
-**Syntax**:​ +
-  string crmgetUserOption( string $session_id,​ string $option, string $value ) +
- +
-**Beschreibung**:​ +
- +
-Setz ein Value zu dem Option des eingeloggten Users. +
- +
- +
-Liefert beim Erfolg 1, beim Fehler ein SOAP-Exception zurück. +
- +
- +
-**Beispiel für input $option**:​ +
-sind gleiche wie von **[[#​crmgetUserOption]]** +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $option = $client_logon->​crmsetUserOption($session_id,​ '​email',​ '​test@email.de'​);​ +
- +
-  if ($option == 1) +
-      echo 'Email wurde gesetzt';​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetUserOption ===== +
- +
- +
-(Version >= 3.3.3650)  +
- +
-**Syntax**:​ +
-  string crmgetUserOption( string $session_id,​ string $option ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Ergebnis als String zurück. +
- +
- +
-Dieses String kann ein JSON-encode String sein, wenn das Ergebnis ein komplexe Werte hat (Array, Object). +
- +
- +
-**Beispiel für input $option**:​ +
-   +
-  Option ​              ​Value ​                    ​Beschreibung +
-  ------------------------------------------------------------------------------ +
-  groups ​              ​String ​                   Gruppe, zu den der User gehört. +
-  email                String ​                   Email Adress +
-  access_owndocs ​      ​String ​                   Zugang zu eigenen Dokumenten +
-  access_email ​        ​String ​                   Zugang zu E-Mail-Client +
-  access_todo ​         String ​                   Zugang zu Aufgaben +
-  access_dates ​        ​String ​                   Zugang zu Terminen +
-  access_contacts ​     String ​                   Zugang zu Kontakten  +
-  access_documents ​    ​String ​                   Zugang zu gemeinsamen Dokumenten +
-  access_calls ​        ​String ​                   Zugang zu Anrufen +
-  access_projects ​     String ​                   Zugang zu Projekten +
-  access_forum ​        ​String ​                   Zugang zu Forum +
-  access_finances ​     String ​                   Zugang zu Finanzen +
-  access_contracts ​    ​String ​                   Zugang zu Verträgen +
-  access_offers ​       String ​                   Zugang zu Angeboten  +
-  access_domains ​      ​String ​                   Zugang zu Domains +
-  access_accounts ​     String ​                   Zugang zu Accounts +
-  access_vacations ​    ​String ​                   Zugang zu Urlaubsplanung +
-  access_rotas ​        ​String ​                   Zugang zu Dienstplanung +
- +
- +
-**Beispiel 1:** +
-<sxh php> +
- +
-<?php +
- +
-$option = $client_logon->​crmgetUserOption($session_id,​ '​email'​);​ +
- +
-echo $option; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
-**Beispiel 2:** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetUserOption($session_id,​ '​groups'​);​ +
- +
-$groups = json_decode($result);​ +
- +
-foreach($groups as $group) { +
-  echo $group ."<​br> ​ "; +
-+
- +
-?> +
- +
-</​sxh>​ +
----- +
- +
- +
-==== crmgetUserOptions ===== +
- +
-**Syntax**:​ +
-  array crmgetUserOptions( string $session_id ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein Array mit Optionen. +
- +
- +
-**Eigenschaften von options**:​ +
-   +
-  Type            Eigenschaft ​    ​Beschreibung +
-  ----------------------------------------------- +
-  string ​         $option ​   Name der Option +
-  string ​  ​ $value ​   Wert der Option +
- +
- +
-**Beschreibung of option**: +
-Sind gleich wie von **[[#​crmgetUserOption]]** +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetUserOptions($session_id);​ +
- +
-foreach($result as $opt) { +
-  echo $opt->​option."​ -> "​.$opt->​value."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmgetAssocOptions ===== +
- +
-**Syntax**:​ +
-  array crmgetAssocOptions( string $session_id,​ string $option ) +
- +
-**Beschreibung**:​ +
- +
-Liefert ein associative array mit Options von allen Users zurück. +
- +
- +
-**Beispiel für input $option ** +
-Sind die selben wie für **[[#​crmgetUserOption]]** +
- +
-**Eigenschaften des zurückgelieferten Arrays**: +
-   +
-  Type               ​Eigenschaft ​                 Beschreibung +
-  ------------------------------------------------------------------------------ +
-  int                option ​                      ​UserID +
-  string ​            ​value ​                       Value der Option +
- +
- +
-**Beispiel 1 : Get email from all users.** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetAssocOptions($session_id,​ '​email'​);​ +
- +
-foreach($result as $opt) { +
-  echo $opt->​option."​ -> "​.$opt->​value."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
-**Beispiel 2 : Get access_dates from all users.** +
-<sxh php> +
- +
-<?php +
- +
-$result = $client_logon->​crmgetAssocOptions($session_id,​ '​access_dates'​);​ +
- +
-foreach($result as $opt) { +
-  echo $opt->​option."​ -> "​.$opt->​value."<​br> ​ \n"; +
-+
- +
-?> +
- +
-</​sxh>​ +
- +
----- +
- +
- +
-==== crmsetList ===== +
- +
- +
-(Version >= 4.3) +
- +
-**Syntax**:​ +
-  int crmsetList(string $session_id,​ string $name, array $crmListItems) +
- +
-**Beschreibung**:​ +
- +
-Möglichkeit,​ die Liste mit dem übergebenen Namen aus $name mit Werten zu befüllen. Bei Erfolg wird 1 zurückgegeben. +
- +
- +
-Im Falle eines Fehlers wird eine SOAP-Exception zurückgegeben. +
- +
- +
-//​crmListItems//​ ist ein Array von assoziativen Arrays oder Objekten. +
- +
- +
-**Eigenschaften für $crmListItems**:​ +
-   +
-  Type(Length) ​     Eigenschaft ​         Beschreibung +
-  ------------------------------------------------------------------- +
-  int   $key  ​      ​Indexwert des Listeneintrages (wenn nicht gesetzt, wird automatischer Wert ermittelt) +
-  int   $position  ​      ​Position des Listeneintrages zur Sortierung (wenn nicht gesetzt, wird Position = 0 gesetzt) +
-  string  ​ $de        ​Angezeigter Wert des Listeneintrages für Sprache: Deutsch +
-  string  ​ $en        ​Angezeigter Wert des Listeneintrages für Sprache: Englisch +
-  . +
-  . +
-  . +
-  string  ​ $vn        ​Angezeigter Wert des Listeneintrages für Sprache: Vietnamesisch +
- +
- +
-//​Angezeigter Wert des Listeneintrages//​ ist Abhängig von den im System verfügbaren aktiven Sprachen. +
- +
- +
-**Beispiel 1:** +
-<sxh php> +
- +
-<?php +
- +
-$values = array( +
- '​crmListItems'​ => array( +
- array( +
- '​key' ​     => '​testkey1',​ +
- '​position'​ => 1, +
- '​de' ​      => 'Neuer Listen-Eintrag #1', +
- '​en' ​      => 'New list item #1' +
- ), +
- array( +
- '​de' ​      => 'Neuer Listen-Eintrag #2', +
- '​en' ​      => 'New list item #2' +
-+
-+
-); +
- +
-$res = $client_logon->​crmsetList($session_id,​ '​testliste',​ $values); +
- +
-print $res.'​ +
-'; +
- +
-?> +
- +
-</​sxh>​ +
- +
----- +