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

Bitte beachten Sie, dass seit TecArt Version 4.10 und aufwärts der SOAP Webservice nicht mehr weiterentwickelt wird. Ab der TecArt Version 5.1 ist der SOAP Webservice nicht mehr unterstützt.

Please note: with the release of TecArt version 4.10 onwards SOAP Webservice will no longer be updated or expanded. With the release of TecArt version 5.1, the soap webservice will be deprecated.

1. WSDL-URI

http://hostname/dirname/soap/index.php?op=tasks&wsdl

z.B. https://test.tecart-system.de/soap/index.php?op=tasks&wsdl

2. Methoden

2.1. crmgetTasks

Syntax:

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

Beschreibung:

Gibt ein Array von Task-Objekten zurück.

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

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

Wenn Jahr 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;...
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                   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                   $crmUserConfirmedElements Array mit crmUserConfirmedElement Objekte - Nutzer und deren Bestätigungsstatus
array                   $crmUserDoneElements      Array mit crmUserDoneElement Objekte - Nutzer und deren Erledigt-Status
array                   $crmUserStatusElements    Array mit crmUserStatusElement Objekte - Nutzer und deren Status
array                   $crmUserAchievedElements  Array mit crmUserAchievedElement Objekte - Nutzer und deren geleistete Stunden
array                   $crmUserPlannedElements   Array mit crmUserPlannedElement Objekte - Nutzer und deren geplante Stunden
array                   $crmUserBodyElements      Array mit crmUserBodyElement Objekte - Nutzer und deren Notizen
array                   $crmUserChgtimeElements   Array mit crmUserChgtimeElement Objekte - Nutzer und deren Zeit der letzen Änderung
array                   $crmTaskContacts          Array mit crmTaskContact 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 crmUserConfirmedElement:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
int                     $confirmed                Aufgabe bestätigt
                                                  0 = nicht bestätigt
                                                  1 = bestätigt

Eigenschaften von crmUserDoneElement:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
int                     $done                     erledigt in Prozent (0-100)

Eigenschaften von crmUserStatusElement:

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

Eigenschaften von crmUserAchievedElement:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
double                  $achieved                 geleistete Stunden

Eigenschaften von crmUserPlannedElement:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
double                  $planned                  geplante Stunden

Eigenschaften von crmUserBodyElement:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $userid                   Userid 
string(65535)           $body                     Text des Nutzers

Eigenschaften von crmUserChgtimeElement:

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

Eigenschaften von crmTaskContact:

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
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id		= $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
 
	$client_tasks	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
	$result			= $client_tasks->crmgetTasks($session_id, 0, 3, 2007);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->crmUserConfirmedElements)) {
			echo "Task confirmed by: ";    
 
			foreach($task->crmUserConfirmedElements as $confirmed) 
				if ($confirmed->confirmed) echo $confirmed->userid."; ";
			}
			echo "<br>\n";
		}
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}



2.2. crmgetTask

(Version >= 3.4.5404)

Syntax:

array crmgetTask( string $session_id, int $task_id )

Beschreibung:

Gibt ein Array mit einem Task-Objekt anhand einer ID zurück.

Eigenschaften der zurückgegebenen task Objekte: sind die selben wie für crmgetTasks

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id		= $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
	
	$client_tasks	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
	$result			= $client_tasks->crmgetTask($session_id, 7);
 
	foreach($result as $task) {
 
		echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>";
 
		if (count($task->crmUserConfirmedElements)) {
			echo "Task confirmed by: ";    
 
			foreach($task->crmUserConfirmedElements as $confirmed) 
				if ($confirmed->confirmed) echo $confirmed->userid."; ";
			}
			echo "<br>\n";
		}
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}



2.3. crmgetTasksFrom

Syntax:

