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

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

2. Methods

2.1. crmAddAccount

(Version >= 4.5.16924)

Syntax:

int crmAddAccount( array( string $session_id, array $crmAccountItem))

Beschreibung:

Erzeugt einen neuen Eintrag im Modul "Accounts". Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

$crmAccountItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $cid                 Kontakt-ID
int               $user                Benutzername
string            $pass                Passwort
string            $site                Referenz-URL
int               $type                Account-Typ (-1 = keine Angabe, 1 = www, 2 = ftp, 3 = E-Mail, 4 = MySQL, 5 = SSH, 6 = VPN, 7 = Sonstige, 8 = Provider)
string            $notes               Notizen
string            $subject             Beschreibung
int               $private             Flag ob ein privater Account vorliegt
string            $secret_question     Sicherheitsfrage
string            $secret_answer       Antwort auf Sicherheitsfrage

Beispiel:

<?php
 
try {
 
   include_once 'crm_rest_api.php';
 
   $client = new crm_rest_api("http://hostname/dirname/rest/index.php/accounts");
 
   $crmAccountItem                    = array();
   $crmAccountItem['cid']             = 1;
   $crmAccountItem['user']            = 'test';
   $crmAccountItem['pass']            = 'test12345';
   $crmAccountItem['site']            = 'example.com';
   $crmAccountItem['type']            = 0;
   $crmAccountItem['notes']           = 'Das ist ein Test-Account!';
   $crmAccountItem['subject']         = 'Test Account 1';
   $crmAccountItem['private']         = 0;
   $crmAccountItem['secret_question'] = '1+2=';
   $crmAccountItem['secret_answer']   = '3';
 
   $id = $client->crmAddAccount(array('session_id' => $session_id, 'crmAccountItem' => $crmAccountItem);
}
catch (CRMException $e) {
  echo $e->getMessage();
}
 
echo "Account id: $id<br>";



2.2. crmChangeAccount

(Version >= 4.5.16924)

Syntax:

int crmChangeAccount( array( string $session_id, int $accountId, array $crmAccountItem))

Beschreibung:

Ändert den Account mit der übergebenen ID. Gibt im Erfolgsfall true zurück.

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

$crmAccountItem kann ein assoziatives Array oder ein Objekt sein, siehe crmAddAccount.

Beispiel:

<?php
 
try {
	$crmAccountItem                    = array();
	$crmAccountItem['secret_answer']   = 'drei';
 
	$success = $client->crmChangeAccount(array('session_id' => $session_id, 'accountId' => $id, 'crmAccountItem' => $crmAccountItem));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo "Success: $success<br>";



2.3. crmGetAccounts

(Version >= 4.5.16924)

Syntax:

array crmGetAccount( array( string $session_id, int $accountId))

Beschreibung:

Gibt die Daten des Accounts mit der übergebenen ID als array zurück.

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

$crmGetAccountResult kann ein assoziatives Array oder ein Objekt sein. 

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $cid                 Kontakt-ID
int               $user                Benutzername
string            $pass                Passwort
string            $site                Referenz-URL
int               $type                Account-Typ (-1 = keine Angabe, 1 = www, 2 = ftp, 3 = E-Mail, 4 = MySQL, 5 = SSH, 6 = VPN, 7 = Sonstige, 8 = Provider)
string            $notes               Notizen
string            $subject             Beschreibung
int               $private             Flag ob ein privater Account vorliegt
string            $secret_question     Sicherheitsfrage
string            $secret_answer       Antwort auf Sicherheitsfrage
int               $chgtime             Zeitpunkt der letzten Änderung
int               $chguser             Benutzer-ID der letzten Änderung
int               $createtime          Zeitpunkt der Erstellung
int               $createuser          Benutzer-ID der Erstellung

Beispiel:

<?php
 
try {
	$crmGetAccountResult = $client->crmGetAccounts(array('session_id' => $session_id, 'accountId' => $id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($crmGetAccountResult as $key => $value) {
	echo "{$key}: {$value}<br>  ";
}

2.4. crmGetAccounts

(Version >= 4.5.16924)

Syntax:

array crmGetAccounts( array( string $session_id, string $search, int $type, int $count, int $offset, $sorting))

Beschreibung:

Gibt ein Array mit Accounts zurück, für die der Benutzer Leseberechtigungen hat und den optionalen Suchparametern entsprechen.

$search Suchbegriff, nach dem zusätzlich gefiltert werden soll (optional, Default = "" )

$type Account-Type, nach dem gefiltert werden soll (optional, Default = -1)

$count maximale Anzahl an Elementen, welche zurückgegeben werden sollen (optional, Default = 5000)

$offset Anzahl-Offset (optional, Default = 0)

$sorting Sortiert-Reihenfolge der Rückgabe (optional, Default = )

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

Die zurückgegebenen Werte entsprechend denen von crmGetAccounts

Beispiel:

<?php
 
try {
	$crmAccountItem = $client->crmGetAccounts(array('session_id' => $session_id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($crmAccountItem as $crmGetAccountResult) {
 
    foreach($crmAccountItem as $key => $value) {
         echo "{$key}: {$value}<br>";
    }
}

2.5. crmDeleteAccount

(Version >= 4.5.16924)

Syntax:

int crmDeleteAccount( array( string $session_id, int $accountId))

Beschreibung:

Löscht den Accounts mit der übergebenen ID.

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

Beispiel:

<?php
 
try {
	$crmAccountItem = $client->crmDeleteAccount(array('session_id' => $session_id, 'accountId' => $id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo "Success: $success<br>";
  • No labels