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/bookmarks

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

2. Klasse

crmbookmarks

3. Methoden

3.1. crmcreateFolder

Syntax:

int crmcreateFolder( array(string $session_id, string $name, int $parent, int $userid, int $ext_id) )

Beschreibung:

Erstellt einen neuen Lesezeichen-Ordner. Gibt eine Ordner-ID für Erfolg oder 0 für einen Fehlschlag zurück.

$name - Angezeigter Name des Ordners

$parent - ID des übergeordneten Ordners. - Für höchste Ebene auf 0 setzen

$userid (optional, -1 wenn nicht genutzt) - ID des Benutzers, für den der Ordner angelegt werden soll - Zum deaktivieren auf -1 setzen - Für globale Ordner auf 0 setzen

$ext_id (optional, 0 wenn nicht genutzt, ab Version 4.2) - ID einer externen Anwendung

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params		= array('session_id' => $session_id, 'name' => 'Testfolder', 'parent' => 0, 'userid' => $userid);
	$folderid	= $bookmarks->crmcreateFolder($params);
 
	echo $folderid;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.2. crmgetFolder

Syntax:

int|array crmgetFolder( array( string $session_id, int $id) )

Beschreibung:

Gibt ein Array mit dem Lesezeichen-Ordner mit der ID $id bei Erfolg oder 0 für einen Fehlschlag zurück.

