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=admonitions&wsdl

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

2. Methods

2.1. crmAddAdmonition

(Version >= 4.1.10682)

Syntax:

int crmAddAdmonition( string $session_id, $crmAdmonitionItem)

Beschreibung:

Erzeugt eine neue Mahnung. Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

crmAdmonitionItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		          $cid			        Kontakt-ID
int		          $client_account_id	Rechnungskonto-ID
int               $ext_id               Externe ID ( ab Version 4.2 )
string		      $realnumber		    Belegnummer
string		      $realnumber_activity	Belegnummer-ID
double		      $amount		        Betrag
string		      $posting_account_in	Buchungskonto eingehend
string		      $posting_account_out	Buchungskonto ausgehend
int		          $date			        Datum
string		      $text			        Buchungstext
string		      $reference_text_1	    Referenztext 1
string		      $reference_text_2	    Referenztext 1
string		      $notes		        Notizen
int		          $reversed		        aufgehoben
int		          $accounted		    entfallen
string		      $ust_id		        Ust-ID
string		      $billing_postcode	    Rechnung: PLZ
string		      $billing_city		    Rechnung: Ort
string		      $billing_name_1	    Rechnung: Name 1
string		      $billing_name_2	    Rechnung: Name 2
string		      $billing_name_3	    Rechnung: Name 3
string		      $billing_address_1	Rechnung: Adresse 1
string		      $billing_address_2	Rechnung: Adresse 2

string      	  $user26               Benutzerdefiniertes Feld Nr. 26
string            $user27               Benutzerdefiniertes Feld Nr. 27
   :                 :                            :
string            $user80               Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
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");
 
   $data = array(
     'name'   => 'Admonition 10000001';
     'realnumber' => '10000001',
     'notes'    => 'Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.',
     'cid'    => 1,
     'client_account_id'=> 1,
     'date'   => time(),
     'payed'    => 50,
     'is_payed' => time(),
     'status'   => 0,
     'admonition_fee' => 250,
     'date_level_0' => time(),
     'payment_target' => 2
   );
 
   $client_admonitions = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=admonitions&wsdl");
   $admon_id = $client_admonitions->crmAddAdmonition($session_id, $data);
 
   echo $admon_id;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}




2.2. crmChangeAdmonition

(Version >= 4.1.10678)

Syntax:

int crmChangeAdmonition( string $session_id, $admonition_id, $crmAdmonitionItem)

Beschreibung:

Ändert eine bestehende Mahnung mit der übergebenen ID. Gibt im Erfolgsfall die ID zurück.

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

crmAdmonitionItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Eigenschaften: sind die selben wie für crmAddAdmonition

Beispiel:

<?php
 
