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

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

2. Methoden

 

Seit Version 4.4 sind die Methoden, die seit Version 4.1 zur Verfügung stehen, den Namenskonventionen der Schnittstellen und Webservices angepasst worden. Methodennamen des SOAP Objektes, die in Ihrem Code noch in underscore_case geschrieben sind (bspw. crmget_notes() ), sollten in camelCase geändert werden.

2.1. crmgetNote

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetNote( string $session_id, int $note_id )

Beschreibung: Gibt ein SoapVar Array mit note-Objekt zurück.

Eigenschaften des zurückgegebenen note-Objektes:

sind identisch mit crmgetNotes

Beispiel:

<?php
  
ini_set("soap.wsdl_cache_enabled", "0");
  
try {
    $options['stream_context'] = stream_context_create(
        array(
            'ssl' => array(
                'SNI_enabled' => true,
                'verify_peer' => false,
                'verify_peer_name' => false
            )
        )
    );
 
 
    $client_logon  = new SoapClient("https://test.tecart-system.de/soap/index.php?op=logon&wsdl", $options);
    $session_id    = $client_logon->crmLogin('root', 'root');
 
    if (!$session_id) {
        die("invalid login");
    }
 
    $client_notes   = new SoapClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl", $options);
    $notes           = $client_notes->crmgetNote($session_id, 12);
    echo '<pre>'.print_r($notes,true).'</pre>';
}
catch (SoapFault $f) {
    print $f->faultstring;
}

2.2. crmgetNotes

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetNotes( string $session_id, int $userid, int $day, int $month, int $year )

Beschreibung:

Gibt ein SoapVar Array mit note- Objekten zurück.

Wenn $userid gegeben ist, werden die Notizen dieses Benutzers nur zurückgegeben, wenn der authentifizierte Benutzer die entsprechenden Berechtigungen zum Lesen hat. Wenn $userid auf 0 gesetzt ist, werden die Notizen des authentifizierten Benutzer zurückgegeben.

Wenn $day gesetzt ist, werden nur Notizen von diesem Tag zurückgegeben. Setzen Sie ihn auf 0, um alle Tage zu bekommen.

Wenn $month gesetzt ist, werden nur Notizen von diesem Monat zurückgegeben. Setzen Sie ihn auf 0, um alle Monate zu bekommen.

Wenn $year gesetzt ist, werden nur Notizen von diesem Jahr zurückgegeben. Setzen Sie ihn auf 0, um alle Jahr zu bekommen.

Eigenschaften der zurückgegebenen note Objekte:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     id                        Call-Id
int                     ext_id                    Externe ID ( ab Version 4.2 )
string(255)             cid                       Contact-Id (Format: Contact-Id:Person-Id;Contact-Id2:Person-Id2;...) 
int                     pid                       Project-Id
int                     ticket_id                 Ticket-Id
int                     orderid                   Auftrag-Id ( ab Version 4.2 )
int                     date                      Datum und Uhrzeit (Unix-Timestamp)
string(255)             subject                   Betreff der Notiz
string(4000)            note_text                 Notiztext
string(255)             userid                    Userids der angesprochenen Benutzer (Format: User-Id1:User-Id2:...) 
string(255)             seen                      Userids der Benutzer, die die Notiz gelesen haben (Format: User-Id1:User-Id2:...)
int                     chguser                   Userid der letzten Änderung
int                     chgtime                   Unix-Timestamp der letzten Änderung
string(255)             category                  Kategorien, Format: Category1; Category2; ... 
int                     rem                       Wiedervorlage (1: Erinnerung an Notiz, and 0: keine Erinnerung)
int                     remtime                   Unix-Timestamp der Anruf- Wiedervorlage
int                     private                   Private Notiz (1: Notiz ist privat, 0: Notiz ist öffentlich) 
array                   note_contacts             Array mit crm_note_contact Objekten

