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.


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

1. Aufruf URL

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

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

2. Methoden

2.1. crmWrite

Syntax:

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

Beschreibung:

Sende eine Nachricht an einen Benutzer.

Gibt true 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
 
try {
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	// Send an message to user with ID 4:
	$result = $messages->crmWrite(
		array(
			'session_id'	=> $session_id,
			'to'			=> 4,
			'message'		=> 'This is a test message to user ID 4'
		)
	);
 
	if ($result) {
		echo 'Message successfully sent';
	}
	else {
		echo 'Message send failed!';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.2. crmWriteAll

Syntax:

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

Beschreibung:

Sende eine Nachricht an alle aktiven Benutzern im System.

Gibt true 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
 
try {
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	$result = $messages->crmWriteAll(
		array(
			'session_id'	=> $session_id,
			'message'		=> 'This is a test message to all'
		)
	);
 
	if ($result) {
		echo 'Message successfully sent';
	}
	else {
		echo 'Message send failed!';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.3. crmWriteAdmins

Syntax:

boolen crmWriteAdmins( array( string $session_id, string $message, int $ext_id) )

Beschreibung:

Sende eine Nachricht an alle aktiven Admin-Benutzern.

Gibt true 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
 
try { 
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	$result = $messages->crmWriteAdmins(
		array(
			'session_id'	=> $session_id,
			'message'		=> 'This is a test message to all admins'
		)
	);
 
	if ($result) {
		echo 'Message successfully sent';
	}
	else {
		echo 'Message send failed!';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



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
 
try { 
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	// Get all messages, which sent by authenticated user and since 11.06.2012 - 12:16:21
	$result = $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 .'<br>';
		}
 		echo '<br><br>';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



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 { 
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	// Get all messages, which sent to authenticated user and since 11.06.2012 - 12:16:21
	$result = $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 .'<br>';
		}
 		echo '<br><br>';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



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.

Eigenschaften:

die selben wie für crmgetOutgoing

Beispiel:

<?php
 
try { 
	include_once 'crm_rest_api.php';
 
	$messages = new crm_rest_api("http://hostname/dirname/rest/index.php/messages");
 
	// Get all messages, which sent to or sent from the authenticated user and since 11.06.2012 - 12:16:21
	$result = $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 .'<br>';
		}
 		echo '<br><br>';
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



2.7. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( array( string $session_id, int $ext_id ) )

Beschreibung

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

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

Beispiel:

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



2.8. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( array ( string $session_id ) )

Beschreibung

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

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

Beispiel:

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