API Tasks
Aus TecArt-CRM Developer-Wiki
Inhaltsverzeichnis |
Hinweis
API Klassen und deren Funktionen können nur mit CRM System mit Version >= 3.2 genutzt werden
Methods
addTask
Syntax:
int addTask( array $task )
Beschreibung:
Gibt eine task_id zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Um Kontakte zuzuweisen müssen die contact ids oder einige Eigenschaften des Kontakts in contacts bereitgestellt werden.
Eigenschaften von task array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $start Start-Zeit & -Datum (Unix-Timestamp)
int $stop Stop-Zeit & -Datum (Unix-Timestamp)
string(255) $subject Betreff der Aufgabe
binary $body Gemeinsamer Text der Aufgabe
binary $userbody Text für den authentifizierten Nutzer
string(255) $cid Contact-Id, Format: Contact-Id:Person-Id;Contact-Id2:Person-Id2;...
string(255) $userid Userids, Format: User-Id1:User-Id2
int $pid Projekt-Id
int $privat Private Aufgabe (0 = öffentlich, 1 = privat)
int $priority Priorität ( -1 = niedrig, 0 = normal, 1 = hoch )
int $done Fertigstellung in Prozent (z.B. 30 = 30%)
int $status Status
1 = nicht begonnen
2 = in Bearbeitung
3 = erledigt
4 = wartet auf jemand anderen
5 = zurückgestellt
boolean $confirmed Aufgabe von authentifiziertem Nutzer angenommen
0 = nicht angenommen
1 = angenommen
int $serie Aufgabenserie
1 = täglich
2 = wöchentlich
3 = monatlich
4 = jährlich
int $intrval Serien-Intervall (z.B. 2)
int $serieend Unix-Timestamp des Endes einer Serie
double $achieved Zahl der geleisteten Stunden
double $planned Zahl der geplanten Stunden
int $sid Eltern-Aufgaben-Id
int $rem Erinnerung
0 = nicht erinnern
1 = erinnern
int $remember Anzahl der Sekunden vor ''stoptime''
double $obligingness Kulanz in Prozent
string(255) $seen Userids die diese Aufgabe gesehen haben
Format: Userid1:Userid2
string(255) $category Categorien, Format: Category1; Category2; ...
array $contacts Array mit Kontakten
Eigenschaften von $contacts array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
string(255) $cid Contact Id ( Format: Cid:Pid )
string(128) $firstname Vorname
string(128) $lastname Nachname
string(128) $displayname Name, der in Listen erscheint
string(128) $nickname Spitzname
string(255) $emailadr1 Erste E-Mail-Addresse
string(255) $emailadr2 Zweite E-Mail-Addresse
int $email_format Bevorzugtes Mail-Format
0 = Text
1 = HTML
string(128) $screen_name Screen Name, z.B. Messenger-Account
string(128) $phone_work Telefonnummer geschäftlich
string(128) $phone_home Telefonnummer privat
string(128) $phone_fax Faxnummer geschäftlich
string(128) $phone_pager Pagernummer
string(128) $phone_mobil Mobilnummer
string(128) $home_address1 Private Adresse Zeile 1
string(128) $home_address2 Private Adresse Zeile 2
string(128) $home_city Stadt
string(128) $home_region Region
string(128) $home_postcode Postleitzahl
string(128) $home_country Land
string(128) $home_website Persönliche Website
string(128) $work_title Titel auf Arbeit, z.B. CEO
string(128) $work_department Abteilung
string(128) $work_organisation Organisations- oder Unternehmensname
string(128) $work_address1 Geschäftliche Adresse Zeile 1
string(128) $work_address2 Geschäftliche Adresse Zeile 2
string(128) $work_city Stadt
string(128) $work_region Region
string(128) $work_postcode Postleitzahl
string(128) $work_country Land
string(255) $work_website Offizielle Unternehmenswebsite
string(255) $custom1 Benutzerdefiniertes Feld 1
string(255) $custom2 Benutzerdefiniertes Feld 2
string(255) $custom3 Benutzerdefiniertes Feld 3
string(255) $custom4 Benutzerdefiniertes Feld 4
string(65535) $notes Notizen
Beispiel :
<?php $task = array('start' => 0, 'stop' => 0, 'subject' => 'API Test', 'body' => 'this is a test', 'userid' => '4:5', 'userbody' => 'test', 'rem' => 0, 'remember' => 0, 'privat' => 0, 'priority' => 0, 'done' => 0, 'status' => 0, 'achieved' => 1.23, 'planned' => 3, 'confirmed' => 1, 'cid' => 0, 'pid' => 0, 'obligingness' => 0, 'contacts' => array( array('emailadr1' => 'mail@olafhoffmann.de'), array('emailadr1' => 'h1648@accor.com') ) ); try { $crmapi_tasks = crmapi::tasks(); $task_id = $crmapi_tasks->addTask($task); } catch (CRMException $e) { echo $e->getMessage(); } echo $task_id."<br/>\n"; ?>
addTasks
Syntax:
array addTasks( array $tasks )
Beschreibung:
Gibt eine Array mit task_id zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Um Kontakte zuzuweisen müssen die contact ids oder einige Eigenschaften des Kontakts in contacts bereitgestellt werden.
Eigenschaften von tasks array:
sind die selben wie für #addTask
Beispiel :
<?php $task1 = array('start' => 0, 'stop' => 0, 'subject' => 'API Test 1', 'body' => 'this is a test', 'userid' => '4:5', 'userbody' => 'test', 'rem' => 0, 'remember' => 0, 'privat' => 0, 'priority' => 0, 'done' => 0, 'status' => 0, 'achieved' => 1.23, 'planned' => 3, 'confirmed' => 1, 'cid' => 0, 'pid' => 0, 'obligingness' => 0, 'contacts' => array( array('emailadr1' => 'mail@olafhoffmann.de'), array('emailadr2' => 'h1648@accor.com') ) ); $task2 = array('start' => 0, 'stop' => 0, 'subject' => 'API Test 2', 'body' => 'this is a test', 'userid' => '4:5', 'userbody' => 'test', 'rem' => 0, 'remember' => 0, 'privat' => 0, 'priority' => 0, 'done' => 0, 'status' => 0, 'achieved' => 1.23, 'planned' => 3, 'confirmed' => 1, 'cid' => 0, 'pid' => 0, 'obligingness' => 0, 'contacts' => array( array('emailadr1' => 'mail@olafhoffmann.de'), array('emailadr2' => 'h1648@accor.com') ) ); try { $crmapi_tasks = crmapi::tasks(); $task_ids = $crmapi_tasks->addTasks(array($task1, $task2)); } catch (CRMException $e) { echo $e->getMessage(); } foreach( $task_ids as $id) { echo $id."<br/>\n"; } ?>
getTask
Syntax:
array getTask( int $task_id )
Beschreibung:
Gibt ein Array mit einer Aufgabe anhand der $task_id zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Eigenschaften der zurückgegebenen task array:
die gleichen wie für #getTasks
Beispiel:
getTasks
Syntax:
array getTasks( int $userid, int $month, int $year )
Beschreibung:
Gibt ein Array mit einer Aufgabe zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Wenn userid angegeben wird werden Aufgaben dieses Nutzers zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn userid auf 0 gesetzt ist werden die Aufgaben des authentifizierten Nutzers zurückgegeben.
Wenn month gesetzt ist, werden nur Aufgaben dieses Monats zurückgegeben. Ist month auf 0 gesetzt werden Aufgaben für alle Monate zurückgegeben.
Wenn year gesetzt ist, werden nur Aufgaben dieses Jahrs zurückgegeben. Ist year auf 0 gesetzt werden Aufgaben für alle Jahre zurückgegeben.
Eigenschaften der zurückgegebenen task array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $id Task-Id
int $start Startzeit & -Datum (Unix-Timestamp)
int $stop Stopzeit & -Datum (Unix-Timestamp)
string(255) $subject Betreff
binary $body Gemeinsamer Text
string(255) $cid Contact-Id, Format: Contact-Id:Person-Id;Contact-Id2:Person-Id2;...
string(255) $cname Kontakt-Name
string(255) $userids Userids, Format: User-Id1:User-Id2
int $pid Projekt-Id
string(255) $pname Projekt-Name
int $privat Private Aufgabe (0 = öffentlich, 1 = privat)
int $priority Priorität ( -1 = niedrig, 0 = normal, 1 = hoch )
int $done Fertigstellung in Prozent (z.B. 30 = 30%)
int $status Status
1 = nicht begonnen
2 = in Bearbeitung
3 = erledigt
4 = wartet auf jemand anderen
5 = zurückgestellt
string(255) $forward Userids zu denen die Aufgabe weitergeleitet wurde
Format: User-Id1:User-Id2
int $serie Aufgabenserie
1 = täglich
2 = wöchentlich
3 = monatlich
4 = jährlich
int $intrval Serieninterval (z.B. 2)
int $serieend Unix-Timestamp des Serienendes
double $achieved Anzahl geleistete Stunden
double $planned Anzahl geplante Stunden
int $sid Eltern-Aufgaben-Id
int $rem Erinnerung
0 = nicht erinnern
1 = erinnern
int $remember Anzahl der Sekunden vor ''stoptime''
double $obligingness Kulanz in Prozent
string(255) $seen Userids die diese Aufgabe gesehen haben
Format: Userid1:Userid2
string(255) $category Kategorien, Format: Category1; Category2; ...
array $confirmed Array für confirmed - Nutzer und deren Bestätigungsstatus
array $userdone Array für userdone - Nutzer und deren Erledigt-Status
array $userstatus Array für userstatus - Nutzer und deren Status
array $userachieved Array für userachieved - Nutzer und deren geleistete Stunden
array $userplanned Array für userplanned - Nutzer und deren geplante Stunden
array $userbody Array für userbody - Nutzer und deren Aufgabentexte
array $userchgtime Array für userchgtime - Nutzer und deren Zeit der letzten Änderung
array $contacts Array für contacts
int $chguser Userid der letzten Änderung
int $chgtime Unix-Timestamp der letzten Änderung
int $createuser Userid der Erstellung
int $createtime Unix-Timestamp der Erstellung
Eigenschaften von confirmed array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $userid Userid
boolean $confirmed Aufgabe bestätigt für diesen Benutzer
0 = nicht bestätigt
1 = bestätigt
Eigenschaften von userdone array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $userid Userid int $done Erledigt in Prozent für diesen Nutzer (0-100)
Eigenschaften von userstatus array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $userid Userid
int $status Status des Nutzers
1 = nicht begonnen
2 = in Bearbeitung
3 = erledigt
4 = wartet auf jemand anderen
5 = zurückgestellt
Eigenschaften von userachieved array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $userid Userid double $achieved geleistete Stunden für diesen Nutzer
Eigenschaften von userplanned array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $userid Userid int $planned geplante Stunden für diesen Nutzer
Eigenschaften von userbody array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $userid Userid binary $body Aufgabentext des Nutzers
Eigenschaften von userchgtime array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $userid Userid int $chgtime Unix-Timestamp der letzten Änderung dieses Nutzers
Eigenschaften von contacts array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
string(255) $cid Contact Id ( Format: Cid:Pid )
string(128) $firstname Vorname
string(128) $lastname Nachname
string(128) $displayname Name, der in Listen erscheint
string(128) $nickname Spitzname
string(255) $emailadr1 Erste E-Mail-Addresse
string(255) $emailadr2 Zweite E-Mail-Addresse
int $email_format Bevorzugtes E-Mail-Format
0 = Text
1 = HTML
string(128) $screen_name Screen Name, z.B. Messenger-Account
string(128) $phone_work Telefonnummer geschäftlich
string(128) $phone_home Telefonnummer privat
string(128) $phone_fax Faxnummer geschäftlich
string(128) $phone_pager Pagernummer
string(128) $phone_mobil Mobilnummer
string(128) $home_address1 Private Addresse Zeile 1
string(128) $home_address2 Private Addresse Zeile 2
string(128) $home_city Stadt
string(128) $home_region Region
string(128) $home_postcode Postleitzahl
string(128) $home_country Land
string(128) $home_website Persönliche Website
string(128) $work_title Titel auf Arbeit, e.g. CEO
string(128) $work_department Abteilung
string(128) $work_organisation Organisations- oder Unternehmensname
string(128) $work_address1 Geschäftliche Addresse Zeile 1
string(128) $work_address2 Geschäftliche Addresse Zeile 2
string(128) $work_city Stadt
string(128) $work_region Region
string(128) $work_postcode Postleitzahl
string(128) $work_country Land
string(255) $work_website Offizielle Firmenwebsite
string(255) $custom1 Benutzerdefiniertes Feld 1
string(255) $custom2 Benutzerdefiniertes Feld 2
string(255) $custom3 Benutzerdefiniertes Feld 3
string(255) $custom4 Benutzerdefiniertes Feld 4
string(65535) $notes Notizen
string $picture Kontaktbild-Daten - Base64-Codiert
int $chguser Userid der letzen Änderung
int $chgtime Unix-Timestamp der letzen Änderung
int $createuser Userid der Erstellung
int $createtime Unix-Timestamp der Erstellung
Beispiel:
changeTask
Syntax:
int changeTask( array $task )
Beschreibung:
Ändert Eigenschaften einer existierenden Aufgabe.
Gibt die task_id zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Eigenschaften:
sind die selben wie für #addTask und ein Variable für 'id'
Beispiel:
changeTasks
Syntax:
array changeTasks( array $tasks )
Beschreibung:
Ändert Eigenschaften von mehreren existierenden Aufgabe.
Gibt Array mit task_ids zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Eigenschaften:
sind die selben wie für #addTask und ein Variable für 'id'
Beispiel:
<?php try { $task1 = array(); $task1['id'] = 123; $task1['subject'] = 'API Task 1 changed'; $task1['contacts'] = array( array('emailadr1' => 'test@test.de') ); $task2 = array(); $task2['id'] = 124; $task2['subject'] = 'API Task 2 changed'; $task2['contacts'] = array( array('emailadr1' => 'test2@test.de') ); $crmapi_tasks = crmapi::tasks(); $task_ids = $crmapi_tasks->changeTasks( array($task1, $task2) ); } catch (CRMException $e) { echo $e->getMessage(); } foreach ($task_ids as $id) { echo $id."<br>\n"; } ?>
getChangedTasks
Syntax:
array getChangedTasks( int $userid, int $timestamp )
Beschreibung:
Gibt ein Array mit Aufgaben zurück, die seit timestamp geändert wurden.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Wenn userid gegeben ist werden die Aufgaben für den Entsprechenden Nutzer zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn userid auf 0 gesetzt ist werden Aufgaben des authentifizierten Nutzers zurückgegeben.
Eigenschaften von returned tasks array:
sind die selben wie für #getTasks
Beispiel:
<?php try { $crmapi_tasks = crmapi::tasks(); // Get only tasks, which have been changed since 26.03.2007 $result = $crmapi_tasks->getChangedTasks(0, 1174929104); } catch (CRMException $e) { echo $e->getMessage(); } foreach($result as $task) { foreach($task as $key => $value) { if(is_array($value)) echo $key." => ".print_r($value)."<br/>\n"; else echo $key." => ".$value."<br/>\n"; } echo '<hr>'; } ?>
getChangedTasksLimit
Syntax:
array getChangedTasksLimit( int $userid, int $timestamp, int $count, $int offset )
Beschreibung:
Gibt ein Array mit Aufgaben zurück, die seit timestamp geändert wurden, limitiert von count und offset.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Wenn userid gegeben ist werden die Aufgaben für den Entsprechenden Nutzer zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn userid auf 0 gesetzt ist werden Aufgaben des authentifizierten Nutzers zurückgegeben.
Eigenschaften von returned task array:
sind die selben wie für #getTasks
Beispiel:
<?php try { $crmapi_tasks = crmapi::tasks(); // Get only 10 task, which have been changed since 26.03.2007 $result = $crmapi_tasks->getChangedTasksLimit(0, 1174929104, 10, 0); } catch (CRMException $e) { echo $e->getMessage(); } foreach($result as $task) { foreach($task as $key => $value) { if(is_array($value)) echo $key." => ".print_r($value)."<br/>\n"; else echo $key." => ".$value."<br/>\n"; } echo '<hr>'; } ?>
getChangedTasksList
( CRM >= 3.4.3322 )
Syntax:
array getChangedTasksList( int $userid, int $timestamp )
Beschreibung:
Gibt ein Array mit List von Aufgaben zurück, die seit timestamp geändert wurden.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Wenn userid gegeben ist werden die Aufgaben für den Entsprechenden Nutzer zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn userid auf 0 gesetzt ist werden Aufgaben des authentifizierten Nutzers zurückgegeben.
Eigenschaften von returned task array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $id Task-Id
int $chgtime Änderungszeit (Unix-Timestamp)
int $status Status
1 = nicht begonnen
2 = in Bearbeitung
3 = erledigt
4 = wartet auf jemand anderen
5 = zurückgestellt
int $useen Ob der authentifizierte Benutzer, die Aufgabe gesehen hat.
1: ja
0: nein
Beispiel:
<?php try { $crmapi_tasks = crmapi::tasks(); // Get a list of tasks, which have been changed since 26.03.2007 $result = $crmapi_tasks->getChangedTasksList(0, 1174929104); } catch (CRMException $e) { echo $e->getMessage(); } foreach($result as $task) { foreach($task as $key => $value) { echo $key. " " .$value ."<br/>\n"; } echo '<hr>'; } ?>
getTasksFrom
Syntax:
array getTasksFrom( int $userid, int $month, int $year )
Beschreibung:
Gibt ein Array mit Aufgaben ab beginn des gegebenen Datums zurück.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Wenn userid gegeben ist werden die Aufgaben für den Entsprechenden Nutzer zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn userid auf 0 gesetzt ist werden Aufgaben des authentifizierten Nutzers zurückgegeben.
Wenn month gesetzt ist werden nur Aufgaben dieses Monats zurückgegeben. Ist month auf 0 gesetzt werden Aufgaben für alle Monate zurückgegeben.
Wenn year gesetzt ist werden nur Aufgaben dieses Jahrs zurückgegeben. Ist year auf 0 gesetzt werden Aufgaben für alle Jahre zurückgegeben.
Eigenschaften der zurückgegebenen tasks array:
sind die selben wie für #getTasks
Beispiel:
<?php try { $crmapi_tasks = crmapi::tasks(); $result = $crmapi_tasks->getTasksFrom(0, 0, 2010); } catch (CRMException $e) { echo $e->getMessage(); } foreach($result as $task) { foreach($task as $key => $value) { if(is_array($value)) echo $key." => ".print_r($value)."<br/>\n"; else echo $key." => ".$value."<br/>\n"; } echo '<hr>'; } ?>
getTaskIds
Syntax:
array getTaskIds( int $userid, int $timestamp )
Beschreibung:
Gibt ein Array mit task Ids für Aufgaben zurück, die seit timestamp geändert wurden.
Wirft eine CRMException im Fehlerfall.
Wenn userid gegeben ist, werden Aufgaben für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn userid auf 0 gesetzt wird, werden alle Aufgaben für den authentifizierten Nutzer zurückgegeben.
Eigenschaften der zurückgegebenen task ids array:
Type(Length) Eigenschaft Beschreibung --------------------------------------------------------------------------------------------- int $id Task-Id
Beispiel:
deleteTask
Syntax:
void crmdeleteTask( int $task_id )
Beschreibung:
Löscht eine Aufgabe.
Wirft eine CRMException im Fehlerfall.
Beispiel:
deleteTasks
Syntax:
void crmdeleteTasks( array $task_ids )
Beschreibung:
Löscht mehrere Aufgabe.
Wirft eine CRMException im Fehlerfall.
Beispiel:
setReadFlag
( CRM >= 3.4.3322 )
Syntax:
void setReadFlag( int $task_id, int $flag )
Beschreibung
Setzt das gelesen-Flag für die Aufgabe mit der entsprechenden $task_id.
Wenn flag auf 1 gesetzt ist, wird das Gelesen-Flag auf gesehen gesetzt, bei 0 auf ungesehen.
Wirft eine CRMException im Fehlerfall.
Beispiel
searchTasks
( CRM >= 3.5. )
Syntax:
array searchTasks( array $search )
Beschreibung
Gibt ein Array mit Aufgaben zurück anhand von Suchkriterien.
Im Falle eines Fehlers wird eine CRMException mit mehr Fehlerdetails geworfen.
Eigenschaften der search array:
Type(Length) Eigenschaft Beschreibung
---------------------------------------------------------------------------------------------
int $userid Wenn ''userid'' angegeben wird werden Aufgaben dieses Nutzers zurückgegeben( nur wenn der authentifizierte Nutzer Leseberechtigungen hat). Wenn ''userid'' auf 0 gesetzt ist werden die Aufgaben des authentifizierten Nutzers zurückgegeben.
int $month Wenn ''month'' gesetzt ist, werden nur Aufgaben dieses Monats zurückgegeben. Ist ''month'' auf 0 gesetzt werden Aufgaben für alle Monate zurückgegeben.
int $year Wenn ''year'' gesetzt ist, werden nur Aufgaben dieses Jahrs zurückgegeben. Ist ''year'' auf 0 gesetzt werden Aufgaben für alle Jahre zurückgegeben.
int $status Status
1 = nicht begonnen
2 = in Bearbeitung
3 = erledigt
4 = wartet auf jemand anderen
5 = zurückgestellt
-1 = alle außer erledigte
string $subject Name der Aufgabe. Es wird 2 Platzhalter % am Ende und Anfang der Suchstring hinzugefügt.
Eigenschaften von returned tasks array:
sind die selben wie für #getTasks
Beispiel
<?php try { $crmapi_tasks = crmapi::tasks(); // Search tasks for authenticated user and status: not begin. $result = $crmapi_tasks->searchTasks(array( 'userid' => 0, 'status' => 1 )); } catch (CRMException $e) { echo $e->getMessage(); } foreach($result as $task) { foreach($task as $key => $value) { if(is_array($value)) echo $key." => ".print_r($value)."<br/>\n"; else echo $key." => ".$value."<br/>\n"; } echo '<hr>'; } ?>
