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. addTask

Syntax:

int addTask(array $task, bool $check_exist = true)

Beschreibung:

Gibt eine task_id zurück. Mit $check_exist kann Dublettenprüfung deaktiviert werden. Standardwert ist "true".

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;...
int                     $tid                      Ticket-Id ( ab Version 4.1 )
int                     $orderid                  Auftrag-Id ( ab Version 4.2 )
int                     $ext_id                   Externe ID ( ab Version 4.2 )
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
                                                  2 = abgelehnt
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";



1.2. 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,
	'orderid'		=> 123,
	'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";
}



1.3. 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:

<?php
 
try {
	$crmapi_tasks	= crmapi::tasks();
	$result			= $crmapi_tasks->getTask(123);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $key => $value) {
	if(is_array($value)) { 
		echo $key." => ".print_r($value)."<br>  \n";
	}
	else {  
		echo $key." => ".$value."<br>  \n";
	}
}



1.4. 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;...
int                     $tid                      Ticket-Id ( ab Version 4.1 )
int                     $orderid                  Auftrag-Id ( ab Version 4.2 )
int                     $ext_id                   Externe ID ( ab Version 4.2 )
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 
int                     $confirmed                Aufgabe bestätigt für diesen Benutzer
                                                  0 = nicht bestätigt
                                                  1 = bestätigt
                                                  2 = abgelehnt

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 
double                  $planned                  geplante Stunden für diesen Nutzer

Eigenschaften von userbody array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
string(65535)           $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:

<?php
 
try {
	$crmapi_tasks	= crmapi::tasks();
	$result			= $crmapi_tasks->getTasks(0, 0, 0);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $key => $value) {
	if(is_array($value)) {
		echo $key." => ".print_r($value)."<br>  \n";
	}
	else {  
		echo $key." => ".$value."<br>  \n";
	}
}



1.5. 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:

<?php
 
try {
	$task				= array();
	$task['id']			= 123;
	$task['subject']	= 'API Task changed';
 
	$crmapi_tasks		= crmapi::tasks();
 
	$task_id			= $crmapi_tasks->changeTask($task);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $task_id."<br>\n";



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



1.7. 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>';
}



1.8. 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>';
}



1.9. getChangedTasksList

(Version >= 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>';
}



1.10. 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>';
}



1.11. 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:

<?php
 
