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.



1. WSDL-URI

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

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

2. Methods

2.1. crmAddAccount

(Version >= 4.5.16924)

Syntax:

int crmAddAccount( 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 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:

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 = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=admonitions&wsdl");
 
    $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($session_id, $crmAccountItem);
}
catch (SOAPFault $f) {
    print $f->faultstring;
}
 
echo "Account id: $id<br>";




2.2. crmChangeAccount

(Version >= 4.5.16924)

Syntax:

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

Beschreibung:

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

Im Falle eines Fehlers wird eine CRMException mit Fehlerdetails geworfen.

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

Beispiel:

try {
    $crmAccountItem                    = array();
    $crmAccountItem['secret_answer']   = 'drei';
 
    $success = $client->crmChangeAccount($session_id, $id, $crmAccountItem);
}
catch (SOAPFault $f) {
    print $f->faultstring;
}
 
echo "Success: $success<br>";
 



2.3. crmGetAccount

(Version >= 4.5.16924)

Syntax:

array crmGetAccount( string $session_id, int $account_id)

Beschreibung:

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

Im Falle eines Fehlers wird eine CRMException mit Fehlerdetails geworfen.

$crmGetAccountResult kann ein assoziatives Array oder ein Objekt sein. siehe crmGetAccounts

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:

try {
    $crmGetAccountResult = $client->crmGetAccounts($session_id, $id);
}
catch (SOAPFault $f) {
    print $f->faultstring;
}
 
foreach($crmGetAccountResult[0] as $key => $value) {
    echo "{$key}: {$value}<br>  ";
}



2.4. crmGetAccounts

(Version >= 4.5.16924)

Syntax:

array crmGetAccounts(string $session_id, $crmSearchEntriesItems)

Beschreibung:

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

$crmSearchEntriesItems ist ein Array oder Objekt mit zusätzlichen Suchparametern:

  • $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 Fehlerdetails geworfen.

Die zurückgegebenen Werte entsprechend denen von crmGetAccount

Beispiel:

try {
    $crmAccountItems = $client->crmGetAccounts($session_id);
}
catch (SOAPFault $f) {
    print $f->faultstring;
}
 
foreach($crmAccountItems as $crmGetAccountResult) {
    foreach($crmAccountItem[0] as $key => $value) {
        echo "{$key}: {$value}<br>";
    }
}



2.5. crmDeleteAccount

(Version >= 4.5.16924)

Syntax:

int crmDeleteAccount(string $session_id, int $account_id)

Beschreibung:

Löscht den Accounts mit der übergebenen ID.

Im Falle eines Fehlers wird eine CRMException mit Fehlerdetails geworfen.

Beispiel:

try {
    $crmAccountItem = $client->crmDeleteAccount($session_id, $id);
}
catch (SOAPFault $f) {
    print $f->faultstring;
}
 
echo "Success: $success<br>";
  • No labels