array crmgetTasksFrom( 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.

Wennmonthgesetzt ist, werden nur Aufgaben dieses Monats zurückgegeben. Setzen Sie ihn auf 0, um alle Monate zurückzubekommen.

WennJahrgesetzt 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


2.4. crmgetChangedTasks

Syntax:

array crmgetChangedTasks( 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
 
$result = $client_tasks->crmgetChangedTasks($session_id, 0, 1174929104);
 
foreach($result as $task) {
   
	echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>  ";
   
	if (count($task->crmUserConfirmedElements)) {
		echo "Task confirmed by: ";    
   
		foreach($task->crmUserConfirmedElements as $confirmed) 
			if ($confirmed->confirmed) echo $confirmed->userid."; ";
		}
		echo "<br>  \n";
	}
}



2.5. crmgetChangedTasksLimit

(Version >= 3.0.1549)

Syntax:

array crmgetChangedTasksLimit( 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
 
$result = $client_tasks->crmgetChangedTasksLimit($session_id, 0, 1174929104, 10, 15);
 
foreach($result as $task) {
   
	echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>  ";
   
	if (count($task->crmUserConfirmedElements)) {
		echo "Task confirmed by: ";    
   
		foreach($task->crmUserConfirmedElements as $confirmed) 
			if ($confirmed->confirmed) echo $confirmed->userid."; ";
		}
		echo "<br>  \n";
	}
}



2.6. crmaddTask

Syntax:

int crmaddTask( string $session_id, crmTaskItem $crmTaskItem )

Beschreibung:

Gibt eine task_id bei Erfolg, 0 bei einem Fehler, -1, wenn die Aufgabe existiert.

crmTaskItem kann ein assoziatives Array oder ein Objekt sein.

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

Eigenschaften von crmTaskItem:

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;...
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 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                   $crmTaskItemContacts      Array mit crmTaskItemContact-Objekten

Eigenschaften von crmTaskItemContact:

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

<?php
 
$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,
	'obligingness' => 0
);
 
$task_id = $client_tasks->crmaddTask($session_id, $task);
echo $task_id."<br>\n";


Beispiel 2:

<?php
 
class task
{
	public $start   = 0;
	public $stop    = 0;
	public $subject = //;//
	public $done    = 0;
   
	function __construct($subject)
	{
		$this->subject = $subject;
		$this->start   = time();
	}
}
 
$task = new task('WebServiceTest');
 
$task_id = $client_tasks->crmaddTask($session_id, $task);
echo $task_id."<br>\n";



2.7. crmaddTasks

Syntax:

boolean crmaddTasks( string $session_id, crmTasksItems $crmTasksItems )

Beschreibung:

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

Liefert 1 bei Erfolg.

Eigenschaften von crmTasksItems:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
crmTaskItems            $crmTaskItems             array mit crmTaskItem-Objekten

Beispiel 1:

<?php
 
$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,
	'obligingness' => 0
);
 
$tasks		= array('crmTaskItems' => array($task1, $task2));
$success	= $client_tasks->crmaddTasks($session_id, $tasks);

if ($success === false) {
	echo "Error adding tasks.";
}
 



2.8. crmchangeTask

Syntax:

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

Beschreibung:

Ändert Eigenschaften einer bestehenden Aufgabe.

Liefert die task_id bei Erfolg zurück.

crmTaskItem kann ein assoziatives Array oder ein Objekt sein

Properties: sind die selben wie für crmaddTask

Beispiel:

<?php
 
$task['subject'] = 'WebService Task changed';
 
$task_id = $client_tasks->crmchangeTask($session_id, $task_id, $task);
 
echo $task_id."<br>\n";



2.9. crmchangeTasks

Syntax:

boolean crmchangeTasks( string $session_id, crmTasksItems $crmTasksItems )

Beschreibung:

Ändert Eigenschaften vorhandener Aufgaben.

Liefert 1 bei Erfolg zurück.

Properties: sind die selben wie für crmaddTasks

Beispiel:

<?php
 
$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'
);
 
$tasks   = array('crmTaskItems' => array($task1, $task2));
$success = $client_tasks->crmchangeTasks($session_id, $tasks);

if ($success === false) {
	echo "Error changing tasks"; 
}



2.10. crmdeleteTask

Syntax:

boolean crmdeleteTask( string $session_id, int $task_id )

Beschreibung:

Löscht eine Aufgabe. Liefert 1 bei Erfolg, 0 im Fehlerfall.

Beispiel:

<?php
 
$success = $client_tasks->crmdeleteTask($session_id, $task_id);
if (!$success) {
	echo "Unable to delete task.";
}