try {   
	$crmapi_tasks	= crmapi::tasks();
	$result			= $crmapi_tasks->getTaskIds(0, 1174929104);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



1.12. deleteTask

Syntax:

void crmdeleteTask( int $task_id )

Beschreibung:

Löscht eine Aufgabe.

Wirft eine CRMException im Fehlerfall.

Beispiel:

<?php
 
try {   
	$crmapi_tasks	= crmapi::tasks();   
	$result			= $crmapi_tasks->deleteTask(123);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 



1.13. deleteTasks

Syntax:

void crmdeleteTasks( array $task_ids )

Beschreibung:

Löscht mehrere Aufgabe.

Wirft eine CRMException im Fehlerfall.

Beispiel:

<?php
 
try {   
	$crmapi_tasks	= crmapi::tasks();
	$result			= $crmapi_tasks->deleteTasks( array(123, 124) );
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.14. setReadFlag

(Version >= 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

<?php
 
try {
	$crmapi_tasks = crmapi::tasks();
    // Set 'read' for task with id = 7
    $crmapi_tasks->setReadFlag(7, 1);
}
catch (CRMException $e) {
    echo $e->getMessage();
}



1.15. searchTasks

(Version >= 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>';
}



1.16. getIdByExtId

(Version >= 4.2)

Syntax:

array getIdByExtId( string $external_id )

Beschreibung

Liefert interne ID(s) einer Aufgabe mit der übergebenen externen ID zurück.

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

Eigenschaften des zurückgegebenen task ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 Task-Id 

Beispiel:

<?php
 
try {   
	$crmapi_tasks	= crmapi::tasks();
	$result			= $crmapi_tasks->getIdByExtId(12345);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



1.17. getAllExtIds

(Version >= 4.2)

Syntax:

array getAllExtIds( string $external_id )

Beschreibung

Liefert eine lister aller externen IDs in Aufgaben zurück.

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

Eigenschaften des zurückgegebenen task ids array:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			$id			      externe Task-Id 

Beispiel:

<?php
 
try {   
	$crmapi_tasks	= crmapi::tasks();   
	$result			= $crmapi_tasks->getAllExtIds();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



1.18. setDuplicatecheckConfig

(Version >= 4.4)

Syntax:

boolean|string CRMException message setDuplicatecheckConfig( [array( [string <fieldname>, string <fieldname>...]) | NULL] )

Beschreibung:

Ermöglicht eine temporäre Überschreibung der Dublettenprüfungsfelder für die Laufzeit der angemeldeten Session.

Standardübergabe ist ein leeres Array, was gleichbedeutend mit einer nicht stattfindenden Dublettenprüfung ist.

Zurückgesetzt werden kann die temporäre Dublettenprüfung Feldkonfiguration, wenn NULL anstatt eines Array übergeben wird.

Beispiel:

<?php
 
try {   
	$api     = crmapi::tasks();
	$fields  = array('body', 'subject');
	// adding a task will execute an exists-check looking for identical values in fields "body" and "subject" 
	// and will result in an "object already exists" trigger
	$success = $api->setDuplicatecheckConfig($fields);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ($success === true ? 'override successful' : $success);



1.19. getDuplicatecheckConfig

(Version >= 4.4)

Syntax:

array | string CRMException message getDuplicatecheckConfig( )

Beschreibung:

Gibt Array mit aktueller Feldkonfiguration der Dublettenprüfung zurück.

Sollte aktuell keine temporäre Überschreibung der Feldkonfiguration aktiv sein (siehe setDuplicatecheckConfig), wird die durch die Administration konfigurierte Feldliste als Array zurückgegeben.

Beispiel:

<?php
 
try { 
	$api	= crmapi::tasks();
	$fields = $api->getDuplicatecheckConfig();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo print_r($fields, true);



1.20. getPermissions

(Version >= 4.5.17365)

Syntax:

array getPermissions( array $task_ids ) 

Beschreibung:

Gibt ein assoziatives $objects_permissions array mit den Berechtigungen für die Aufgaben mit den gegebenen $task_ids zurück.

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von $objects_permissions array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  Task ID
array		       Value                Array mit $permissions array

Eigenschaften von $permissions array:

Type(Length)	   Key                  Value       
-------------------------------------------------------------------------------
array		   user_perm            Array mit $user_permission arrays
array		   group_perm           Array mit $group_permission arrays

Eigenschaften von $user_permission array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  User's ID
array		       Value                read:   1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        write:  1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        delete: 1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von $group_permission array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  Group's ID
array		       Value                read:   1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        write:  1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        delete: 1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Beispiel

<?php
 
try {
	$crmapi_tasks	= crmapi::tasks();
	$permissions	= $crmapi_tasks->getPermissions( array(15, 20, 100) );
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
print_r($permissions);



1.21. setPermissions

(Version >= 4.5.17365)

Syntax:

array setPermissions( array $objects_permissions ) 

Beschreibung:

Setzt die Berechtigungen für mehrere Aufgaben

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

Wirft eine CRMException im Fehlerfall.

Eigenschaften von $objects_permissions array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  Task ID
array		       Value                Array mit $permissions array

Eigenschaften von $permissions array:

Type(Length)	   Key                  Value       
-------------------------------------------------------------------------------
array		   users                Array mit $user_permission arrays
array		   groups               Array mit $group_permission arrays

Eigenschaften von $user_permission array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  User's ID
array		       Value                read:   1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        write:  1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        delete: 1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von $group_permission array:

Type(Length)	   Eigenschaft          Beschreibung
-------------------------------------------------------------------------------
int                Key                  Group's ID
array		       Value                read:   1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        write:  1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
                                        delete: 1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Beispiel:

<?php
 
try {
	$crmapi_tasks	= crmapi::tasks();
	$permissions	= array(
		81941 => array(
			'users'  => array(
				'56' => array('read' => -1, 'write' => -1, 'delete' => -1)
			),
			'groups' => array(
				'4'  => array('read' => -1, 'write' => -1, 'delete' => -1)
			)
		),
		79331 => array(
			'groups' => array(
				'4'  => array('read' => -1, 'write' => -1, 'delete' => -1)
			)
		)
	);
 
    $crmapi_tasks->setPermissions($permissions);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 



1.22. getsearchfilteredTasks

(Version >= 4.7.20468)

Syntax:

array getsearchfilteredTasks(int $filter_id, string $search = "", int $count = 0, int $offset = 0, array $fields = false)

Beschreibung:

Gibt ein Array mit Aufgaben zurück, die dem angegebenen Suchfilter und Suchbegriff entsprechen, limitiert von count und offset.

Der Parameter search repräsentiert die Eingabe im Suchfeld im CRM (Platzhalter <#search_field#> in Filterbedingungen)

Über den Parameter fields können die zurückgegeben Felder eingeschränkt werden (false = alle Felder)

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

Hinweis: Es werden nur Aufgaben und Felder zurückgegeben, für die der authentifizierte Nutzer Leseberechtigungen hat.

Eigenschaften:

Das sind dieselben wie für getTask, evtl eingeschränkt nach Parameter fields.

Beispiel:

<?php
 
try {   
	$crmapi_tasks = crmapi::tasks();
 
	// Liefert die Felder Betreff und Body der ersten 10 gefundenen Aufgaben, die dem Suchfilter 5 ohne eingegebenen Suchbegriff entsprechen
	$result = $crmapi_tasks->getsearchfilteredTasks(5, "", 10, 0, array('subject', 'body'));
 
	// Liefert alle Felder aller Aufgaben, die dem Suchfilter 5 mit eingegebenen Suchbegriff "test" entsprechen
	$result = $crmapi_tasks->getsearchfilteredTasks(5, 'test', 0, 0, false);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
print_r($result);
  • No labels