Eigenschaften von note_contacts:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
string(255)             cid                       Contact Id ( Format: Cid:Pid )
int                     ext_id                    Externe ID ( ab Version 4.2 )
string(128)             firstname                 Vorname
string(128)             lastname                  Nachname
string(128)             displayname               Name, der in Listen erscheint
string(128)             nickname                  Spitzname 
string(255)             emailadr1                 Erste E-Mail-Addresse
string(255)             emailadr2                 Zweite E-Mail-Addresse 
int                     email_format              Bevorzugtes E-Mail-Format 
                                                   0 = Text
                                                   1 = HTML
string(128)             screen_name               Screen Name, z.B. Messenger-Account 
string(128)             phone_work                Telefonnummer Geschäftlich
string(128)             phone_home                Telefonnummer Privat 
string(128)             phone_fax                 Faxnummer Arbeit
string(128)             phone_pager               Pager Nummer 
string(128)             phone_mobil               Mobilnummer
string(128)             home_address1             Adresszeile privat 1 
string(128)             home_address2             Adresszeile privat 2 
string(128)             home_city                 Stadt 
string(128)             home_region               Region 
string(128)             home_postcode             Postleitzahl
string(128)             home_country              Land 
string(128)             home_website              Persönliche Website 
string(128)             work_title                Titel, z.B. CEO 
string(128)             work_department           Abteilung
string(128)             work_organisation         Organisations- oder Firmenname  
string(128)             work_address1             Adresszeile geschöftlich 1 
string(128)             work_address2             Adresszeile geschöftlich 2 
string(128)             work_city                 Stadt
string(128)             work_region               Region 
string(128)             work_postcode             Postleitzahl
string(128)             work_country              Land
string(255)             work_website              Offizielle Firmen-Website 
string(255)             custom1                   Benutzerdefiniertes Feld 1 
string(255)             custom2                   Benutzerdefiniertes Feld 2 
string(255)             custom3                   Benutzerdefiniertes Feld 3 
string(255)             custom4                   Benutzerdefiniertes Feld 4 
string(65535)           notes                     Notizen (Beschreibung des Kontakts)
string                  picture                   Kontakt-Bild-Daten - Base64-kodiert
int                     chguser                   Userid der letzten Änderung
int                     chgtime                   Unix-Timestamp der letzten Änderung
int                     createuser                Userid der Erstellung
int                     createtime                Unix-Timestamp der Erstellung

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_notes  = new SoapClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl");
 
	//Get all Notes for Feb 21 2014:
	$result = $client_notes->crmgetNotes($session_id, -1, 21, 2, 2014);
 
	foreach($result as $note) {
 
		foreach($note as $key => $val) {
        	echo "$key => $val<br>\n";
			if (is_array($val)) {
				echo serialize($val);
			}
		}
    }
}
catch (SoapFault $f) {
	print $f->faultstring;
}

2.3. crmgetNotesFrom

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetNotesFrom( string $session_id, int $userid, int $day, int $month, int $year )

Beschreibung:

Gibt ein SoapVar Array mit note- Objekten vom gegebenen Datum an zurück. Schlußdatum ist das aktuelle Maximum des Unix Timestamp (Stand Feb. 2014: 12/31/2037)

Wenn $userid gegeben ist, werden Notizen für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn $userid auf 0 gesetzt wird, werden alle Notizen für den authentifizierten Nutzer zurückgegeben.

Wenn $day gesetzt ist werden nur Notizen von diesem Tag zurückgegeben. Auf 0 gesetzt werden alle Tage zurückgegeben.

Wenn $month gesetzt ist werden nur Notizen von diesem Monat zurückgegeben. Auf 0 gesetzt werden alle Monate zurückgegeben.

Wenn $year gesetzt ist werden nur Notizen von diesem Jahr zurückgegeben. Auf 0 gesetzt werden alle Jahre zurückgegeben.

Eigenschaften der zurückgegebenen note- Objekte:

sind identisch mit crmgetNotes

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_notes    = new SoapClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl");
 
	//Get all Notes starting from Feb. 21 2014:
	$result = $client_notes->crmgetNotesFrom($session_id, -1, 21, 2, 2014);
 
	foreach($result as $note) {
 
		foreach($note as $key => $val) {
			echo "$key => $val<br>\n";
			if (is_array($val)) {
				echo serialize($val);
			}
       }
 
       echo "<hr/>";
	}
}
catch (SoapFault $f) {
	print $f->faultstring;
}

2.4. crmgetNotesList

(Version >= 4.4)

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetNotesList( string $session_id, [int $timestamp] )

Beschreibung:

Gibt ein SoapVar Array mit note- Objekten zurück, die ab dem gegebenen Datum angelegt worden sind und als persönliche Notizen des angemeldeten Anwenders gelten.

Notizen gelten als persönliche Notiz, wenn das Objekt keine Zuordnung zu einem Projekt, Ticket, Auftrag oder Kontakt besitzt und der angemeldete Anwender in der Liste der betreffenden Benutzer eingetragen ist.

$timestamp ist ein Unix-Timestamp. Wenn übergeben, werden nur persönliche Notizen zurückgegeben, die seit dem gegebenen Zeitstempel angelegt worden sind.

Eigenschaften der zurückgegebenen $notes array:

sind identisch mit crmgetNotes

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_notes    = new SoapClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl");
 
	//Get all personal Notes starting from Feb. 21 2014:
	$timestamp = mktime(0, 0, 0, 2, 21, 2014);
	$result = $client_notes->crmgetNotesList($session_id, $timestamp);
 
	foreach($result as $note) {
 
		foreach($note as $key => $val) {
			echo "$key => $val<br>\n";
			if (is_array($val)) {
				echo serialize($val);
			}
       }
 
       echo "<hr/>";
   }
}
catch (SoapFault $f) {
  print $f->faultstring;
}

2.5. crmgetChangedNotes

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetChangedNotes( string $session_id, int $userid, int $timestamp )

Beschreibung:

Gibt ein SoapVar Array mit note- Objekten zurück, die seit $timestamp geändert wurden.

Wenn $userid gegeben ist, werden Notizen für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn $userid auf 0 gesetzt wird, werden alle Notizen für den authentifizierten Nutzer zurückgegeben.

Eigenschaften von returned note-Objects:

sind identisch mit crmgetNotes

Beispiel:

<?php
 
// get Notes modified within the last 30 days:
$result = $client_notes->crmgetChangedNotes($session_id, 0, time() - (86400 * 30));
 
foreach($result as $note) {
 
   foreach($note as $key => $val) {
       echo "$key => $val<br>\n";
       if (is_array($val)) echo serialize($val);
   }
 
   echo "<hr/>";
}




2.6. crmgetChangedNotesLimit

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetChangedNotesLimit( string $session_id, int $userid, int $timestamp, int $count, int $offset )

Beschreibung:

Gibt ein SoapVar Array mit note-Objekten zurück, die seit $timestamp geändert wurden, limitiert von $count und $offset.

Wenn $userid gegeben ist, werden Notizen für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn $userid auf 0 gesetzt wird, werden alle Notizen für den authentifizierten Nutzer zurückgegeben.

Eigenschaften von returned note-Objects:

sind identisch mit crmgetNotes

Beispiel:

<?php
 
//Get the latest 5 notes modified within the last 30 days:
$result = $client_notes->crmgetChangedNotesLimit($session_id, 0, time() - (86400 * 30), 5, 0);
 
foreach($result as $note) {
 
    foreach($note as $key => $val) {
        echo "$key => $val<br>\n";
        if (is_array($val)) {
            echo serialize($val);
		}
    }
 
   echo "<hr/>";
}
 

2.7. crmaddNote

Syntax:

int <note_id> | string <err_msg> crmaddNote( string $session_id, crm_note_item $crm_note_item )

Beschreibung:

Fügt eine neue Notiz hinzu.

Gibt die note_id bei Erfolg zurück, 0 bei einem Fehler und -1 wenn die Notiz bereits existiert, Fehlermeldung bei aufgefangenen Ausnahmen