$id - Ordner-ID

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params = array('session_id' => $session_id, 'id' => $folder_id);
	$folder = $bookmarks->crmgetFolder($params);
 
	foreach($folder as $k => $v) {
		echo "$k => $v";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.3. crmmoveFolder

Syntax:

int crmmoveFolder( array( string $session_id, int $id, int $parent) )

Beschreibung:

Verschiebt einen Lesezeichen-Ordner. Gibt 1 für Erfolg oder 0 für einen Fehlschlag zurück.

$id - ID des Ordners

$parent - ID des neuen übergeordneten Ordners - Für höchste Ebene auf 0 setzen

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params  = array('session_id' => $session_id, 'id' => 23, 'parent' => 0);
	$success = $bookmarks->crmmoveFolder($params);
 
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.4. crmrenameFolder

Syntax:

int crmrenameFolder( array( string $session_id, int $id, string $name) )

Beschreibung:

Benennt einen Lesezeichen-Ordner um. Gibt 1 für Erfolg oder 0 für einen Fehlschlag zurück.

$id - ID des Ordners

$name - Neuer Name des Ordners

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params = array('session_id' => $session_id, 'id' => 12, 'name' => 'Changed folder');
	$success = $bookmarks->crmrenameFolder($params);
 
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.5. crmremoveFolder

Syntax:

int crmremoveFolder( array( string $session_id, int $id) )

Beschreibung:

Löscht einen Lesezeichen-Ordner. Gibt 1 für Erfolg oder 0 für einen Fehlschlag zurück.

$id - ID des Ordners

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params = array('session_id' => $session_id, 'id' => 21);
	$success = $bookmarks->crmremoveFolder($params);
 
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.6. crmcreateBookmark

Syntax:

int crmcreateBookmark( array( string $session_id, string $name, string $address, int $tree_id, int $userid, int $ext_id) )

Beschreibung:

Erstellt einen neues Lesezeichen. Gibt eine Lesezeichen-ID für Erfolg oder 0 für einen Fehlschlag zurück.

$name - Angezeigter Name des Lesezeichens

$address - URL des Lesezeichens

$tree_id - ID des übergeordneten Ordners. - Für höchste Ebene auf 0 setzen

$userid (optional, -1 wenn nicht genutzt) - ID des Benutzers, für den das Lesezeichen angelegt werden soll - Zum deaktivieren auf -1 setzen - Für globale Lesezeichen auf 0 setzen

$ext_id (optional, 0 wenn nicht genutzt, ab Version 4.2) - ID einer externen Anwendung

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params		= array(
		'session_id'	=> $session_id,
		'name'			=> 'Test bookmark',
		'address'		=> 'http://www.example.com',
		'tree_id'		=> 0,
		'userid'		=> $userid
	);
	$bookmarkid	= $bookmarks->crmcreateBookmark($params);
 
	echo $bookmarkid;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.7. crmgetBookmark

Syntax:

int crmgetBookmark( array( string $session_id, int $id) )

Beschreibung:

Erstellt einen neuen Lesezeichen-Ordner. Gibt eine Ordner-ID für Erfolg oder 0 für einen Fehlschlag zurück.

$id - ID des Lesezeichens

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	$params   = array('session_id' => $session_id, 'id' => 52);
	$bookmark = $bookmarks->crmcreateFolder($params);
 
	foreach ($bookmark as $k => $v) {
		echo "$k => $v";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.8. crmgetUserBookmarks

Syntax:

int crmgetUserBookmarks( array( string $session_id, int $userid) )

Beschreibung:

Gibt ein Array mit allen Lesezeichen des Nutzers bei Erfolg oder 0 für einen Fehlschlag zurück.

$userid (optional, -1 wenn nicht genutzt) - ID des Benutzers, für den der Ordner angelegt werden soll - Zum deaktivieren auf -1 setzen

Beispiel:

<?php
 
try {
 
	include_once 'crm_rest_api.php';
 
	$bookmarks	= new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
	$params		= array('session_id' => $session_id, 'userid' => $userid);
	$bookmarks	= $bookmarks->crmgetUserBookmarks($params);
 
	foreach ($bookmarks as $id => $bookmark) {
		foreach ($bookmark as $k => $v) {
			echo "$k => $v";
		}
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.9. crmgetUserBookmarkTree

Syntax:

int crmgetUserBookmarkTree( array( string $session_id, int $userid) )

Beschreibung:

Erstellt einen neuen Lesezeichen-Ordner. Gibt eine Ordner-ID für Erfolg oder 0 für einen Fehlschlag zurück.

$name - Angezeigter Name des Ordners

$parent - ID des übergeordneten Ordners. - Für höchste Ebene auf 0 setzen

$userid (optional, -1 wenn nicht genutzt) - ID des Benutzers, für den der Ordner angelegt werden soll - Zum deaktivieren auf -1 setzen - Für globale Ordner auf 0 setzen

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks	= new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
	$params		= array('session_id' => $session_id, 'name' => 'Testfolder', 'parent' => 0, 'userid' => $userid);
	$folderid	= $bookmarks->crmcreateFolder($params);
 
	echo $folderid;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.10. crmchangeBookmark

Syntax:

int crmchangeBookmark( array( string $session_id, int $id, string $name, int $address, int $tree_id, int $ext_id) )

Beschreibung:

Ändert ein Lesezeichen. Gibt 1 für Erfolg oder 0 für einen Fehlschlag zurück.

Mindestens eine der optionalen Optionen $name, $address und $tree_id muss gesetzt sein.

$id - ID des Lesezeichens

$name (optional, leerer String wenn nicht verändert) - Angezeigter Name des Lesezeichens

$address (optional, leerer String wenn nicht verändert) - URL des Lesezeichens

$tree_id (optional, leerer String wenn nicht verändert) - ID des übergeordneten Ordners. - Für höchste Ebene auf 0 setzen

$ext_id (optional, 0 wenn nicht genutzt, ab Version 4.2) - ID einer externen Anwendung

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks = new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
 
	// Only changes the name - address and tree_id are set to empty strings
	$params		= array(
		'session_id'	=> $session_id,
		'name'			=> 'Changed bookmark',
		'address'		=> '',
		'tree_id'		=> ''
	);
	$success	= $bookmarks->crmcreateFolder($params);
 
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}


3.11. crmremoveBookmark

Syntax:

int crmremoveBookmark( array( string $session_id, int $id) )

Beschreibung:

Löscht ein Lesezeichen. Gibt 1 für Erfolg oder 0 für einen Fehlschlag zurück.

$id - ID des Lesezeichens

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$bookmarks	= new crm_rest_api("http://hostname/dirname/rest/index.php/bookmarks");
	$params		= array('session_id' => $session_id, 'id' => 37);
	$success	= $bookmarks->crmcreateFolder($params);
 
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.12. crmgetBookmarkIdByExtId

(Version >= 4.2)

Syntax:

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

Beschreibung

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

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

Beispiel:

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



3.13. crmgetAllBookmarkExtIds

(Version >= 4.2)

Syntax:

array crmgetAllBookmarkExtIds( array ( string $session_id ) )

Beschreibung

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

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

Beispiel:

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



3.14. crmgetBookmarkFolderIdByExtId

(Version >= 4.2)

Syntax:

array crmgetBookmarkFolderIdByExtId( array( string $session_id, int $ext_id, int $user_id ) )

Beschreibung

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

$user_id enthält die ID des Benutzers, für den die Informationen abgerufen werden sollen. (0 wenn nicht gesetzt)

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

Beispiel:

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


3.15. crmgetAllBookmarkFolderExtIds

(Version >= 4.2)

Syntax:

array crmgetAllBookmarkFolderExtIds( array ( string $session_id, int $user_id ) )

Beschreibung

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

$user_id enthält die ID des Benutzers, für den die Informationen abgerufen werden sollen. (0 wenn nicht gesetzt)

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

Beispiel:

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