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

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

2. Klasse

crmdeliveries

3. Methods

3.1. crmAddDelivery

(Version >= 4.1)

Syntax:

int crmAddDelivery( array( string $session_id, array $crmDeliveryItem))

Beschreibung:

Erzeugt einen neuen Lieferschein. Gibt bei Erfolg die ID des Datensatzes zurück.

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

crmDeliveryItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $cid			    Kontakt-ID
int		      $client_account_id	Rechnungskonto-ID
string		  $realnumber		Belegnummer
int		      $date			    Datum als Unit-Timestamp
int		      $printed		    Druckdatum als Unit-Timestamp
string		  $text			    Text
string		  $notes		    Notizen
int		      $reversed		    zurückgerufen
string		  $name			    Name
int		      $invoice_id		Rechnungs-ID
int		      $delivery_target	Lieferziel
int		      $delivery_appointed	Lieferungstichtag
double		  $total_netto		Gesamt - netto
double		  $tax_value		USt-Betrag
double		  $total_brutto		Gesamt - brutto
int		      $is_delivered		Lieferdatum als Unit-Timestamp
int		      $flow_status		Status
string		  $shipping_postcode	Lieferschein: PLZ
string		  $shipping_city	Lieferschein: Ort
string		  $shipping_county	Lieferschein: Land
string		  $shipping_name_1	Lieferschein: Name 1
string		  $shipping_name_2	Lieferschein: Name 2
string		  $shipping_name_3	Lieferschein: Name 3
string		  $shipping_address_1	Lieferschein: Adresse 1
string		  $shipping_address_2	Lieferschein: Adresse 2

string		  $user29		     Benutzerdefiniertes Feld Nr. 29
string		  $user30		     Benutzerdefiniertes Feld Nr. 30
   :                 :                            :
string		  $user80		     Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
   
	$data = array(
		'name'				=> 'API Test Delivery',
		'realnumber'		=> '10000001',
		'notes'				=> 'Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.',
		'cid'				=> 1,
		'client_account_id' => 1,
		'invoice_id'		=> 1
	);
 
	/* @var $client_deliveries crmdeliveries */
	$client_deliveries = new crm_rest_api("http://hostname/dirname/rest/index.php/deliveries");
	$delivery_id = $client_deliveries->crmAddDelivery(
		array(
			'session_id'		=> $session_id,
			'crmDeliveryItem'	=> $data
		)
	);
 
	echo $delivery_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.2. crmChangeDelivery

(Version >= 4.1)

Syntax:

int crmChangeDelivery( array( string $session_id, int $delivery_id, array $crmDeliveryItem))

Beschreibung:

Ändert den Lieferschein mit der übergebenen ID. Gibt bei Erfolg die ID des Datensatzes zurück.

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

crmDeliveryItem kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften::

Eigenschaften: sind die selben wie für crmAddDelivery

Beispiel:

<?php
 
