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

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

2. Klasse

crmadmonitions

3. Methods

3.1. crmAddAdmonition

(Version >= 4.1.10682)

Syntax:

int crmAddAdmonition( array( string $session_id, array $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 ist ein assoziatives Array.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
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
int               $ext_id               Externe ID ( ab Version 4.2 )

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

Beispiel:

<?php
 
include_once 'crm_rest_api.php';
try {
	$client_admonitions = new crm_rest_api("http://hostname/dirname/rest/index.php/admonitions");
 
	$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
	);
 
	$admon_id = $client_admonitions->crmAddAdmonition(
		array(
			'session_id'		=> $session_id,
			'crmAdmonitionItem'	=> $data
		)
	);
 
	echo $admon_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.2. crmChangeAdmonition

(Version >= 4.1.10678)

Syntax:

int crmChangeAdmonition( array( string $session_id, int $admonition_id, array $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 ist ein assoziatives Array.

Eigenschaften:

Eigenschaften: sind die selben wie für crmAddAdmonition

Beispiel:

<?php
 
try {
	$data = array('name'=> 'Adminition 10000001 Update');
	$admon_id = $client_admonitions->crmChangeAdmonition(
		array(
			'session_id'		=> $session_id,
			'admonition_id'		=> $admon_id,
			'crmAdmonitionItem'	=> $data
		)
	);
   echo $admon_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.3. crmGotoNextFlowStatus

(Version >= 4.1.10678)

Syntax:

void crmGotoNextFlowStatus( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id' => $admon_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.4. crmGetFlowStatus

(Version >= 4.1.10678)

Syntax:

int crmGetFlowStatus( array( 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id
		)
	);
	echo $status;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.5. crmGetAdmonition

(Version >= 4.1.10678)

Syntax:

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

Beschreibung:

Holt eine bestehende Mahnung mit der übergebenen ID. Gibt im Erfolgsfall ein Array zurück. Über den Index 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
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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
 
	foreach($result as $key => $val) {
		echo "$key => $val<br>\n";
	}
	echo "<hr/>";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.6. crmDeleteAdmonition

(Version >= 4.1.10678)

Syntax:

int crmDeleteAdmonition( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
 
	echo $result;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.7. crmsearchAdmonitions

(Version >= 4.1.10678)

Syntax:

array crmsearchAdmonitions( array( string $session_id, array $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 ist ein assoziatives Array.

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(
		array(
			'session_id'				=> $session_id,
			'crmAdmonitionSearchParams'	=> $sparams
		)
	);
 
	foreach($result as $key => $val) {
		echo "$key => $val<br>\n";
	}
	echo "<hr/>";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.8. crmGetDocument

(Version >= 4.1.10678)

Syntax:

array crmGetDocument( array( string $session_id, int $admonition_id))

Beschreibung:

Holt das zur Mahnung gehörige Dokument aus dem TecArt-System. 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id
		)
	);
   
	echo "";
	var_dump($document);
	echo "";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.9. crmAddPayment

(Version >= 4.1.10678)

Syntax:

int crmAddPayment( array( string $session_id, int $admonition_id, array $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 ist ein assoziatives Array.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $cid			        Kontact-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 2
string		  $notes		        Notizen
int           $ext_id               Externe ID ( ab Version 4.2 )
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',
		'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(
		array(
			'session_id'		=> $session_id,
			'admonition_id'		=> $admon_id,
			'crmPaymentItem'	=> $data
		)
	);
 
	echo $payment_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.10. crmEncash

(Version >= 4.1.10678)

Syntax:

int crmEncash( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
   
	echo $id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.11. crmEscalate

(Version >= 4.1.10678)

Syntax:

int crmEscalate( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
   
	echo $id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.12. crmIrrecoverable

(Version >= 4.1.10678)

Syntax:

int crmIrrecoverable( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
   
	echo $id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.13. crmGetArticles

(Version >= 4.1.10678)

Syntax:

array crmGetArticles( array( 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id
		)
	);
   
	foreach($articles as $article) {
		foreach($article as $key => $val) {
			echo "$key => $val<br>\n";
		}
	}
	echo "<hr/>";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}

3.14. crmAddArticleToList

(Version >= 4.1.10678)

Syntax:

array crmAddArticleToList( array( 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id,
			'article_id'	=> 10
		)
	);    
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.15. crmAddTextToList

(Version >= 4.1.10678)

Syntax:

array crmAddTextToList( array( 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id,
			'text'			=> 'Das ist ein Text'
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.16. crmAddSpecialToList

(Version >= 4.1.10678)

Syntax:

array crmAddSpecialToList( array( string $session_id, int $admonition_id, array $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 ist ein assoziatives Array.

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(
		array(
			'session_id'		=> $session_id,
			'object_id'			=> $admon_id,
			'crmBillingItem' 	=> $data
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.17. crmAddGrouplineToList

(Version >= 4.1.10678)

Syntax:

array crmAddGrouplineToList( array( string $session_id, int $admonition_id, array $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 ist ein assoziatives Array.

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(
		array(
			'session_id'		=> $session_id,
			'object_id'			=> $admon_id,
			'crmBillingItem' 	=> $data
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.18. crmAddMultipleToList

(Version >= 4.1.10678)

Syntax:

array crmAddMultipleToList( array( string $session_id, int $admonition_id, array $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 gleichen 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(
		array(
			'session_id'		=> $session_id,
			'object_id'			=> $admon_id,
			'crmBillingItem'	=> $items
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.19. crmRemoveArticleFromList

(Version >= 4.1.10678)

Syntax:

array crmRemoveArticleFromList( array( 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(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $admon_id,
			'article_id'	=> 11
		)
	);
   
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.20. crmUnlockAdmonition

(Version >= 4.1)

Syntax:

void crmUnlockAdmonition( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=>$admon_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.21. crmReverseAdmonition

(Version >= 4.1)

Syntax:

int crmReverseAdmonition( array( 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
echo $result;



3.22. crmDowngrade

(Version >= 4.1)

Syntax:

int crmDowngrade( array( string $session_id, int $admonition_id))

Beschreibung:

Veringert 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(
		array(
			'session_id'	=> $session_id,
			'admonition_id'	=> $admon_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
echo $result;



3.23. crmgetIdByExtId

(Version >= 4.2)

Syntax:

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

Beschreibung

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

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

Beispiel:

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



3.24. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( array ( string $session_id ) )

Beschreibung

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

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

Beispiel:

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



3.25. crmsetDuplicateConfig

(Version >= 4.4)

Syntax:

boolean | string <err_msg> crmsetDuplicateConfig( array( 'session_id' => string <session_id>, 'fields' => array( string <fieldname>, [string <fieldname>...])) )

Beschreibung:

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

Parameter fields ist ein Array mit den Feldnamen, die anstatt der aktuell für das Modul festgelegten Felder zur Dublettenprüfung herangezogen werden sollen.

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
	$rest_url    = 'https://<hostname>/<dirname>/rest/index.php/admonitions';
	$session_id  = session_id();
	$admonitions = new crm_rest_api($rest_url);
 
	$params  = array(
		'session_id' => $session_id,
		'fields'     => array('notes', 'realnumber')
	);
	$success = $admonitions->crmsetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ($success ? 'override successful' : $success);



3.26. crmgetDuplicateConfig

(Version >= 4.4)

Syntax:

array | string <err_msg> crmgetDuplicateConfig( array( 'session_id' => string <session_id> ) )

Beschreibung:

Gibt Array 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
 
try {
	include_once 'crm_rest_api.php';
	$rest_url    = 'https://<hostname>/<dirname>/rest/index.php/admonitions';
	$session_id  = session_id();
	$admonitions = new crm_rest_api($rest_url);
 
	$params  = array('session_id' => $session_id);
	$fields  = $notes->crmgetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ''.print_r($fields, true).'';
  • No labels