$crm_note_item kann ein assoziatives Array oder ein Objekt sein.

Um Kontakte zuzuweisen, müssen Sie die Contact-IDs oder einige Eigenschaften des Kontakts aus $crm_note_item→note_item_contacts angeben, das System erledigt den Rest.

Eigenschaften von crm_note_item:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
string(255)             cid                          Contact-Id (Format: Contact-Id:Person-Id;Contact-Id2:Person-Id2;...) 
int                     ext_id                       Externe ID ( ab Version 4.2 )
int                     date                         Datum und Uhrzeit (Unix-Timestamp)
string(255)             subject                      Betreff der Notiz
string(4000)            note_text                    Notiztext
string(255)             userid                       Userids (Format: User-Id1:User-Id2), -1 for NO userid
int                     pid                          Project-Id 
int                     ticket_id                    Ticket-Id
int                     orderid                      Auftrag-Id ( ab Version 4.2 )
string(255)             $category                    Kategorien, Format: Category1; Category2; ... 
int                     rem                          Wiedervorlage (1: wenn Sie eine Erinnerung möchten und 0 wenn nicht)
int                     remtime                      Unix-Timestamp für die Erinnerung
int                     private                      Private Notiz (1: Notiz ist privat, and 0: Notiz ist öffentlich) 
int                     notify                       Benachrichtigung gesetzt ( 1: benachrichtigen, 0: nicht benachrichtigen )
array                   note_contacts                Array von crm_note_item_contact Objekten

Eigenschaften von crm_note_item_contact:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
string(255)             cid                          Contact Id ( Format: Cid:Pid )
string(128)             firstname                    Vorname
string(128)             lastname                     Nachname
string(128)             displayname                  Name, der in Listen erscheint 
string(128)             nickname                     Spitzname 
string(255)             emailadr1                    Erste E-Mail-Addresse
string(255)             emailadr2                    Zweite E-Mail-Addresse 
int                     email_format                 Bevorzugtes E-Mail-Format 
                                                      0 = Text
                                                      1 = HTML
string(128)             screen_name                  Screen Name, z.B. Messenger-Account 
string(128)             phone_work                   Telefonnummer Geschäftlich 
string(128)             phone_home                   Telefonnummer Privat 
string(128)             phone_fax                    Faxnummer Arbeit
string(128)             phone_pager                  Pager Nummer 
string(128)             phone_mobil                  Mobilnummer
string(128)             home_address1                Adresszeile privat 1 
string(128)             home_address2                Adresszeile privat 2 
string(128)             home_city                    Stadt
string(128)             home_region                  Region 
string(128)             home_postcode                Postleitzahl 
string(128)             home_country                 Land 
string(128)             home_website                 Persönliche Website 
string(128)             work_title                   Titel auf Arbeit, z.B. CEO 
string(128)             work_department              Abteilung
string(128)             work_organisation            Organisations- oder Firmenname  
string(128)             work_address1                Adresszeile Arbeit 1 
string(128)             work_address2                Adresszeile Arbeit 2 
string(128)             work_city                    Stadt
string(128)             work_region                  Region 
string(128)             work_postcode                Postleitzahl 
string(128)             work_country                 Land 
string(255)             work_website                 Offizielle Firmen-Website 
string(255)             custom1                      Benutzerdefiniertes Feld 1 
string(255)             custom2                      Benutzerdefiniertes Feld 2 
string(255)             custom3                      Benutzerdefiniertes Feld 3 
string(255)             custom4                      Benutzerdefiniertes Feld 4 
string(65535)           notes                        Notizen (Beschreibung des Kontaktes)

Beispiel:

<?php
$note = array(
	'cid'     => 0,
    'date'      => time(),
    'subject'   => "just a Test",
    'note_text'   => "Mary and her lamb",
    'userid'    => "4",
    'pid'     => 0,
  	'note_contacts'   => array(
    	array(
      		'firstname' => 'John',
      		'lastname'  => 'Smith',
      		'emailadr1' => 'j.smith@dont-spam-me.de'
    	),
    	array(
      		'firstname' => 'Johannes',
      		'lastname'  => 'Schmidt'
    	)
  	)
);
 
