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.

SOAP-Messages Klasse und deren Funktionen können nur mit der TecArt-System Version >= 3.4 genutzt werden

1. WSDL-URI

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

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

2. Methoden

2.1. crmWrite

Syntax:

int crmWrite( string $session_id, int $to, string $message, int $ext_id )

Beschreibung:

Sende eine Nachricht an einen Benutzer.

Gibt 1 beim Erfolg zurück.

to ist der Benutzer-ID, an den die Nachricht gesendet wird.

message ist der Inhalt der Nachricht.

Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 )

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_messages = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=messages&wsdl");
 
   	// Send an message to user with ID 4:
   	$result = $client_messages->crmWrite($session_id, 4, 'This is a test message to user ID 4');
 
   	if ($result == 1) {
		echo 'Message successfully sent';
	}
   	else {
		echo 'Message send failed!';
	}
}
catch (SOAPFault $f) {
  	print $f->faultstring;
}

2.2. crmWriteAll

Syntax:

int crmWriteAll( string $session_id, string $message, int $ext_id )

Beschreibung:

Sende eine Nachricht an alle aktiven Benutzern im System.

Gibt 1 beim Erfolg zurück.

message ist der Inhalt der Nachricht.

Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 )

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
 
	// Send an message to user with ID 4:
   	$result = $client_messages->crmWriteAll($session_id, 'This is a test message to all');
 
   	if ($result == 1) {
		echo 'Message successfully sent';
	}
   	else {
		echo 'Message send failed!';
	}
}
catch (SOAPFault $f) {
  	print $f->faultstring;
}

2.3. crmWriteAdmins

Syntax:

int crmWriteAdmins( string $session_id, string $message, int $ext_id = 0 )

Beschreibung:

Sende eine Nachricht an alle aktiven Admin-Benutzern.

Gibt 1 beim Erfolg zurück.

message ist der Inhalt der Nachricht.

Mittels ext_id kann eine Nachrichten-ID einer externen Anwendung gespeichert werden. Der Parameter ist optional. ( ab Version 4.2 )

Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
 
	// Send an message to user with ID 4:
   	$result = $client_messages->crmWriteAdmins($session_id, 'This is a test message to all admins');
 
   	if ($result == 1) {
		echo 'Message successfully sent';
	}
   	else {
		echo 'Message send failed!';
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}

2.4. crmgetOutgoing

Syntax:

array crmgetOutgoing( array(string $session_id, int $timestamp, int $count, int $offset) )

Beschreibung:

Gibt ein Array mit Nachricht-Objekten zurück, die seit timestamp von dem authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert.

Eigenschaften:

Type(Length)EigenschaftBeschreibung
intuidfromBenutzer-ID des Absenders
intuidtoBenutzer-ID des Empfängers ( der authentifizierter Benutzer )
stringuserfromName des Absenders
stringusertoName des Empfängers ( der authentifizierter Benutzer )
stringmessageInhalt der Nachricht
intext_idExterne ID ( ab Version 4.2 )
intreadUnixtime des gelesen Zeitpunktes
intcreatetimeUnixtime des erstellten Zeitpunktes


Beispiel:

<?php
 
ini_set("soap.wsdl_cache_enabled", "0");
 
try {
	// Get all messages, which sent by authenticated user and since 11.06.2012 - 12:16:21
    $result = $client_messages->crmgetOutgoing( array('session_id' => $session_id, 'timestamp' => 1339409781, 'count' => 0, 'offset' => 0) );
 
	foreach ($result as $message) {
		foreach ($message as $key => $val) {
			echo $key. ' => '. $val;
       }
 
		echo "<br>";
   }
}
catch (SOAPFault $f) {
	print $f->faultstring;
}

2.5. crmgetIncoming

Syntax:

array crmgetIncoming( array(string $session_id, int $timestamp, int $count, int $offset) )

Beschreibung:

Gibt ein Array mit Nachricht-Objekten zurück, die seit timestamp an den authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert.

Eigenschaften:

die selben wie für crmgetOutgoing

Beispiel:

<?php
 
try {
 
	// Get all messages, which sent to authenticated user and since 11.06.2012 - 12:16:21
	$result = $client_messages->crmgetIncoming( array('session_id' => $session_id, 'timestamp' => 1339409781, 'count' => 0, 'offset' => 0) );
 
	foreach ($result as $message) {
		foreach ($message as $key => $val) {
			echo $key. ' => '. $val;
		}
 		echo '<br>';
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}

2.6. crmgetThread

Syntax:

array crmgetThread( array(string $session_id, int $timestamp, int $count, int $offset) )

Beschreibung:

Gibt ein Array mit Nachricht-Objekten zurück, die seit timestamp an oder von dem authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert.

message ist der Inhalt der Nachricht.

crmgetThread ein Array mit Nachricht-Objekten zurück, die seit timestamp an den authentifizierten Benutzer gesendet wurden.

Ergebnis wird von count und offset limitiert.

Eigenschaften:

die selben wie für crmgetOutgoing

Beispiel:

<?php
 
try {
 
	// Get all messages, which sent to or sent from the authenticated user and since 11.06.2012 - 12:16:21
	$result = $client_messages->crmgetThread( array('session_id' => $session_id, 'timestamp' => 1339409781, 'count' => 0, 'offset' => 0) );
 
	foreach ($result as $message) {
		foreach ($message as $key => $val) {
			echo $key. ' => '. $val;
		}
 
    	echo '<br>';
	}
}
catch (SOAPFault $f) {
	print $f->faultstring;
}

2.7. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( string $session_id, string $external_id )

Beschreibung

Liefert interne ID(s) von Nachrichten mit der übergebenen externen ID zurück.

Eigenschaften der zurückgegebenen message Objekte:

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

Beispiel:

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

2.8. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

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

Eigenschaften der zurückgegebenen message Objekte:

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

Beispiel:

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