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


 

Mit der Veröffentlichung von TecArt Version 4.10 wird diese Version des REST Webservice nicht weiterentwickelt, steht aber zu Zwecken der Abwärtskompatibilität weiter zur Verfügung. 

With the release of TecArt version 4.10 this version of REST Webservice will no longer receive further development, yet will stay available for reasons of downward compatibility.

1. Aufruf URL

http://hostname/dirname/rest/index.php/tasks

e.g. https://test.tecart-system.de/rest/index.php/tasks

2. Methoden

2.1. crmaddTask

Syntax:

int crmaddTask( array(string $session_id, array $crmTaskItem [, int $check_exist]) )

Beschreibung:

Gibt eine task_id bei Erfolg zurück.

crmTaskItem ist ein assoziatives Array.

check_exist optional, Existentprüfung beim Anlegen von Aufgaben.

Zum Zuweisen von Kontakten müsses Sie Kontakt-IDs oder einige Eigenschaften des Kontakts in contacts Array angeben, das System erledigt den Rest.

Eigenschaften von crmTaskItem 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 aktuellen Benutzer
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                     $tid                      Ticket-Id ( ab Version 4.1 )
int                     $orderid                  Auftrag-Id ( ab Version 4.2 )
int                     $ext_id                   Feld zur Speicherung IDs externer Anwendungen ( ab Version 4.2 )
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 bestätigt durch aktuelle Benutzer
                                                  0 = nicht bestätigt
                                                  1 = bestätigt
int                     $serie                    Aufgabenserie
                                                  1 = täglich
                                                  2 = wöchentlich
                                                  3 = monatlich
                                                  4 = jährlich
int                     $intrval                  Aufgabenserieninterval (z.B. 2) 
int                     $serieend                 Unix-Timestamp des Endes der Serie
double                  $achieved                 Anzahl der geleisteten Stunden
double                  $planned                  Anzahl der geplanten Stunden
int                     $sid                      Parent-Task-Id 
int                     $rem                      Erinnerung
                                                  0 = nicht erinnern
                                                  1 = erinnern
int                     $remember                 Anzahl der Sekunden vor Stoppzeit
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                   $contacts                 Array mit contacts-Objekten

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-Address 
string(255)             $emailadr2                Zweite E-Mail-Address 
int                     $email_format             Bevorzugtes 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            PLZ
string(128)             $home_country             Land
string(128)             $home_website             Private Website 
string(128)             $work_title               Titel, z.B. CEO 
string(128)             $work_department          Abteilung
string(128)             $work_organisation        Organisations- or Firmenname  
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            PLZ 
string(128)             $work_country             Land
string(255)             $work_website             Offizielle Firmen-Website 
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
 