$note_id = $client_notes->crmaddNote($session_id, $note);
echo $note_id."<br>\n";

2.8. crmaddNotes

Syntax:

int | string <err_msg> crmaddNotes( string $session_id, crm_notes_items $crm_notes_items )

Beschreibung:

Fügt mehrere neue Notizen hinzu.

Gibt 1 bei Erfolg, 0 bei einem Fehlschlag zurück. Bei aufgefangenen Ausnahmen wird Fehlermeldung zurückgegeben.

Eigenschaften von $crm_notes_items:

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
crm_notes_items         crm_note_items            array mit crm_note_item Objekten

Beispiel:

<?php
$note1 = array(
	'cid'           => ''
    'pid'           => 0,
    'ticket_id'     => 0,
    'date'          => time(),
    'subject'       => 'Testnote 1',
    'note_text'     => 'Content of the test note 1',
    'category'      => 'miscellaneous; general',
    'rem'           => 1,
    'remtime'       => time()+86400,
    'note_contacts' => array(
    	array(
        	'firstname' => 'John',
             'lastname'  => 'Smith',
             'emailadr1' => 'johnsmith@trash-mail.com'
         ),
         array(
             'firstname' => 'Maximilian',
             'lastname'  => 'Mustermann',
             'emailadr1' => 'mustermann@trash-mail.de'
         )
     )
);
 
$note2 = array(
	'cid'           => '',
    'pid'           => 0,
    'orderid'       => 1234,
    'date'          => time(),
    'subject'       => 'Testnote 2',
    'note_text'     => 'Content of the test note 2',
    'category'      => 'general',
    'rem'           => 0,
    'remtime'       => 0,
    'note_contacts' => array(
    	array(
        	'firstname' => 'John',
            'lastname'  => 'Smith',
            'emailadr1' => 'johnsmith@trash-mail.com'
        ),
        array(
            'firstname' => 'Ethel',
            'lastname'  => 'Jones',
            'emailadr1' => 'jones_e@trash-mail.com'
        )
	)
);
             
$notes    = array('crm_note_items' => array($note1, $note2));
$success  = $client_notes->crmaddNotes($session_id, $notes);
 
if ($success != 1) {
	echo 'Error adding notes: '.$success;
}
else {
  	echo "Notes added successfully.";
}

2.9. crmchangeNote

Syntax:

int | string <err_msg> crmchangeNote( string $session_id, int $note_id, crm_note_item $crm_note_item )

Beschreibung:

Ändert Eigenschaften einer vorhandenen Notiz.

Liefert die note_id bei Erfolg, 0 bei einem Fehler, -2 wenn Notiz nicht gefunden wurde.

Bei aufgefangenen Ausnahmen wird Fehlermeldung zurückgegeben

$crm_note_item kann ein assoziatives Array oder ein Objekt sein.

Eigenschaften von crm_note_item:

sind identisch mit crmaddNote

Beispiel:

<?php
 
//change Note with ID 9228:
 
$note       = array('subject'   => 'Testnote CHANGED');
$note_id    = $client_notes->crmchangeNote($session_id, 9228, $note);

echo $note_id."<br>\n";

2.10. crmchangeNotes

Syntax:

int | string <err_msg> crmchangeNotes( string $session_id, crm_notes_items $crm_notes_items )

Beschreibung:

Ändert Daten vorhandener Notizen.

Liefert 1 bei Erfolg, 0 bei einem Fehler, Fehlermeldung bei aufgefangener Ausnahme

Eigenschaften von crm_notes_items:

sind identisch mit crmaddNotes

Beispiel:

<?php
 
// Change multiple notes with IDs 9233 and 9234:
$note1 = array(
	'id'        => 9233,
    'subject'   => 'Testnote 1 changed',
    'note_text' => 'Modified content of the test note 1',
    'rem'       => '0',
    'remtime'   => '0'
);
$note2 = array(
	'id'        => 9234,
    'subject'   => 'Testnote 2 changed',
    'note_text' => 'Modified content of the test note 2'
);
 