2.11. crmdeleteTasks

Syntax:

boolean crmdeleteTasks( string $session_id, string $task_ids )

Beschreibung:

Löscht Aufgaben. Liefert 1 bei Erfolg, 0 im Fehlerfall.

task_ids ist eine Doppelpunkt-getrennte Zeichenfolge mit den Aufgaben-IDs.

Beispiel:

<?php
 
$success = $client_tasks->crmdeleteTasks($session_id, '23432:44533:35223');
if (!$success) {
	echo "Error deleting tasks.";
}



2.12. crmgetTaskIds

Syntax:

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

Beschreibung:

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

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

Eigenschaften der zurückgegebenen task Objekte:

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

Beispiel:

<?php
 
$result = $client_tasks->crmgetTaskIds($session_id, 0, 1174929104);
 
foreach($result as $task) {
	echo $task->id."<br>  ";
}



2.13. crmgetTaskIdsString

(Version >= 3.0.1549)

Syntax:

string crmgetTaskIdsString( string $session_id, int $userid, int $timestamp )

Beschreibung:

Gibt eine Liste mit Aufgaben-IDs, die seit timestamp geändert wurden als Doppelpunkt-getrennte Zeichenfolge zurück.

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

Beispiel:

<?php
 
$result = $client_tasks->crmgetTaskIdsString($session_id, 0, 1174929104);
 
$task_ids = explode(":", $result); 
 
foreach($task_ids as $task_id) {
	echo $task_id."<br>  ";
}



2.14. crmsetReadFlag

(Version >= 3.4.5404)

Syntax:

string crmsetReadFlag( 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
 
// Set 'unread' for Task mit ID = 7
$result = $client_tasks->crmsetReadFlag($session_id, 7, 0);
 
if ($result == 1) {
	echo 'Success';
}



2.15. crmgetChangedTasksList

(Version >= 3.4.5404)

Syntax:

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

Beschreibung:

Gibt ein Array mit List von Task-Objekten vom einem User, die seit timestamp geändert wurden.

Wenn userid gegeben ist, werden Termine für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn userid auf 0 gesetzt wird, werden alle Termine für den authentifizierten Nutzer zurückgegeben.

timestamp ist Unix-Time.

Eigenschaften der zurückgegebenen Objekte:

Type(Length) Eigenschaft Beschreibung


int $id Termin-Id int $chgtime Änderungzeit (Unix-Timestamp) int $useen Ob der authentifizierte Benutzer, die Aufgabe gesehen hat.

                                                1: ja
                                                0: nein

int $status Status

                                                1 = nicht begonnen
                                                2 = in Bearbeitung
                                                3 = erledigt
                                                4 = Wartet auf jemand anderen
                                                5 = zurückgestellt

Beispiel:

<?php
 
//Get all tasks of user with ID = 4, which have changed since  29.11.2011 00:00:00 
$result = $client_tasks->crmgetChangedTasksList($session_id, 4, 1322521200);
 
foreach($result as $task) {
   
	$chgtime  = date("d.m.Y - H:i:s", $task->chgtime);
 
	echo "{$task->id} - {$chgtime} {$task->useen}<br>";
}



2.16. crmsearchTasks

(Version >= 3.5)

Syntax:

array crmsearchTasks( string $session_id, crmsearchTasksItem $crmsearchTasksItem )

Beschreibung

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

Eigenschaften der crmsearchTasksItem 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 der zurückgegebenen task Objekte:

sind die selben wie für crmgetTasks

Beispiel:

<?php
 
// Search for tasks with subject LIKE '%Test SOAP API%'
$crmsearchTasksItem = array('Test SOAP API');
 
$result = $client_tasks->crmsearchTasks($session_id, $crmsearchTasksItem);
 
foreach($result as $task) {
   
	echo $task->subject." - mature at: ".date("Y-m-d", $task->stop)."<br>  ";
   
	if (count($task->crmUserConfirmedElements)) {
		echo "Task confirmed by: ";    
   
		foreach($task->crmUserConfirmedElements as $confirmed) 
			if ($confirmed->confirmed) echo $confirmed->userid."; ";
		}
		echo "<br>  \n";
	}
}



