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

API Klassen und deren Funktionen können nur mit TecArt-System Version >= 3.2 genutzt werden

Diese API-Klasse ist ab Version v4.5 verfügbar

Für die Benutzung benötigen Sie Zugriff auf folgende Module:

  • Accounts

1. Methoden

1.1. addAccount

(Version >= v4.5.16924)

Syntax:

int addAccount(array $account)

Beschreibung:

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

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$account: Account-Daten

Rückgabe:

ID des neuen Datensatzes

Eigenschaften von $account:


TypeEigenschaftBeschreibung
int$cidKontakt-ID
int$userBenutzername
string$passPasswort
string$siteReferenz-URL
int$typeAccount-Typ (-1 = keine Angabe, 1 = www, 2 = ftp, 3 = E-Mail, 4 = MySQL, 5 = SSH, 6 = VPN, 7 = Sonstige, 8 = Provider)
string$notesNotizen
string$subjectBeschreibung
int$privateFlag ob ein privater Account vorliegt
string$secret_questionSicherheitsfrage
string$secret_answerAntwort auf Sicherheitsfrage


Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
	//Bitte hier Ihre Zugangsdaten eintragen
	crmapi::logon()->Login('root', 'root');
} 
catch (CRMException $e) {
	die($e->getMessage());
}
 
try {
	$api = crmapi::accounts();
	$account                    = array();
	$account['cid']             = 1;
	$account['user']            = 'test';
	$account['pass']            = 'test12345';
	$account['site']            = 'example.com';
	$account['type']            = 0;
	$account['notes']           = 'Das ist ein Test-Account!';
	$account['subject']         = 'Test Account 1';
	$account['private']         = 0;
	$account['secret_answer']   = '3';
	$account['secret_question'] = '1+2=';
	$id = $api->addAccount($account);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
echo "Account id: $id<br>";



1.2. changeAccount

(Version >= v4.5.16924)

Syntax:

boolean changeAccount(int $account_id, array $account)

Beschreibung:

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

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$account_id: ID des Accounts

$account: Account-Daten, Siehe addAccount

Rückgabe:

True, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
	//Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
} 
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api = crmapi::accounts();
	$account                    = array();
	$account['secret_answer']   = 'drei';
	$success = $api->changeAccount($id, $account);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
echo "Success: $success<br>";



1.3. deleteAccount

(Version >= v4.5.16924)

Syntax:

bool deleteAccount(int $account_id)

Beschreibung:

Löscht den Account mit der übergebenen ID.

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$account_id: Account-ID

Rückgabe:

True, wenn erfolgreich, sonst false

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api		= crmapi::accounts();
	$success	= $api->deleteAccount($id);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
echo "Success: $success<br>";



1.4. getAccount

(Version >= v4.5.16924)

Syntax:

array getAccount(int $account_id)

Beschreibung:

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

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$account_id: ID des Accounts

Rückgabe:

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_answer       Antwort auf Sicherheitsfrage
string            $secret_question     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
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
    $api		= crmapi::accounts();
    $account	= $api->getAccount($id);
}
catch (CRMException $e) {
    echo $e->getMessage();
}
foreach($account as $key => $value) {
    echo "{$key}: {$value}<br>  ";
}



1.5. getAccounts

(Version >= v4.5.16924)

Syntax:

array getAccounts(string $search = '', int $type = -1, int $count = 5000, int $offset = 0, string $sorting = '')

Beschreibung:

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

Im Fehlerfall wird eine CRMException geworfen.

Parameter:

$search: Suchwort, nach dem gefiltert werden soll

$type: Account-Typ, nach dem gefiltert gefiltert werden soll

$count: Maximale Anzahl an Elementen in den Rückgabe-Daten

$offset: Offset

$sorting: Sortierung der Rückgabe-Daten

Rückgabe:

Die zurückgegebenen Werte entsprechend denen von getAccount

Beispiel:

<?php
 
require_once '/var/www/crm/class/api/crmapi.php';
 
try {
    //Bitte hier Ihre Zugangsdaten eintragen
    crmapi::logon()->Login('root', 'root');
}
catch (CRMException $e) {
    die($e->getMessage());
}
 
try {
	$api		= crmapi::accounts();
	$account	= $api->getAccounts();
}
catch (CRMException $e) {
    echo $e->getMessage();
}
foreach($account as $id => $account) {
	echo "Account-ID: {$id}";
	foreach($account as $key => $value) {
		echo "{$key}: {$value}<br>";
	}
}



2. Weitere Informationen

  • No labels