$notes = array('crm_note_items' => array($note1, $note2));
 
$success = $client_notes->crmchangeNotes($session_id, $notes);
if ($success < 1) {
	echo 'Error changing Notes, return: '.$success;
}
else {
	echo 'Notes successfully modified.';
}

2.11. crmdeleteNote

Syntax:

int | string <err_msg> crmdeleteNote( string $session_id, int $note_id )

Beschreibung:

Löscht eine Notiz mit übergebener ID. Liefert 1 bei Erfolg, 0 bei einem Fehler, Fehlermeldung bei aufgefangener Ausnahme.

Beispiel:

<?php
 
$success = $client_notes->crmdeleteNote($session_id, $note_id);
if ($success != 1) {
	echo 'Unable to delete Note, return: '.$success;
}
else {
  	echo 'Note deleted succesfully';
}

2.12. crmdeleteNotes

Syntax:

int | string <err_msg> crmdeleteNotes( string $session_id, string $note_ids )

Beschreibung:

Löscht mehrere Notizen. Gibt 1 bei Erfolg, 0 bei einem Fehler, Fehlermeldung bei aufgefangener Ausnahme zurück.

$note_ids ist ein Doppelpunkt-getrennter String mit Notiz IDs.

Beispiel:

<?php
 
// delete multiple notes with ID 9232 and 9234
 
$notes_ids = "9232:9234";
    
$success = $client_notes->crmdeleteNotes($session_id, $notes_ids);
   
if ($success != 1) {
	echo 'Unable to delete Notes, return: '.$success;
}
else {
	echo 'Notes deleted';
}

2.13. crmgetNoteIds

Syntax:

SoapVar SOAP_ENC_ARRAY crmgetNoteIds( string $session_id, int $userid, int $timestamp )

Beschreibung:

Gibt ein SoapVar Array mit note- Objekten zurück, die seit $timestamp geändert wurden.

Wenn $userid gegeben ist, werden Notizen für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn $userid auf 0 gesetzt wird, werden alle Anrufe für den authentifizierten Nutzer zurückgegeben.

Eigenschaften der zurückgegebenen note- Objekte:

Type(Length)            Eigenschaft                  Beschreibung
---------------------------------------------------------------------------------------------
int                     id                           Note-Id

Beispiel:

<?php
 
$result = $client_notes->crmgetNoteIds($session_id, 0, 0);
 
foreach($result as $note) {
   
     echo $note->id."<br>  ";
 
}

2.14. crmgetNoteIdsString

Syntax:

string crmgetNoteIdsString( string $session_id, int $userid, int $timestamp )

Beschreibung:

Gibt eine Zeichenkette mit Note IDs zurück, die seit $timestamp geändert wurden.

Wenn $userid gegeben ist, werden Notizen für den User nur zurückgegeben, wenn der authentifizierte Benutzer Leseberechtigungen hat. Wenn $userid auf 0 gesetzt wird, werden alle Notizen für den authentifizierten Nutzer zurückgegeben.

Beispiel:

<?php
 
$result = $client_notes->crmgetNoteIdsString($session_id, 0, 0);
 
$note_ids = implode(':', $result);
 
foreach($note_ids as $note_id) {
   
     echo $note_id."<br>  ";
 
}



2.15. crmgetIdByExtId

(Version >= 4.2)

Syntax:

array crmgetIdByExtId( string $session_id, string $external_id )

Beschreibung

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

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

Eigenschaften der zurückgegebenen note Objekte:

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

Beispiel:

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

2.16. crmgetAllExtIds

(Version >= 4.2)

Syntax:

array crmgetAllExtIds( string $session_id )

Beschreibung

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

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

Eigenschaften der zurückgegebenen note Objekte:

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

Beispiel:

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



2.17. crmsetReadFlag

(Version >= 4.4)

Syntax:

int|string crmsetReadFlag( string $session_id, int $note_id, [int $user_id] )