2.17. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( 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.

Eigenschaften der zurückgegebenen task Objekte:

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

Beispiel:

<?php
 
try {
	$result = $client_tasks->crmgetIdByExtId($session_id, 12345);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



2.18. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

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

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

Eigenschaften der zurückgegebenen task Objekte:

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

Beispiel:

<?php
 
try { 
	$result = $client_tasks->crmgetAllExtIds($session_id);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



2.19. crmsetDuplicateConfig

(Version >= 4.4)

Syntax:

int | string <errormessage> crmDuplicateConfig( string $session_id, crmDuplicatecheckFields $crmDuplicatecheckFields )

Beschreibung:

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

Eigenschaften des zu übergebenden crmDuplicatecheckFields Objektes:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
string			        $fields			     implodiertes Array ( implode(',', $myFields) ) mit gewünschten Feldern, 
						                     auf die eine Dublettenprüfung angewendet werden soll;
						                     wenn Eigenschaft auf NULL gesetzt wird, wird Override zurückgesetzt

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id		= $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
 
	$client_tasks = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
 
	$fields  = array('fields' => implode(',', array('body', 'subject')) );
	$success = $client_tasks->crmsetDuplicateConfig($session_id, $fields);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
 
echo ($success == 1 ? 'override successful' : $success);



2.20. crmgetDuplicateConfig

(Version >= 4.4)

Syntax:

string crmgetDuplicateConfig( string $session_id )

Beschreibung:

Gibt implodiertes Array als Zeichenkette 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
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	$client_logon	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$session_id		= $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
 
	$client_tasks	= new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
	$fields			= $client_tasks->crmgetDuplicateConfig($session_id);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
 
$fields = explode(',', $fields);
echo print_r($fields, true);



2.21. crmgetPermissions

(Version >= 4.5.17365)

Syntax:

array crmgetPermissions( string $session_id, string $task_ids ) 

Beschreibung:

Gibt ein Array mit Elementen des Typs crmPermission 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.

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

task_ids ist eine mit Doppelpunkt getrennte Liste der IDs der Aufgaben.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            Task ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

Beispiel:

<?php
  
ini_set("soap.wsdl_cache_enabled", "0");
  
try {
	$client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$client_tasks = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
	$session_id   = $client_logon->crmLogin('test', 'test');
  
	if (!$session_id) {
		die("invalid login");
	}
  
	$result = $client_tasks->crmgetPermissions($session_id, '81941:79331');
   
	print_r($result);
}
catch (SOAPFault $f) {
	print $f->faultstring;
}



2.22. crmsetPermissions

(Version >= 4.5.17365)

Syntax:

array crmsetPermissions( string $session_id, array $crmPermissions ) 

Beschreibung:

Setzt die Berechtigungen für mehrere Aufgaben.

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

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

crmPermissions ist ein Array mit crmPermission Objekten.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            Task ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

Beispiel:

<?php
  
ini_set("soap.wsdl_cache_enabled", "0");
  
try {
	$client_logon = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl");
	$client_tasks = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=tasks&wsdl");
	$session_id   = $client_logon->crmLogin('test', 'test');
  
	if (!$session_id) {
		die("invalid login");
	}
  
    $permissions = array(
		array(
			'id'							=> 81941, 
			'crmUserPermissionElements' 	=> array(array('id' => 56, 'read' =>  1, 'write' =>  1, 'delete' =>  1)),
            'crmGroupPermissionElements'	=> array(array('id' => 4,  'read' => -1, 'write' => -1, 'delete' => -1))
		),
        array(
			'id' 							=> 79331, 
			'crmGroupPermissionElements'	=> array(
				array(
					'id'		=> 4,
					'read'		=>  1,
					'write'		=>  1,
					'delete'	=>  1
				), 
                array(
					'id'		=> 6,
					'read'		=> -1,
					'write'		=> -1,
					'delete'	=> -1
				)
			)
		)
	);
 
    $client_tasks->crmsetPermissions($session_id, array('crmPermissions' => $permissions));
}
catch (SOAPFault $f) {
	print $f->faultstring;
}
  • No labels