try { 
	$task = array(
		'start'        => 0,
		'stop'         => 0,
		'subject'      => 'webservicetest',
		'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'      => 0,
		'obligingness' => 0
	);
 
	include_once 'crm_rest_api.php';
 
	$tasks		= new crm_rest_api("http://hostname/dirname/rest/index.php/tasks");
	$task_id	= $tasks->crmaddTask(
		array(
			'session_id'	=> $session_id,
			'crmTaskItem'	=> $task
		)
	);
	echo $task_id."<br>\n";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.2. crmaddTasks

Syntax:

array crmaddTasks( array(string $session_id, array $crmTasksItems) )

Beschreibung:

Fügt mehrere Aufgaben mit einem Webservices-Methoden-Aufruf hinzu.

Liefert die Tasks-IDs zurück.

Eigenschaften von crmTasksItems:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
crmTaskItems            $crmTaskItem              array mit crmTaskItem-Objekten 
                                                  <p>sind die selben wie für '''[[#crmaddTask]]'''</p>

Beispiel :

<?php
 
try {
 
	$task1 = array(
		'start'        => mktime(16, 0, 0, 12, 10, 2007),
		'stop'         => mktime(17, 0, 0, 12, 10, 2007),
		'subject'      => 'WS-Test',
		'body'         => 'this is a test',
		'userid'       => '5',
		'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
	);
 
	$task2 = array(
		'start'        => mktime(16, 0, 0, 12, 15, 2007),
		'stop'         => mktime(17, 0, 0, 12, 15, 2007),
		'subject'      => 'WS-Test II',
		'body'         => 'this is a test II',
		'userid'       => '5',
		'rem'          => 0,
		'remember'     => 0,
		'privat'       => 0,
		'priority'     => 0,
		'done'         => 0,
		'status'       => 0,
		'achieved'     => 1.55,
		'planned'      => 3,
		'confirmed'    => 1,
		'cid'          => '3242:4233;23342:45534',
		'pid'          => 0,
		'orderid'      => 1234,
		'obligingness' => 0
	);
 
	$task_ids = $tasks->crmaddTasks(
		array(
			'session_id'		=> $session_id,
			'crmTaskItems'		=> array($task1, $task2)
		)
	);
 
	foreach($task_ids as $id) {
		echo $id. "<br>";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.3. crmchangeTask

Syntax:

int crmchangeTask( array(string $session_id, int $task_id, array $crmTaskItem) )

Beschreibung:

Ändert Eigenschaften einer bestehenden Aufgabe.

Liefert die task_id bei Erfolg zurück.

crmTaskItem ist ein assoziatives Array.

Eigenschaften: sind die selben wie für crmaddTask mit task_id

Beispiel:

<?php
 
try { 
	$task = array(
		'id'		=> 234,
		'subject'	=> 'WebService Task changed'
	);
 
	$params = array(
		'session_id'		=> $session_id,
		'crmTaskItem'		=> $task
	);
 
	$task_id = $tasks->crmchangeTask($params);
 
	echo $task_id."<br>\n";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.4. crmchangeTasks

Syntax:

boolean crmchangeTasks( array(string $session_id, array $crmTasksItems) )

Beschreibung:

Ändert Eigenschaften vorhandener Aufgaben.

Liefert die task_ids als Array zurück.

Eigenschaften: sind die selben wie für crmaddTasks mit task_ids

Beispiel:

<?php
 
try { 
	$task1 = array(
		'id'           => 20221,
		'subject'      => 'WS-Test changed',
		'userid'       => '5:2'
	);
 
   $task2 = array(
		'id'           => 23224,
		'subject'      => 'WS-Test II changed',
		'body'         => 'this was a test'
	);
 
	$task_ids = $tasks->crmchangeTasks(
		array(
			'session_id'		=> $session_id,
			'crmTaskItems'		=> array($task1, $task2)
		)
	);
 
	foreach($task_ids as $id) {
		echo $id. "<br>";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.5. crmdeleteTask

Syntax:

int crmdeleteTask( array(string $session_id, int $task_id) )

Beschreibung:

Löscht eine Aufgabe. Liefert 1 bei Erfolg.

Beispiel:

<?php
 
try { 
	$success = $tasks->crmdeleteTask(
		array(
			'session_id'	=> $session_id,
			'task_id'		=> $task_id
		)
	);
 
	if ($success == 1) {
		echo "Delete task success.";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.6. crmdeleteTasks

Syntax:

int crmdeleteTasks( array(string $session_id, array $task_ids) )

Beschreibung:

Löscht meherere Aufgaben. Liefert 1 bei Erfolg.

task_ids ist eine Array mit Aufgaben-IDs.

Beispiel:

<?php
 
try {
	$task_ids	= array(23432, 44533, 35223);
	$success	= $tasks->crmdeleteTasks(
		array(
			'session_id'	=> $session_id,
			'task_ids'		=> $task_ids
		)
	);
 
	if ($success == 1) {
		echo "Deleting tasks success.";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.7. crmgetChangedTasks

Syntax:

array crmgetChangedTasks( array(string $session_id, int $userid, int $timestamp) )

Beschreibung:

Gibt ein Array von Aufgaben-Objekten, die seit timestamp geändert wurden.

Wenn userid gegeben ist, werden die Aufgaben dieses Nutzers zurückgegeben(nur wenn der authentifizierte Nutzer ausreichende Leseberechtigungen hat) . Wenn userid auf 0 gesetzt ist, werden die Aufgaben des authentifizierten Benutzer zurückgegeben.

Eigenschaften von task Object:

sind die selben wie für crmgetTasks

Beispiel:

<?php
 
try { 
	$result = $tasks->crmgetChangedTasks(
		array(
			'session_id'	=> $session_id,
			'userid'		=> 0,
			'timestamp'		=> 1174929104
		)
	);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->confirmed)) {
			echo "Task confirmed by: ";    
 
			foreach($task->confirmed as $user_id => $confirmed) {
				if ($confirmed == 1) {
					echo $user_id."; ";
				}
			}
			echo "<br>\n";
		}
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.8. crmgetChangedTasksLimit

Syntax:

array crmgetChangedTasksLimit( array(string $session_id, int $userid, int $timestamp, int $count, $int offset) )

Beschreibung:

Gibt ein Array von Aufgabe-Objekten zurück, die seit Timestamp geändert wurden, begrenzt durch count und Offset.

Wenn userid angegeben wird, werden die Aufgaben dieses Benutzers zurückgegeben werden, nur dann, wenn der authentifizierte Benutzer über die Berechtigung zum Lesen verfügt. Wenn userid auf 0 gesetzt ist, werden die Aufgaben des authentifizierten Benutzer zurückgegeben.

Eigenschaften von task Objekt:

sind die selben wie für crmgetTasks

Beispiel:

<?php
 
try { 
	$params	= array(
		'session_id'	=> $session_id,
		'userid'		=> 0,
		'timestamp'		=> 1174929104,
		'count'			=> 10,
		'offset'		=> 0
	);
	$result = $tasks->crmgetChangedTasksLimit($params);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->confirmed)) {
			echo "Task confirmed by: ";    
 
			foreach($task->confirmed as $user_id => $confirmed) {
				if ($confirmed == 1) {
					echo $user_id."; ";
				}
			}
			echo "<br>\n";
		}
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.9. crmgetTasks

Syntax:

array crmgetTasks( array(string $session_id, int $user_id, int $month, int $year) )

Beschreibung:

Gibt ein Array von Task-Objekten zurück.

Wenn user_id gegeben ist, werden die Aufgaben dieses Benutzers nur zurückgegeben, wenn der authentifizierte Benutzer die Berechtigung zum Lesen hat. Wenn user_id auf 0 gesetzt ist, werden die Aufgaben des authentifizierten Benutzer zurückgegeben.

Wenn month gesetzt ist, werden nur Aufgaben dieses Monats zurückgegeben. Setzen Sie ihn auf 0 alle Monate zu bekommen.

Wenn year gesetzt ist, werden nur Aufgaben dieses Jahres zurückgegeben werden. Setzen Sie ihn auf 0, um alle Jahre zu bekommen.

Eigenschaften der zurückgegebenen task Objekte:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $id                       Task-Id 
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
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 
int                     $tid                      Ticket-Id ( ab Version 4.1 )
int                     $orderid                  Auftrag-Id ( ab Version 4.2 )
int                     $ext_id                   Feld zur Speicherung IDs externer Anwendungen ( ab Version 4.2 )
string(255)             $pname                    Projekt-Name 
int                     $privat                   Privater Aufgabe (0 = public, 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                  Aufgabenserieninterval (z.B. 2) 
int                     $serieend                 Unix-Timestamp des Serienendes
double                  $achieved                 Zahl der geleisteten Stunden
double                  $planned                  Zahl der geplanten Stunden
int                     $sid                      Parent-Task-Id 
int                     $rem                      Erinnerung 
                                                  0 = nicht erinnern
                                                  1 = erinnern
int                     $remember                 Zahl 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 mit confirmed Objekte - Nutzer und deren Bestätigungsstatus
array                   $userdone                 Array mit userdone Objekte - Nutzer und deren Erledigt-Status
array                   $userstatus               Array mit userstatus Objekte - Nutzer und deren Status
array                   $userachieved             Array mit userachieved Objekte - Nutzer und deren geleistete Stunden
array                   $userplanned              Array mit userplanned Objekte - Nutzer und deren geplante Stunden
array                   $userbody                 Array mit userbody Objekte - Nutzer und deren Notizen
array                   $userchgtime              Array mit userchgtime Objekte - Nutzer und deren Zeit der letzen Änderung
array                   $contacts                 Array mit contacts Objekte

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                     $key                      Userid 
int                     $value                    Aufgabe bestätigt
                                                  0 = nicht bestätigt
                                                  1 = bestätigt

Eigenschaften von userdone Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
int                     $value                    erledigt in Prozent (0-100)

Eigenschaften von userstatus Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
int                     $value                    Status des Nutzers 
                                                  1 = nicht begonnen
                                                  2 = in Bearbeitung
                                                  3 = erledigt
                                                  4 = wartend
                                                  5 = zurückgestellt

Eigenschaften von userachieved Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
double                  $value                    geleistete Stunden

Eigenschaften von userplanned Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
double                  $value                    geplante Stunden

Eigenschaften von userbody Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
string(65535)           $value                    Text des Nutzers

Eigenschaften von userchgtime Array:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $key                      Userid 
int                     $chgtime                  Unix-Timestamp der Letzen Änderung

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-Address 
string(255)             $emailadr2                Zweite E-Mail-Address 
int                     $email_format             Bevorzugtes 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
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            PLZ
string(128)             $home_country             Land
string(128)             $home_website             Private Website 
string(128)             $work_title               Titel, z.B. CEO 
string(128)             $work_department          Abteilung
string(128)             $work_organisation        Organisations- oder Firmenname  
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            PLZ 
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                  Bilddaten des Kontakts - base64-codiert
int                     $chguser                  Userid der letzten Änderung
int                     $chgtime                  Unix-Timestamp der letzten Änderung
int                     $createuser               Userid der Erstellung
int                     $createtime               Unix-Timestamp der Erstellung

Beispiel:

<?php
 
try {
	$params = array(
		'session_id'	=> $session_id,
		'user_id'		=> 0,
		'month'			=> 3,
		'year'			=> 2007
	);
 
	$result = $tasks->crmgetTasks($params);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->confirmed)) {
			echo "Task confirmed by: ";    
 
			foreach($task->confirmed as $user_id => $confirmed) {
				if ($confirmed == 1) {
					echo $user_id."; ";
				}
			}
			echo "<br>\n";
		}
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.10. crmgetTask

Syntax:

array crmgetTask( array(string $session_id, int $task_id) )

Beschreibung:

Gibt nur ein Task-Objekt zurück.

task_id ist der Task-ID.

Eigenschaften der zurückgegebenen task Objekte:

sind die selben wie für crmgetTasks

Beispiel:

<?php
 
try { 
	$task = $tasks->crmgetTask(
		array(
			'session_id'	=> $session_id,
			'task_id'		=> 2440
		)
	);
 
	echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
	if (count($task->confirmed)) {
		echo "Task confirmed by: ";    
 
		foreach($task->confirmed as $user_id => $confirmed) {
			if ($confirmed == 1) {
				echo $user_id."; ";
			}
		}
		echo "<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.11. crmgetTaskIds

Syntax:

array crmgetTaskIds( array(string $session_id, int $user_id, int $timestamp) )

Beschreibung:

Liefert ein Array mit Aufgaben-ID Objekten, die seit Timestamp geändert wurden.

Wenn user_id angegeben wird, werden die Aufgaben dieses Benutzers zurückgegeben( nur dann, wenn der authentifizierte Benutzer über Leseberechtigungen verfügt). Wenn userid auf 0 gesetzt ist, werden die Aufgaben den authentifizierten Benutzer zurückgegeben.

Beispiel:

<?php
 
try { 
	$result = $tasks->crmgetTaskIds(
		array(
			'session_id'	=> $session_id,
			'user_id'		=> 0,
			'timestamp'		=>  1174929104
		)
	);
 
	foreach($result as $id) {
		echo $id."<br>";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.12. crmgetTasksFrom

Syntax:

array crmgetTasksFrom( array(string $session_id, int $userid, int $month, int $year) )

Beschreibung:

Gibt ein Array mit Aufgabenobjekten vom angegebenen Datum ab zurück.

Wenn userid gegeben ist, werden Aufgaben für den entsprechenden Nutzer zurückgeliefert(nur wenn der authentifizierte Benutzer die ausreichenden Berechtigungen besitzt). 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. Setzen Sie ihn auf 0, um alle Monate zurückzubekommen.

Wenn year gesetzt ist, werden nur Aufgaben dieses Jahres zurückgegeben werden. Setzen Sie ihn auf 0, um alle Jahre zurückzubekommen..

Eigenschaften der zurückgegebenen task Objekte:

sind die selben wie für crmgetTasks

Beispiel:

<?php
 
try { 
	$params = array(
		'session_id'	=> $session_id,
		'userid'		=> 0,
		'month'			=> 3,
		'year'			=> 2007
	);
 
	$result = $tasks->crmgetTasksFrom($params);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->confirmed)) {
			echo "Task confirmed by: ";    
 
			foreach($task->confirmed as $user_id => $confirmed) {
				if ($confirmed == 1) {
					echo $user_id."; ";
				}
			}
			echo "<br>\n";
		}
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.13. crmgetChangedTasksList

(Version >= 3.4.4176)

Syntax:

array crmgetChangedTasksList( array(string $session_id, int $userid, int $timestamp) )

Beschreibung:

Gibt ein Objekt mit List von Aufgaben zurück, die seit timestamp geändert wurden.

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 Objekt:

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 {
 	// Get a list of tasks from user ID 4, which have been changed since 26.03.2007
	$params = array(
		'session_id'	=> $session_id,
		'userid'		=> 4,
		'timestamp'		=> 1174929104
	);
 
	$result = $tasks->getChangedTasksList($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
$tasks = get_object_vars($result);
 
foreach($tasks as $task_obj) {
	$task = get_object_vars($task_obj);
 
	foreach($task as $key => $value) {
		echo $key. " " .$value ."<br>\n";
	}
 
	echo '<hr>';
}



2.14. crmsetReadFlag

(Version >= 3.4.5400)

Syntax:

int crmsetReadFlag( array(string $session_id, 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.

Gibt 1 beim Erfolg zurück.

Beispiel

<?php
 
try { 
	// Set 'read' for task with id = 7
    $success = $tasks->crmsetReadFlag(
		array(
			'session_id'	=> $session_id,
			'task_id'		=> 7,
			'flag'			=> 1
		)
	);
 
    if ($success == 1) {
		echo 'Success';
	}
}
catch (CRMException $e) {
    echo $e->getMessage();
}



2.15. crmsearchTasks

(Version >= 3.5.)

Syntax:

array crmsearchTasks( array(string $session_id, array $search_terms) )

Beschreibung

Gibt ein Array mit Aufgaben zurück anhand von Suchkriterien.

Eigenschaften der $search_terms 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 crmgetTasks

Beispiel

<?php
 
try { 
    // Search for tasks with subject LIKE '%Test REST API%'
    $search = array('subject' => 'Test REST API');
    $result = $tasks->crmsearchTasks(
		array(
			'session_id'	=> $session_id,
			'search_term'	=> $search
		)
	);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach ($tasks as $task) {
    echo $task->subject;
}



2.16. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( array( string $session_id, int $ext_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.

Beispiel:

<?php
 
try {
	$result = $tasks->crmgetIdByExtId(
		array(
			'session_id'	=> $session_id,
			'ext_id'		=> 12345
		)
	);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



2.17. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( array ( string $session_id ) )

Beschreibung

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

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

Beispiel:

<?php
 
try { 
	$result = $tasks->crmgetAllExtIds(array('session_id' => $session_id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



2.18. crmsetDuplicateConfig

(Version >= 4.4)

Syntax:

boolean | string <err_msg> crmsetDuplicateConfig( array( 'session_id' => string <session_id>, 'fields' => array( string <fieldname>, [string <fieldname>...])) )

Beschreibung:

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

Parameter fields ist ein Array mit den Feldnamen, die anstatt der aktuell für das Modul festgelegten Felder zur Dublettenprüfung herangezogen werden sollen.

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
	$rest_url    = 'https://<hostname>/<dirname>/rest/index.php/tasks';
	$session_id  = session_id();
	$tasks       = new crm_rest_api($rest_url);
 
	$params  = array(
		'session_id'	=> $session_id,
		'fields'		=> array('body', 'subject')
	);
	$success = $tasks->crmsetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ($success ? 'override successful' : $success);



2.19. crmgetDuplicateConfig

(Version >= 4.4)

Syntax:

array | string <err_msg> crmgetDuplicateConfig( array( 'session_id' => string <session_id> ) )

Beschreibung:

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

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

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
	$rest_url    = 'https://<hostname>/<dirname>/rest/index.php/tasks';
	$session_id  = session_id();
	$tasks       = new crm_rest_api($rest_url);
 
	$params  = array('session_id' => $session_id);
	$fields  = $tasks->crmgetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ''.print_r($fields, true).'';



2.20. crmgetPermissions

(Version >= 4.5.17365)

Syntax:

array | string <err_msg> crmgetPermissions( array(string $session_id, 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.

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 {
    include_once 'crm_rest_api.php';
    $rest_url    = 'https://<hostname>/<dirname>/rest/index.php/tasks';
    $session_id  = session_id();
    $tasks       = new crm_rest_api($rest_url);
 
    $params      = array('session_id' => $session_id, 'task_ids' => array(15, 20, 100));
    $permissions = $tasks->crmgetPermissions($params);
 
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
echo '<pre>'.print_r($permissions, true).'</pre>';



2.21. crmsetPermissions

(Version >= 4.5.17365)

Syntax:

array | string <err_msg> crmsetPermissions( 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.

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 {
    include_once 'crm_rest_api.php';
    $rest_url    = 'https://<hostname>/<dirname>/rest/index.php/tasks';
    $session_id  = session_id();
    $tasks       = new crm_rest_api($rest_url);
 
    $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)
			)
		)
	);
 
	$params = array('session_id' => $session_id, 'permissions' => $permissions);
 
	$tasks->crmsetPermissions($params);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
  • No labels