Haupt-
Entwicklung

Makro "Benutzerprofil"

Customizing
Consulting


Schulungs-
kompetenz




Werden Änderungen vorgenommen und neue Inhalte kommen zu der Seite hinzu, sind die Haken der Aufgaben gleichzeitig zu entfernen, damit so ein Anhaltspunkt an die Verantwortlichen des Handbuchs gegeben wird.

Aufgaben

  • Gib deine Aufgabe hier ein, verwende "@", um sie einem Benutzer zuzuweisen, und "//", um ein Fälligkeitsdatum auszuwählen

Ab hier bitte neue Inhalte und Ergänzungen/Änderungen zu entsprechenden Abschnitten einfügen:



Aufruf URL

http://hostname/dirname/rest/index.php/logon

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

Methoden

crmLogin

Syntax:

string crmLogin ( array(string $username, string $password) )

Beschreibung:

Liefert die session_id , die in allen anderen Funktionen zur Authentifizierung verwendet wird.

Beispiel:

<?php
 
try {   
	include_once 'crm_rest_api.php';
   
	$logon		= new crm_rest_api("http://hostname/dirname/rest/index.php/logon");
	$session_id = $logon->crmLogin( array('username' => 'test', 'password' => 'test') );
 
	echo $session_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmLoginMD5

Diese Funktion ist veraltet und ist ab Version 4.6 nicht mehr verfügbar. Bitte verwenden Sie die Funktion crmLogin

Syntax:

string crmLoginMD5 ( array(string $username, string $password) )

Beschreibung:

Liefert die session_id , die in allen anderen Funktionen zur Authentifizierung verwendet wird.

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$logon		= new crm_rest_api("http://hostname/dirname/rest/index.php/logon");
	$session_id = $logon->crmLoginMD5( array('username' => 'test', 'password' => 'test') );
 
	echo $session_id;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmLogoff

Syntax:

boolean crmLogoff( array( string $session_id))

Beschreibung:

Löscht die Session.

Liefert 1 bei Erfolg zurück.

Beispiel:

<?php
 
try { 
	$success = $logon->crmLogoff( array('session_id' => $session_id) );
 
	if ($success == 1) {
		echo "logout successfully";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetChangedLists

Syntax:

array crmgetChangedLists ( array( string $session_id, int $timestamp) )

Beschreibung:

Liefert ein Array mit Listen, die sich seit timestamp verändert haben.

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetChangedLists(
		array(
			'session_id'	=> $session_id,
			'timestamp'		=> 1175269610
		)
	);
 
	foreach($result as $list) {
		echo $list."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetChangedUsers

Syntax:

array crmgetChangedUsers ( array( string $session_id, int $timestamp) )

Beschreibung:

Liefert ein Array mit Benutzer-Objekte von Nutzern, die sich seit timestamp verändert haben.

Eigenschaften:

sind die selben wie für crmgetUsers

Beispiel:

<?php
 
try {
	$result = $logon->crmgetChangedUsers(
		array(
			'session_id'	=> $session_id,
			'timestamp'		=> mktime(0, 0, 0, 5, 18, 2010)
		)
	);

	foreach($result as $user) {
		echo $user->login."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetDate

Syntax:

string crmgetDate( array( string $session_id))

Beschreibung:

Liefert das TecArt-System Datum des aktuellen Benutzers als Doppelpunkt-getrennte Zeichenfolge.

Beispiel:

<?php
 
try {
	$date = $logon->crmgetDate( array('session_id' => $session_id) );
 
	list($year, $month, $day, $hour, $minute, $second) = explode(":", $date);
 
	echo "The time is {$hour}:{$minute}:{$second}";
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetDepartments

Syntax:

array crmgetDepartments( array(string $session_id) )

Beschreibung:

Liefert ein Array mit allen Abteilung.

Eigenschaften:

Type            Eigenschaft                Beschreibung
-------------------------------------------------------------------
int   	        Objekt Attribute	   ID der Abteilung (Gruppe)
string   	    Objekt Value     	   Name der Abteilung (Gruppe)

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetDepartments( array('session_id' => $session_id) );
 
	$departments = get_object_vars($result);
 
	foreach($departments as $id => $name) {
		echo $id." - ".$name."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetGroups

Syntax:

array crmgetGroups( array( string $session_id) )

Beschreibung:

Liefert ein Array mit allen Gruppe.

Eigenschaften:

sind die selben wie für crmgetDepartments

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetGroups( array('session_id' => $session_id) );
 
	$groups = get_object_vars($result);
 
	foreach($groups as $id => $name) {
		echo $id." - ".$name."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetAdminGroups

(Version >= 3.5)

Syntax:

array crmgetAdminGroups( array( string $session_id) )

Beschreibung:

Liefert ein Array mit den IDs der Admin Gruppe.

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetAdminGroups( array('session_id' => $session_id) );
 
	$groups = get_object_vars($result);
 
	foreach($groups as $id ) {
		echo "Admin group id: " .$id. "<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetHolidays

Syntax:

array crmgetHolidays( array( string $session_id, int $year) )

Beschreibung:

Liefert ein Array mit Holiday-Objekten.

Eigenschaften von zurückgegebenen Array:

Type            Eigenschaft     Beschreibung
-------------------------------------------------------------------
int   	        $day   	        Tag des Feiertags
int   	        $month   	    Monat des Feiertags
int    	        $year    	    Jahr des Feiertags
string   	    $subject   	    Name des Feiertags
int   	        $type           = 0 - jedes Jahr an einem anderen Tag
                                = 1 - jedes Jahr am selben Tag
int   	        $groupid   	    Group-Id, z.B. für den Fall, das User aus
                                unterschiedlichen Ländern kommen
string   	    $description   	Beschreibung (nur ab der Version 3.7)

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetHolidays(
		array(
			'session_id'	=> $session_id,
			'year'			=> 2008
		)
	);
 
	foreach($result as $hday) {
		echo $hday->day.".".$hday->month.".".$hday->year." - ".$hday->subject."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetHolidaysIds

(Version >= 3.7)

Syntax:

array crmgetHolidaysIds( int $year )

Beschreibung:

Gibt ein Array mit IDs der Feiertagen für das gegebene Jahr zurück.

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetHolidaysIds(
		array(
			'session_id'	=> $session_id,
			'year'			=> 2010
		)
	);
} 
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
foreach($result as $id) {
	echo $id."<br>  \n";
}




crmgetHolidayById

(Version >= 3.7)

Syntax:

array crmgetHolidayById( int $year )

Beschreibung:

Gibt ein Array mit Information eines Feiertages anhand des Ids zurück..

Eigenschaften von holiday array:

sind die selben wie crmgetHolidays

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetHolidayById(
		array(
			'session_id'	=> $session_id,
			'id'			=> 123
		)
	);
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}
 
if ($result['id']) {
	echo "Subject: ". $result->subject ."<br>  ";
	echo "Date: ". $result->day ."-". $result->month ."-". $result->year;
}
else {
	echo "No Holiday found for this id!";
}



crmgetHolidaysUser

Syntax:

array crmgetHolidaysUser( array( string $session_id, int $year, int $userid) )

Beschreibung:

Liefert ein Array mit Holiday-Objekten für einen User.

Eigenschaften von zurückgegebenen Array:

sind die selben wie für crmgetHolidays

Beispiel:

<?php
 
try { 
	$result = $logon->crmgetHolidaysUser(
		array(
			'session_id'	=> $session_id,
			'year'			=> 2008,
			'userid'		=> 4
		)
	);
 
	foreach($result as $hday) {
		echo $hday->day.".".$hday->month.".".$hday->year." - ".$hday->subject."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetLanguage

Syntax:

string crmgetLanguage ( array( string $session_id) )

Beschreibung:

Gibt den ISO-639-1 Sprach-Code der momentan verwendeten Sprache zurück.

Beispiel:

<?php
 
try {
	$language = $logon->crmgetLanguage( array('session_id' => $session_id) );
	echo $language;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetList

Syntax:

array crmgetList ( array( string $session_id, string $list) )

Beschreibung:

Liefert ein Array von Listenelementen für eine definierte Liste.

Hinweis: Sie können den Namen der Liste erhalten, indem Sie im TecArt-System unter Administration→Listen auf Liste→Öffnen Rechtsklicken.

Eigenschaften:

Type            Eigenschaft                Beschreibung
-------------------------------------------------------------------
int   	        Objekt Attribute	   ID der Liste
string   	    Objekt Value     	   Name der Liste

Beispiel:

<?php
 
try {
	echo "Get List 'categories':<br>  \n";
	$result = $logon->crmgetList(
		array(
			'session_id'	=> $session_id,
			'list'			=> 'category'
		)
	);
   
	$lists = get_object_vars($result);
 
	foreach($lists as $id => $name) {
		echo "{$id}, {$name}<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetUserIds

Syntax:

string crmgetUserIds ( array( string $session_id) )

Beschreibung:

Liefert eine Arry mit aller user_ids.

Beispiel:

<?php
 
try {
	$result = $logon->crmgetUserIds( array('session_id' => $session_id) );
 
	foreach($result as $id) {
		echo $id. '<br>';
   }
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetUserOption

Syntax:

string crmgetUserOption( array( string $session_id, string $option) )

Beschreibung:

Liefert ein Ergebnis als String zurück.

Dieses String kann auch eine Array sein, wenn das Ergebnis komplexe Werte hat.

Beispiel für input $option:

Option               Value                     Beschreibung
------------------------------------------------------------------------------
groups               String                    Gruppe, zu den der User gehört.
access_email         String                    Zugang zu E-Mail-Client
email                String                    Email Adress
.
.
.

Beispiel 1:

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

Beispiel 2:

<?php
 
try { 
	$result = $logon->crmgetUserOption(
		array(
			'session_id'	=> $session_id,
			'option'		=> 'groups'
		)
	);
 
	foreach($result as $group) {
		echo $group ."<br>";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetUserOptions

Syntax:

array crmgetUserOptions( array( string $session_id) )

Beschreibung:

Liefert ein Objekt mit Optionen.

Eigenschaften von zurückgegebenen options Objekt:

Type            Eigenschaft     Beschreibung
-----------------------------------------------
string          $option   	Name der Option
string   	    $value   	Wert der Option

Beschreibung of options:

Option              Value           Beschreibung
-----------------------------------------------
access_owndocs       0|1            Zugang zu eigenen Dokumenten
access_email         0|1            Zugang zu E-Mail-Client
access_todo          0|1            Zugang zu Aufgaben
access_dates         0|1            Zugang zu Terminen
access_contacts      0|1            Zugang zu Kontakten 
access_documents     0|1            Zugang zu gemeinsamen Dokumenten
access_calls         0|1            Zugang zu Anrufen
access_projects      0|1            Zugang zu Projekten
access_forum         0|1            Zugang zu Forum
access_finances      0|1            Zugang zu Finanzen
access_contracts     0|1            Zugang zu Verträgen
access_offers        0|1            Zugang zu Angeboten 
access_domains       0|1            Zugang zu Domains
access_accounts      0|1            Zugang zu Accounts
access_vacations     0|1            Zugang zu Urlaubsplanung
access_rotas         0|1            Zugang zu Dienstplanung

Beispiel:

<?php
 
try {
	$result		= $logon->crmgetUserOptions( array('session_id' => $session_id) );
	$options	= get_object_vars($result);
 
	foreach($options as $key => $val) {
		echo $key." -> ".$value."<br>\n";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmsetUserOption

Syntax:

int crmsetUserOption( array( string $session_id, string $option) )

Beschreibung:

Setz eine User Option.

Gibt 1 beim Erfolg zurück.

Eigenschaften von zurückgegebenen options Objekt:

sind die selben wie für crmgetUserOptions

Beispiel :

<?php
 
try {
	$option		= array('option' => 'access_email', 'value' => 1);
	$success	= $logon->crmsetUserOption(
		array(
			'session_id'	=> $session_id,
			'option'		=> $option
		)
	);
 
	echo $option;
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetUsers

Syntax:

object crmgetUsers ( array(string $session_id) )

Beschreibung:

Liefert ein Objekt von Benutzer-Objekten mit allen Benutzern.

Eigenschaften:

Type            Eigenschaft         Beschreibung
-------------------------------------------------------------------
int   	    $id   	            Userid
string   	$name   	        Angezeigter Nutzername
string    	$address    	    Addresse
int   	    $birthday   	    Geburtstag (Unix Timestamp)
int   	    $chgtime   	        Unix-Timestamp der letzten Änderung
int   	    $chguser   	        Userid der letzten Änderung
string   	$city   	        Stadt
string   	$company   	        Firmenname
string   	$country   	        Land
int   	    $createtime   	    Unix-Timestamp der Erstellung
int   	    $createuser   	    Userid der Erstellung
string   	$department   	    Abteilung
string   	$description   	    Beschreibung
string   	$email   	        E-Mail-Addresse
string   	$fax   	            Faxnummer
string   	$firstname   	    Vorname
string   	$group_id   	    Group-Ids, Format: Groupid1:Groupid2
int   	    $locked   	        Benutzer ist gesperrt
string   	$login   	        Login
string   	$tel1   	        Telefonnummer
string   	$tel2   	        Mobilnummer
string   	$postcode   	    Postleitzahl
string   	$profession         Beruf
string   	$remoteaddr         Remote-IP für Zugriffs-Beschränkungen
string   	$surname   	        Nachname
int   	    $take_rights   	    Rechte von Gruppen übernehmen
binary   	$userpic_data       Daten des Benutzerbilds - base64-codiert
string   	$userpic_name       Name des Benutzerbilds
string   	$website   	        Website
string   	$middlename         Zweiter Vorname
string   	$suffix             Suffix
string   	$spouce             Name des Ehepartners
string   	$children           Namen der Kinder
string   	$email1             E-Mail 1
string   	$email2             E-Mail 2
string   	$email3             E-Mail 3
string   	$nickname           Spitzname
string   	$screenname1        Screenname 1
string   	$screenname2        Screenname 2
string   	$screenname3        Screenname 3
string   	$home_address1      Private Adresse 1
string   	$home_address2      Private Adresse 2
string   	$home_postcode      Private Adresse PLZ
string   	$home_city          Private Adresse Stadt
string   	$home_region        Private Adresse Region
string   	$home_country       Private Adresse Land
string   	$home_website       Private Adresse Website
string   	$other_address1     Andere Adresse 1
string   	$other_address2     Andere Adresse 2
string   	$other_postcode     Andere Adresse PLZ
string   	$other_city         Andere Adresse Stadt
string   	$other_region       Andere Adresse Region
string   	$other_country      Andere Adresse Land
string   	$phone_work         Telefonnummer geschäftlich 1
string   	$phone_work2        Telefonnummer geschäftlich 2
string   	$phone_home         Telefonnummer privat 1
string   	$phone_home2        Telefonnummer privat 2
string   	$phone_fax          Telefonnummer Fax
string   	$phone_fax_work     Telefonnummer Fax geschäftlich
string   	$phone_pager        Telefonnummer Pager
string   	$phone_mobil        Telefonnummer Mobil
string   	$phone_mms          Telefonnummer MMS
string   	$phone_sms          Telefonnummer SMS
string   	$phone_car          Telefonnummer Auto
string   	$phone_radio        Telefonnummer Radio
string   	$phone_assistant    Telefonnummer Assistant
string   	$managername        Managername
string   	$assistantname      $assistantname
string   	$customer_id        Kunden-ID
string   	$accountname        Account-Name
string   	$custom1            Benutzerdefiniert 1
string   	$custom2            Benutzerdefiniert 2
string   	$custom3            Benutzerdefiniert 3
string   	$custom4            Benutzerdefiniert 4
string   	$custom5            Benutzerdefiniert 5
string   	$custom6            Benutzerdefiniert 6
string   	$custom7            Benutzerdefiniert 7
string   	$custom8            Benutzerdefiniert 8
string   	$custom9            Benutzerdefiniert 9
string   	$custom10           Benutzerdefiniert 10

Beispiel:

<?php
 
try {
	$result = $logon->crmgetUsers( array('session_id' => $session_id) );
   
	foreach($result as $user) {
		echo $user->id." ".$user->name." - ".$user->email."<br>  ";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetAuthUserInfo

Syntax:

object crmgetAuthUserInfo( array( string $session_id) )

Beschreibung:

Gibt Information des authentifizierten Benutzers zurück.

Eigenschaften von zurückgegebenen options Objekt:

sind die selben wie für crmgetUsers

Beispiel :

<?php
 
try { 
	$result	= $logon->crmgetAuthUserInfo( array('session_id' => $session_id) );
	$user	= get_object_vars($result);
 
	foreach($user as $key => $value) {
		echo $key .': '. $value. '<br>';
    }
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



crmgetVersion

(Version >= 3.4.5391)

Syntax:

string crmgetVersion( array( string $session_id))

Beschreibung:

Gibt die TecArt-System Versionsnummer zurück.

Beispiel:

<?php
 
try { 
	$version = $logon->crmgetVersion(array('session_id' => $session_id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $version;



crmgetAccessOptions

(Version >= 3.4.5391)

Syntax:

array crmgetAccessOptions( array( string $session_id))

Beschreibung:

Gibt ein Array mit Informationen über den Zugriff auf die TecArt-System Module des authentifizierten Benutzers.

Eigenschaften von user options array:

Type            Eigenschaft     Beschreibung
-----------------------------------------------
string          Key      	Name der Option
int     	    Value   	Wert der Option

Beschreibung of user options:

Option              Value           Beschreibung
-----------------------------------------------
access_owndocs       0|1            Zugriff zu Eigene Dokumente
access_email         0|1            Zugriff zu E-Mail-Client
access_todo          0|1            Zugriff zu Aufgaben
access_dates         0|1            Zugriff zu Terminen
access_contacts      0|1            Zugriff zu Kontakten 
access_documents     0|1            Zugriff zu Gemeinsame Dokumente
access_calls         0|1            Zugriff zu Anrufe
access_projects      0|1            Zugriff zu Projekte
access_forum         0|1            Zugriff zu Forum
access_finances      0|1            Zugriff zu Finanzen
access_contracts     0|1            Zugriff zu Verträgen
access_offers        0|1            Zugriff zu Angeboten
access_domains       0|1            Zugriff zu Domainverwaltung
access_accounts      0|1            Zugriff zu Accountverwaltung 
access_vacations     0|1            Zugriff zu Urlaubsplanung
access_rotas         0|1            Zugriff zu Dienstplan

Beispiel:

<?php
 
try {   
	$crmapi_logon = crmapi::logon();
   
	$result = $logon->crmgetAccessOptions(array('session_id' => $session_id));
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $key => $value) {
	echo $key . ': ' . $value .'<br>';
}



crmgetAssocOptions

(Version >= 3.4.5391)

Syntax:

array crmgetAssocOptions( array( string $session_id, array $option))

Beschreibung:

Liefert ein associative array mit Options von allen Users zurück.

Beispiel für input $option :

sind die selben wie für crmgetUserOption.

Eigenschaften des zurückgelieferten Arrays:

Option               Value                       Beschreibung
------------------------------------------------------------------------------
key                  Int                         UserID
value                String                      Value der Option

Beispiel :

<?php
 
try {
	$params = array( 'session_id' => $session_id, 'option' => 'email' );
	$result = $logon->crmgetAssocOptions( $params );
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach( $result as $key => $value ) {
	echo 'User ID '. $key . ' has email : '. $value .'<br>';
}



crmPing

(Version >= 3.4.5391)

Syntax:

int crmPing( array( string $session_id) )

Beschreibung:

Erneuert die Session, überprüft ob die Session-ID aktuell ist oder nicht.

Gibt 1 beim Erfolg zurück.

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

Beispiel:

<?php
 
try {
	$success = $logon->crmPing( array("session_id" => $session_id) );
 
	if ($success == 1) {
		echo 'Ping success';
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}



crmPingMD5

(Version >= 3.4.5391)

Syntax:

int crmPingMD5( array( string $realm) )

Beschreibung:

Erneuert die Session, überprüft mithilfe von Nutzername und Passwort ob die Session-ID aktuell ist oder nicht.

Gibt 1 beim Erfolg zurück.

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

$realm ist die MD5-Summe der Verkettung von Benutzername und Passwort.

Beispiel:

<?php
 
try { 
	$success = $logon->crmPingMD5( array('realm' => md5($usernam.$password)) );
 
	if ($success == 1) {
		echo 'Ping success';
	}
}
catch (CRMException $e) {
	echo $e->getMessage();
}



crmLoginExternal

(Version >= 3.4.5391)

Syntax:

string LoginExternal( string $login, string $external_pass )

Beschreibung:

Logged einen User mit dem externen Passwort in das TecArt-System ein.

Gibt den Session-ID beim Erfolg zurück.

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

Beispiel:

<?php
 
try { 
	$session_id = $logon->LoginExternal('test', 'external');
 
	echo $session_id;
}
catch (CRMException $e) {
	echo $e->getMessage();
}



crmsetList

(Version >= 4.3)

Syntax:

int crmsetList( array( string $session_id, string $name, array $crmListItems)

Beschreibung:

Möglichkeit, die Liste mit dem übergebenen Namen aus $name mit Werten zu befüllen. Bei Erfolg wird true zurückgegenen.

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

crmListItems ist ein Array von assoziativen Arrays oder Objekten.

Eigenschaften für $crmListItems:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int		  $key		       Indexwert des Listeneintrages (wenn nicht gesetzt, wird automatischer Wert ermittelt)
int		  $position	       Position des Listeneintrages zur Sortierung (wenn nicht gesetzt, wird Position = 0 gesetzt)
string		  $de		       Angezeigter Wert des Listeneintrages für Sprache: Deutsch
string		  $en		       Angezeigter Wert des Listeneintrages für Sprache: Englisch
.
.
.
string		  $vn		       Angezeigter Wert des Listeneintrages für Sprache: Vietnamesisch

Angezeigter Wert des Listeneintrages ist Abhängig von den im System verfügbaren aktiven Sprachen.

Beispiel 1:

<?php
 
$values = array(
	array(
		'key'      => 'testkey1',
		'position' => 1,
		'de'       => 'Neuer Listen-Eintrag #1',
		'en'       => 'New list item #1'
	),
	array(
		'de'       => 'Neuer Listen-Eintrag #2',
		'en'       => 'New list item #2'
	)
);
 
try {
	$res = $logon->crmsetList(
		array(
			'session_id'	=> $session_id,
			'name'			=> 'testliste',
			'crmListItems'	=> $values
		)
	);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
print $res.'<br>';