Beschreibung:

Fügt eine User ID der "gelesen" Liste eines Notiz Objektes hinzu.

$note_id muß immer eine ID eines Notiz Objektes sein.

Mit optionaler $user_id kann eine User ID spezifiziert werden. Wird $user_id ausgelassen oder mit $user_id = 0 übergeben, wird die ID des angemeldeten Anwenders verwendet.

Gibt ganzzahlig 1 für Erfolg, 0 bzw. eine Zeichenkette mit Fehlermeldung bei Fehlschlag zurück.

Beispiel:

<?php
 
try { 
  	// mark note with ID 1337 as "seen" for logged-in user
	$success = $client_notes->crmsetReadFlag($session_id, 1337);
}
catch (SOAPFault $f) {
  	print $f->faultstring;
}
 
echo ((int)$success == 1 ? 'successfully marked' : 'failed to mark the note');



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

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

2.20. crmgetPermissions

(Version >= 4.5.17365)

Syntax:

array crmgetPermissions( string $session_id, string $note_ids ) 

Beschreibung:

Gibt ein Array mit Elementen des Typs crmPermission mit den Berechtigungen für die Notizen mit den gegebenen $note_ids zurück.

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

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

note_ids ist eine mit Doppelpunkt getrennte Liste der IDs der Notizen.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            Note ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

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");

  	$client_notes = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl");
  	$session_id   = $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
	$result = $client_notes→crmgetPermissions($session_id, '81941:79331');

  	print_r($result);
} 
catch (SOAPFault $f) {

  	print $f->faultstring;
}

?>



2.21. crmsetPermissions

(Version >= 4.5.17365)

Syntax:

array crmsetPermissions( string $session_id, array $crmPermissions ) 

Beschreibung:

Setzt die Berechtigungen für mehrere Notizen.

Setzt eine Lizenz mit Aktivitätenrechten und aktivierte Aktivitätenrechte für dieses Modul voraus.

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

crmPermissions ist ein Array mit crmPermission Objekten.

Eigenschaften von crmPermission:

Type(Length)	  Eigenschaft                    Beschreibung
-------------------------------------------------------------------------------
int               $id                            Note ID
array             $crmUserPermissionElements     Array mit crmUserPermissionElement Objekte
array             $crmGroupPermissionElements    Array mit crmGroupPermissionElement Objekte

Eigenschaften von crmUserPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Userid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert

Eigenschaften von crmGroupPermissionElement:

Type(Length)      Eigenschaft                    Beschreibung
---------------------------------------------------------------------------------------
int               $id                            Groupid
int               $read                          1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $write                         1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert
int               $delete                        1 = gesetzt, 0 = nicht gesetzt, -1 = verweigert 

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");

  	$client_notes = new SOAPClient("https://test.tecart-system.de/soap/index.php?op=notes&wsdl");
  	$session_id   = $client_logon->crmLogin('test', 'test');
	if (!$session_id) {
		die("invalid login");
	}
	$permissions = array(
		array(
			'id'						=> 81941, 
			'crmUserPermissionElements' => array(
				array(
					'id' 		=> 56, 
					'read' 		=> 1, 
					'write'		=> 1, 
					'delete'	=> 1
				)
			), 
			'crmGroupPermissionElements' => array(
				array(
					'id'		=> 4, 
					'read'		=> -1, 
					'write'		=> -1,
					'delete'	=> -1
				)
			)
		),
		array(
			'id'							=> 79331,
			'crmGroupPermissionElements'	=> array(
				array(
					'id'		=> 4, 
					'read'		=> 1, 
					'write'		=> 1,
					'delete'	=> 1
				),
				array(
					'id'		=> 6,
					'read'		=> -1,
					'write'		=> -1,
					'delete'	=> -1
				)
			)
		)
    );

  	$client_notes->crmsetPermissions($session_id, array('crmPermissions' => $permissions));
} 
catch (SOAPFault $f) {

  	print $f->faultstring;
}

?>



  • No labels