try {
  $data = array('name'=> 'Adminition 10000001 Update');
     $admon_id = $client_admonitions->crmChangeAdmonition($session_id, $admon_id, $data);
 
   echo $admon_id;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.3. crmGotoNextFlowStatus

(Version >= 4.1.10678)

Syntax:

void crmGotoNextFlowStatus( string $session_id, int $admonition_id)

Beschreibung:

Setzt den Status der Mahnung um eine Stufe hoch bis max. Status 3.

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

Beispiel:

<?php
 
try {
  $client_admonitions->crmGotoNextFlowStatus($session_id, $admon_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.4. crmGetFlowStatus

(Version >= 4.1.10678)

Syntax:

int crmGetFlowStatus( string $session_id, int $admonition_id)

Beschreibung:

Holt den aktuellen Status der Mahnung.

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

Beispiel:

<?php
 
try {
  $status = $client_admonitions->crmGetFlowStatus($session_id, $admon_id);
   
     echo $status;
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.5. crmGetAdmonition

(Version >= 4.1.10793)

Syntax:

array crmGetAdmonition( string $session_id, int $admonition_id, boolean $format = false)

Beschreibung:

Holt eine bestehende Mahnung mit der übergebenen ID. Gibt im Erfolgsfall ein Array zurück. Über den Parameter format können die Daten schon aufbereitet zurückgegeben werden.

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

Eigenschaften des zurückgegebenen Array

Type(Length)	  Eigenschaft				Beschreibung
---------------------------------------------------------------------------------
int		          $id					            ID der Mahnung
int               $ext_id                           Externe ID ( ab Version 4.2 )
int		          $cid					            Kontakt-ID
int		          $client_account_id			    Rechnungskonto-ID
string		      $realnumber				        Belegnummer
string		      $realnumber_activity			    Belegnummer-ID
double		      $amount				            Betrag
string		      $posting_account_in			    Buchungskonto eingehend
string		      $posting_account_out			    Buchungskonto ausgehend
int		          $date					            Datum
string		      $text					            Buchungstext
string		      $reference_text_1			        Referenztext 1
string		      $reference_text_2			        Referenztext 1
string		      $notes				            Notizen
int		          $reversed				            aufgehoben
int		          $accounted				        entfallen
string		      $ust_id				            Ust-ID
string		      $billing_postcode			        Rechnung: PLZ
string		      $billing_city				        Rechnung: Ort
string		      $billing_name_1			        Rechnung: Name 1
string		      $billing_name_2			        Rechnung: Name 2
string		      $billing_name_3			        Rechnung: Name 3
string		      $billing_address_1			    Rechnung: Adresse 1
string		      $billing_address_2			    Rechnung: Adresse 2
array		      $crmOriginalContactElements		Original-Daten des Kontaktes
array		      $crmOriginalClientAccountElements	Original-Daten des Rechnungskontos
int		          $createuser	        		    Benutzer-ID, der Buchung erzeugt hat
int		          $createtime				        Zeitstempel, an dem Buchung erzeugt wurde
int		          $chguser				            Benutzer-ID, der Buchung zuletzt geändert hat
int		          $chgtime				            Zeitstempel, an dem zuletzt geändert wurde

string      	  $user60				            Benutzerdefiniertes Feld Nr. 60
string            $user61				            Benutzerdefiniertes Feld Nr. 61
   :                 :                            		:
string            $user80				            Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
  $result = $client_admonitions->crmGetAdmonition($session_id, $admon_id);
 
   foreach($result as $key => $val) {
  echo "$key => $val<br>\n";
  }
     echo "<hr/>";
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.6. crmDeleteAdmonition

(Version >= 4.1.10678)

Syntax:

int crmDeleteAdmonition( string $session_id, int $admonition_id)

Beschreibung:

Ändert eine bestehende Mahnung mit der übergebenen ID. Gibt im Erfolgsfall 1 zurück.

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

Beispiel:

<?php
 
try {
  $result = $client_admonitions->crmDeleteAdmonition($session_id, $admon_id);
 
   echo $result;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.7. crmsearchAdmonitions

(Version >= 4.1.10678)

Syntax:

array crmsearchAdmonitions( string $session_id, $crmAdmonitionSearchParams)

Beschreibung:

Sucht nach Mahnungen anhand der. Gibt im Erfolgsfall ein Array zurück.

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

crmAdmonitionSearchParams kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
string            $search		        Suchbegriff
string		      $client_account_id	Rechnungskonto-ID
string		      $is_payed		        ist Mahnung bezahlt
string		      $payment_appointed	Zahlungsstichtag
int		          $flow_status		    Status
int		          $changed_since	    Änderungsdatum seit
int		          $changed_until	    Änderungsdatum bis
int		          $count		        maximale Anzahl an Elementen, die zurückgegeben wird
int		          $offset		        Position der Ergebnisse, ab der zurückgegeben werden soll
bool		      $sorting		        Einstellung, ob Elemente sortiert zurückgegeben werden

Eigenschaften des zurückgegebenen Array

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $id			    ID der Mahnung
int		      $cid			    Kontakt-ID
int		      $client_account_id	Rechnungskonto-ID
int		      $date			    Datum
string	      $name			    Name
int		      $flow_status		Status
int		      $date_level_0		Datum 1. Mahnung
int		      $date_level_1		Datum 2. Mahnung
int		      $date_level_1		Datum 3. Mahnung
int		      $level		    Mahnungslevel

Beispiel:

<?php
 
try {
  $sparams = array ('search' => "name LIKE '%Admonition 10000001%'");
 
   $result = $client_admonitions->crmsearchAdmonitions($session_id, $sparams);
 
   foreach($result as $key => $val) {
  echo "$key => $val<br>\n";
  }
     echo "<hr/>";
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.8. crmGetDocument

(Version >= 4.1.10678)

Syntax:

array crmGetDocument( string $session_id, int $admonition_id)

Beschreibung:

Holt das zur Mahnung gehörige Dokument aus dem CRM. Gibt ein Array zurück.

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

Eigenschaften des zurückgegebenen Array

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
string		  $filename		Dateiname des Dokumentes
string		  $content		base64-codierter Inhalt der Datei

Beispiel:

<?php
 
try {
  $document = $client_admonitions->crmGetDocument($session_id, $admon_id);
   
     echo "";
      var_dump($document);
      echo "";
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.9. crmAddPayment

(Version >= 4.1.10678)

Syntax:

int crmAddPayment( string $session_id, int $admonition_id, $crmPaymentItem)

Beschreibung:

Erzeugt eine neue Zahlung und weiß diese einer Mahnung zu. Gibt im Erfolgsfall die ID des Datensatzes zurück.

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

crmPaymentItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $cid			        Kontakt-ID
int           $ext_id               Externe ID ( ab Version 4.2 )
int		      $client_account_id	Rechnungskonto-ID
string		  $realnumber		    Belegnummer
string		  $realnumber_activity	Belegnummer-ID
double		  $amount		        Betrag
string		  $posting_account_in	Buchungskonto eingehend
string		  $posting_account_out	Buchungskonto ausgehend
int		      $date			        Datum
string		  $text			        Buchungstext
string		  $reference_text_1	    Referenztext 1
string		  $reference_text_2	    Referenztext 2
string		  $notes		        Notizen
string		  $user12		        Benutzerdefiniertes Feld Nr. 12
string		  $user13		        Benutzerdefiniertes Feld Nr. 13
   :                 :                            :
string		  $user80		        Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
  $data = array(
       'notes'      => 'Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.',
       'client_account_id'  => 1,
       'amount'     => 200,
       'realnumber_activity'  => 10000001,
       'reference_text_1' => 'Payment Admonition 10000001',
       'reference_text_2' => 'Part 1'
     );
 
   $payment_id = $client_admonitions->crmAddPayment($session_id, $admon_id, $data);
 
   echo $payment_id;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.10. crmEncash

(Version >= 4.1.10678)

Syntax:

int crmEncash( string $session_id, int $admonition_id)

Beschreibung:

Führt Mahnung zu Inkasso-Vorgang über. Im Erfolgsfall wird die ID zurückgegeben

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

Beispiel:

<?php
 
try {
  $id = $client_admonitions->crmEncash($session_id, $admon_id);
   
     echo $id;
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.11. crmEscalate

(Version >= 4.1.10678)

Syntax:

int crmEscalate( string $session_id, int $admonition_id)

Beschreibung:

Stuft Mahnung in Inkasso-Vorgang auf Status Eskalation. Im Erfolgsfall wird die ID zurückgegeben

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

Beispiel:

<?php
 
try {
  $id = $client_admonitions->crmEscalate($session_id, $admon_id);
   
     echo $id;
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.12. crmIrrecoverable

(Version >= 4.1.10678)

Syntax:

int crmIrrecoverable( string $session_id, int $admonition_id)

Beschreibung:

Stuft Mahnung in Inkasso-Vorgang auf Status Uneinbringlich. Im Erfolgsfall wird die ID zurückgegeben

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

Beispiel:

<?php
 
try {
  $id = $client_admonitions->crmIrrecoverable($session_id, $admon_id);
   
     echo $id;
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.13. crmGetArticles

(Version >= 4.1.10678)

Syntax:

array crmGetArticles( string $session_id, int $admonition_id)

Beschreibung:

Führt Mahnung zu Inkasso-Vorgang über. Im Erfolgsfall wird die ID zurückgegeben

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

Beispiel:

<?php
 
try {
  $articles = $client_admonitions->crmGetArticles($session_id, $admon_id);
   
     foreach($articles as $article) {
       foreach($article as $key => $val) {
  echo "$key => $val<br>\n";
  }
     }
     echo "<hr/>";
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.14. crmAddArticleToList

(Version >= 4.1.10678)

Syntax:

array crmAddArticleToList( string $session_id, int $admonition_id, int $article_id)

Beschreibung:

Fügt den Artikel mit der übergebenen ID zu einer Mahnung hinzu. Im Erfolgsfall wird 1 zurückgegeben.

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

Beispiel:

<?php
 
try {
  $success = $client_admonitions->crmAddArticleToList($session_id, $admon_id, 10);    
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.15. crmAddTextToList

(Version >= 4.1.10678)

Syntax:

array crmAddTextToList( string $session_id, int $admonition_id, string $text)

Beschreibung:

Fügt einen Artikel-Text zu einer Mahnung hinzu. Im Erfolgsfall wird 1 zurückgegeben.

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

Beispiel:

<?php
 
try {
  $success = $client_admonitions->crmAddTextToList($session_id, $admon_id, 'Das ist ein Text');
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}



2.16. crmAddSpecialToList

(Version >= 4.1.10678)

Syntax:

array crmAddSpecialToList( string $session_id, int $admonition_id, $crmBillingItem)

Beschreibung:

Fügt einen Sonderartikel zu einer Mahnung hinzu. Im Erfolgsfall wird 1 zurückgegeben.

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

crmBillingItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
int             $quantity                            Menge
string          $realnumber                          Artikelnummer
string          $name                                Bezeichnung
int             $taxrate                             Steuersatz-Index
double          $discount                            Rabatt
int             $interval                            Abrechnungszeitraum-Index
string          $description                         Beschreibung
int             $ext_id                              Externe ID ( ab Version 4.2 )

Beispiel:

<?php
 
try {
  $data = array(
       'quantity' => 10,
       'realnumber' => '100001',
       'name'   => 'API Special Article',
       'description'  => 'API Special Article',
       'taxrate'    => 19,
       'discount' => 100,
       'interval' => 1
     );
 
   $success = $client_admonitions->crmAddSpecialToList($session_id, $admon_id, $data);
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.17. crmAddGrouplineToList

(Version >= 4.1.10678)

Syntax:

array crmAddGrouplineToList( string $session_id, int $admonition_id, $crmBillingItem)

Beschreibung:

Fügt eine Gruppenzeile zu einer Mahnung hinzu. Im Erfolgsfall wird 1 zurückgegeben.

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

crmBillingItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
int             $quantity                             Menge
string          $name                                 Bezeichnung
int             $taxrate                              Steuersatz-Index
double          $discount                             Rabatt
int             $interval                             Abrechnungszeitraum-Index
string          $description                          Beschreibung
int             $ext_id                               Externe ID ( ab Version 4.2 )

Beispiel:

<?php
 
try {
  $data = array(
       'quantity' => 3,
       'name'   => 'API Groupline',
       'description'  => 'API Groupline',
       'taxrate'    => 19,
       'discount' => 100,
       'interval' => 1
     );
 
   $success = $client_admonitions->crmAddGrouplineToList($session_id, $admon_id, $data);
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.18. crmAddMultipleToList

(Version >= 4.1.10678)

Syntax:

array crmAddMultipleToList( string $session_id, int $admonition_id, $crmMultipleListItems)

Beschreibung:

Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einer Mahnung hinzu. Im Erfolgsfall wird 1 zurückgegeben.

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

crmMultipleListItems ist ein Array von Artikeln, die Eigenschaften sind die selben wie crmAddArticleToList, crmAddTextToList, crmAddSpecialToList und crmAddGrouplineToList. Die Unterscheidung erfolgt über das Feld "type".

Eigenschaften:

Typ             Eigenschaft                          Beschreibung
---------------------------------------------------------------------------------------------
array           $crmMultipleListItems                Artikelliste

Beispiel:

<?php
 
try {
 
   $items = array();
 
   $items['crmMultipleListItems'][] = array('type' => 'article', 'id' => 10);
   $items['crmMultipleListItems'][] = array('type' => 'text','text' => 'API-AddMultiple Text');
 
   $specialItem = array(
  'quantity'  => 10,
  'realnumber'  => '100001',
  'name'    => 'API Special Article',
  'description' => 'API Special Article',
  'taxrate' => 19,
  'discount'  => 100,
  'interval'  => 1,
  'type'    => 'special'
  );    
     $items['crmMultipleListItems'][] = $specialItem;
 
   $data = array(
     'quantity' => 3,
     'name'   => 'API Groupline',
     'description'  => 'API Groupline',
     'taxrate'    => 19,
     'discount' => 100,
     'interval' => 1,
     'type'   => 'groupline'
   );
   $items['crmMultipleListItems'][] = $specialItem;
   
 
   $success = $client_admonitions->crmAddMultipleToList($session_id, $admon_id, $items);
 
   echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.19. crmRemoveArticleFromList

(Version >= 4.1.10678)

Syntax:

array crmRemoveArticleFromList( string $session_id, int $admonition_id, int $article_id)

Beschreibung:

Löscht den Artikel mit der angegeben ID aus der Artikelliste der Mahnung. Im Erfolgsfall wird 1 zurückgegeben.

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

Beispiel:

<?php
 
try {
  $success = $client_admonitions->crmRemoveArticleFromList($session_id, $admon_id, 11);
   
     echo $success;
 
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.20. crmUnlockAdmonition

(Version >= 4.1)

Syntax:

void crmUnlockAdmonition( string $session_id, int $admonition_id)

Beschreibung:

Gibt eine Mahnung zur Bearbeitung wieder frei. Gibt im Erfolgsfall die ID der Mahnung zurück.

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

Beispiel:

<?php
 
try {
  $client_admonitions->crmUnlockAdmonition($session_id, $admon_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}

2.21. crmReverseAdmonition

(Version >= 4.1)

Syntax:

int crmReverseAdmonition( string $session_id, int $admonition_id)

Beschreibung:

Storniert eine Mahnung. Gibt im Erfolgsfall die ID der Mahnung zurück.

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

Beispiel:

<?php
 
try {
  $result = $client_admonitions->crmReverseAdmonition($session_id, $admonition_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
echo $result;

2.22. crmDowngrade

(Version >= 4.1)

Syntax:

int crmDowngrade( string $session_id, int $admonition_id)

Beschreibung:

Verringert die Mahnstufe einer Mahnung. Gibt im Erfolgsfall die ID der Mahnung zurück.

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

Beispiel:

<?php
 
try {
  $result = $client_admonitions->crmDowngrade($session_id, $admonition_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
echo $result;

2.23. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( string $session_id, string $external_id )

Beschreibung

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

Eigenschaften der zurückgegebenen admonition Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 Admonition-Id 

Beispiel:

<?php
 
try {
  $result = $client_admonitions->crmgetIdByExtId($session_id, 12345);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $id) {
   
     echo $id."<br>  ";
}

2.24. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

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

Eigenschaften der zurückgegebenen admonition Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int			            $id			                 externe Admonition-Id 

Beispiel:

<?php
 
try { 
  $result = $client_admonitions->crmgetAllExtIds($session_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
foreach($result as $id) {
   
     echo $id."<br>  ";
}

2.25. crmsetDuplicateConfig

(Version >= 4.4)

Syntax:

int | string <errormessage> crmDuplicateConfig( string $session_id, crmDuplicatecheckFields $crmDuplicatecheckFields )

Beschreibung:

Ermöglicht eine temporäre Überschreibung der Dublettenprüfungsfelder für die Laufzeit der angemeldeten Session.

Eigenschaften des zu übergebenden crmDuplicatecheckFields Objektes:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
string			        $fields			     implodiertes Array ( implode(',', $myFields) ) mit gewünschten Feldern, 
						                     auf die eine Dublettenprüfung angewendet werden soll;
						                     wenn Eigenschaft auf NULL gesetzt wird, wird Override zurückgesetzt

Beispiel:

<?php
 
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_admonitions = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=admonitions&wsdl");
 
   $fields  = array('fields' => implode(',', array('notes', 'realnumber')) );
   $success = $client_admonitions->crmsetDuplicateConfig($session_id, $fields);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
echo ($success == 1 ? 'override successful' : $success);

2.26. crmgetDuplicateConfig

(Version >= 4.4)

Syntax:

string crmgetDuplicateConfig( string $session_id )

Beschreibung:

Gibt implodiertes Array als Zeichenkette mit aktueller Feldkonfiguration der Dublettenprüfung zurück.

Sollte aktuell keine temporäre Überschreibung der Feldkonfiguration aktiv sein (siehe crmsetDuplicateConfig), wird die durch die Administration konfigurierte Feldliste zurückgegeben.

Beispiel:

<?php
 
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_admonitions = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=admonitions&wsdl");
   $fields = $client_admonitions->crmgetDuplicateConfig($session_id);
}
catch (SOAPFault $f) {
  print $f->faultstring;
}
 
$fields = explode(',', $fields);
echo '<pre>'.print_r($fields, true).'</pre>';
  • No labels