try {
	$data	= array('name' => 'API Test Updated Delivery');
	$res	= $client_deliveries->crmChangeDelivery(
		array(
			'session_id'		=> $session_id,
			'delivery_id'		=> $delivery_id,
			'crmDeliveryItem'	=>$data
		)
	);
 
	echo $res;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.3. crmGetDelivery

(Version >= 4.1)

Syntax:

array crmGetDelivery( array( string $session_id, int $delivery_id))

Beschreibung:

Gibt den Lieferschein mit der übergebenen ID als Array zurück.

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

Eigenschaften des zurückgegebenen Array::

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		      $id			    Delivery-ID
int		      $cid			    Kontakt-ID
int		      $client_account_id	Rechnungskonto-ID
string		  $realnumber		Belegnummer
int		      $date			    Datum als Unit-Timestamp
int		      $printed		    Druckdatum als Unit-Timestamp
string		  $text			    Text
string		  $notes		    Notizen
int		      $reversed		    zurückgerufen
string		  $name			    Name
int		      $invoice_id		Rechnungs-ID
int		      $delivery_target	Lieferziel
int		      $delivery_appointed	Lieferungstichtag
double		  $total_netto		Gesamt - netto
double		  $tax_value		USt-Betrag
double		  $total_brutto		Gesamt - brutto
int		      $is_delivered		Lieferdatum als Unit-Timestamp
int		      $flow_status		Status
string		  $shipping_postcode	Lieferschein: PLZ
string		  $shipping_city	Lieferschein: Ort
string		  $shipping_county	Lieferschein: Land
string		  $shipping_name_1	Lieferschein: Name 1
string		  $shipping_name_2	Lieferschein: Name 2
string		  $shipping_name_3	Lieferschein: Name 3
string		  $shipping_address_1	Lieferschein: Adresse 1
string		  $shipping_address_2	Lieferschein: 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		  $user29		Benutzerdefiniertes Feld Nr. 29
string		  $user30		Benutzerdefiniertes Feld Nr. 30
   :                 :                            :
string		  $user80		Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
	$result = $client_deliveries->crmGetDelivery(
		array(
			'session_id'	=> $session_id,
			'delivery_id'	=> $delivery_id
		)
	);
 
	foreach($result as $key => $val) {
		echo "$key => $val<br>\n";
	}
	echo "<hr/>";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.4. crmDeleteDelivery

(Version >= 4.1)

Syntax:

array crmDeleteDelivery( array( string $session_id, int $delivery_id))

Beschreibung:

Entfernt den Lieferschein mit der übergebenen ID.

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

Beispiel:

<?php
 
try {
	$result = $client_deliveries->crmDeleteDelivery(
		array(
			'session_id'	=> $session_id,
			'delivery_id'	=> $delivery_id
		)
	);
 
	echo $result;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.5. crmSearchDeliveries

(Version >= 4.1)

Syntax:

array crmSearchDeliveries( array( string $session_id, array $crmSearchDeliveriesParams))

Beschreibung:

Sucht anhand der übergebenen Parameter nach Gutschriften. Gibt im Erfolgsfall ein Array mit Gutschriften zurück.

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

crmSearchDeliveriesParams kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften von crmSearchDeliveriesParams:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
string		  $search		Suchbegriff
string		  $client_account_id	Rechnungskonto-ID
string		  $is_payed		ist Lieferschein bezahlt
int		      $status		Status
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

Beispiel:

<?php
 
try {
	$sparams	= array('search' => "name LIKE '%API Test Delivery%'");
	$deliveries = $client_deliveries->crmSearchDeliveries(
		array(
			'session_id'				=> $session_id,
			'crmSearchDeliveriesParams'	=> $sparams
		)
	);
   
	foreach($deliveries as $voucher) {
		foreach($voucher as $key => $val) {
			echo "$key => $val<br>\n";
		}
		echo "<hr/>";    
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.6. crmgotoNextFlowStatus

(Version >= 4.1)

Syntax:

int crmgotoNextFlowStatus( array( string $session_id,  int $delivery_id))

Beschreibung:

Setzt den Status der Gutschrift auf die nächste Stufe.

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

Beispiel:

<?php
 
try {
	$client_deliveries->crmgotoNextFlowStatus(
		array(
			'session_id'	=> $session_id,
			'delivery_id'	=> $delivery_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 



3.7. crmFromInvoice

(Version >= 4.1)

Syntax:

array crmFromInvoice( array( string $session_id, int $invoice_id, $item_ids = false))

Beschreibung:

Erzeugt eine Gutschrift aus einer Rechnung. Gibt im Erfolgsfall die ID der erzeugten Gutschrift zurück..

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

item_ids ist ein Array von Artikel-IDs.

Beispiel:

<?php
 
try {
	$result = $client_deliveries->crmFromInvoice(
		array(
			'session_id'	=> $session_id, 
			'invoice_id'	=> $invoice_id, 
			'item_ids'		=> array(1,2,3)
		)
	);
   
	echo $result;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.8. crmGetFlowStatus

(Version >= 4.1)

Syntax:

int crmGetFlowStatus( array( string $session_id, int $delivery_id))

Beschreibung:

Holt den aktuellen Status des Lieferschein.

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

Beispiel:

<?php
 
try {
	$status = $client_vouchers->crmGetFlowStatus(
		array(
			'session_id'	=> $session_id, 
			'object_id'		=> $delivery_id
		)
	);
   
	echo $status;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.9. crmGetDocument

(Version >= 4.1)

Syntax:

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

Beschreibung:

Holt das zum Lieferschein 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-codierte Inhalt der Datei

Beispiel:

<?php
 
try {
	$document = $client_vouchers->crmGetDocument(
		array(
			'session_id'	=> $session_id, 
			'object_id'		=> $delivery_id
		)
	);
   
	echo "";
	var_dump($document);
	echo "";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.10. crmGetArticles

(Version >= 4.1)

Syntax:

array crmGetArticles( array( string $session_id, int $delivery_id))

Beschreibung:

Gibt Artikelliste des Lieferscheines zurück.

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

Beispiel:

<?php
 
try {
	$articles = $client_vouchers->crmGetArticles(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $delivery_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.11. crmAddArticleToList

(Version >= 4.1)

Syntax:

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

Beschreibung:

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

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

Beispiel:

<?php
 
try {
	$success = $client_vouchers->crmAddArticleToList(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $delivery_id,
			'article_id'	=> 10
		)
	);    
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.12. crmAddTextToList

(Version >= 4.1)

Syntax:

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

Beschreibung:

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

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

Beispiel:

<?php
 
try {
	$success = $client_vouchers->crmAddTextToList(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $delivery_id,
			'text'			=> 'Das ist ein Text'
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.13. crmAddSpecialToList

(Version >= 4.1)

Syntax:

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

Beschreibung:

Fügt einen Sonderartikel zu einem Lieferschein 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

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



3.14. crmAddGrouplineToList

(Version >= 4.1)

Syntax:

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

Beschreibung:

Fügt eine Gruppenzeile zu einem Lieferschein 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

Beispiel:

<?php
 
try {
	$data = array(
		'quantity'		=> 3,
		'name'			=> 'API Groupline',
		'description'	=> 'API Groupline',
		'taxrate'		=> 19,
		'discount'		=> 100,
		'interval'		=> 1
	);
 
	$success = $client_vouchers->crmAddGrouplineToList(
		array(
			'session_id'		=> $session_id,
			'object_id'			=> $delivery_id, 
			'crmBillingItem'	=> $data
		)
	);
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.15. crmAddMultipleToList

(Version >= 4.1)

Syntax:

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

Beschreibung:

Fügt der Artikelliste mehrere Artikel und Texte und Gruppenzeilen zu einem Lieferschein 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_vouchers->crmAddMultipleToList(
		array(
			'session_id'		=> $session_id, 
			'object_id'			=> $delivery_id, 
			'crmBillingItem'	=> $items
		)
	);
 
	echo $success; 
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.16. crmRemoveArticleFromList

(Version >= 4.1)

Syntax:

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

Beschreibung:

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

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

Beispiel:

<?php
 
try {
	$success = $client_vouchers->crmRemoveArticleFromList(
		array(
			'session_id'	=> $session_id,
			'object_id'		=> $delivery_id,
			'article_id'	=> 11
		)
	);
   
	echo $success;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.17. crmUnlockDelivery

(Version >= 4.1)

Syntax:

int crmUnlockDelivery( array( string $session_id, int $delivery_id))

Beschreibung:

Gibt einen Lieferschein zur Bearbeitung wieder frei. Gibt im Erfolgsfall die ID der Gutschrift zurück.

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

Beispiel:

<?php
 
try {
	$result = $client_deliveries->crmUnlockDelivery(
		array(
			'session_id'	=> $session_id,
			'delivery_id'	=> $delivery_id
		)
	);
	echo $result;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



3.18. crmReverseDelivery

(Version >= 4.1)

Syntax:

int crmReverseDelivery( array( string $session_id, int $delivery_id))

Beschreibung:

Storniert einen Lieferschein. Gibt im Erfolgsfall die ID des Lieferscheins zurück.

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

Beispiel:

<?php
 
try {
	$result = $client_deliverys->crmReverseDelivery(
		array(
			'session_id'	=>$session_id,
			'delivery_id'	=>$delivery_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
echo $result;
 



3.19. crmToDelivered

(Version >= 4.1)

Syntax:

int crmToDelivered( array( string $session_id, int $delivery_id))

Beschreibung:

Setzt des Status eines Lieferschein aus geliefert und im Erfolgsfall die ID des Lieferscheins zurück.

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

Beispiel:

<?php
 
try {
	$result = $client_deliverys->crmToDelivered(
		array(
			'session_id'	=>$session_id,
			'delivery_id'	=>$delivery_id
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
echo $result;



3.20. crmgetIdByExtId

(Version >= 4.2)

Syntax:

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

Beschreibung

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

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

Beispiel:

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



3.21. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( array ( string $session_id ) )

Beschreibung

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

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

Beispiel:

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



3.22. 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/deliveries';
	$session_id  = session_id();
	$deliveries  = new crm_rest_api($rest_url);
 
	$params  = array(
		'session_id' => $session_id,
		'fields'     => array('name', 'notes')
	);
	$success = $deliveries->crmsetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ($success ? 'override successful' : $success);



3.23. 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/deliveries';
	$session_id  = session_id();
	$deliveries  = new crm_rest_api($rest_url);
 
	$params  = array('session_id' => $session_id);
	$fields  = $deliveries->crmgetDuplicateConfig($params);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ''.print_r($fields, true).'';
  • No labels