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

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

2. Klasse

crmactivities

3. Methoden

3.1. crmgetActivities

(Version >= 3.4.5400)

Syntax:

array crmgetActivities( array(string $session_id, int $object_id, int $type, int $filter, int $count, int $offset, string $sort) )

Beschreibung:

Gibt ein Array mit Aktivitäten von einem Objekt zurück.

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

  • $obj_id ist die ID des Objektes. (obligatorisch)

  • $type ist die Type des Objektes (obligatorisch)

  • $type = 0 : Aktivitäten von Kontakt holen

  • $type = 1 : Aktivitäten von Projekt holen

  • $type = 2 : Aktivitäten von Ticket holen

  • $type = 3 : Aktivitäten von Auftrag holen (ab CRM Version 4.9.23696)

  • $filter ist die Dezimalwerte einer binäre Bitmaske, die entscheidet, welche Aktivitäten geholt werden sollen. (obligatorisch)

  • Wenn $count auf -1 gesetzt ist, werden alle Aktivitäten zurückgegeben.

  • $offset ist die Offset Position der Ergebnisse, die zurückgegeben werden sollen.

  • $sort ist die Sortierung der Array.

  • $sort = 'type' : Nach Type der Aktivitäten sortieren

  • $sort = 'subject' : Nach Subjeckt der Aktivitäten sortieren

  • $sort = 'chgtime_desc' : Nach dem Änderungsdatum der Aktivitäten absteigend sortieren

  • $sort = 'chgtime_asc' : Nach dem Änderungsdatum der Aktivitäten aufsteigend sortieren

  • $sort = 'start_desc' : Nach dem Startdatum der Aktivitäten absteigend sortieren

  • $sort = 'start_asc' : Nach dem Startdatum der Aktivitäten aufsteigend sortieren

Eigenschaften der binäre Bitmaske:

Modul      Binär   Hexadezimal

Notiz    = 0010000  (32)
Email    = 0010000  (16)
Ticket   = 0001000  (8)
Aufgabe  = 0000100  (4)
Anrufe   = 0000010  (2)
Termin   = 0000001  (1)
                                                
z.B., Ticket AND Anrufe 
Ticket   = 0001000  (8)
Anrufe   = 0000010  (2)
--------------------------
bitwise  = 0001010  (10)

Eigenschaften der zurückgegebenen activities array:

Wenn Objekt ein Ticket ist, dann werden beim gesetzten 'Ticket-Modul' die Ticket Aktionen zurückgegeben.

Type(Length)            Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     $id                       Id
string                  $type                     Type der Aktivität
string                  $subject                  Subjekt der Aktivität
int                     $chgtime                  Unix-Timestamp der letzten Änderung
int                     $start                    Unix-Timestamp der Startzeit
int                     $atype                    Ticket action type
                                                  0: intern
                                                  1: extern

Beispiel:

<?php
 
try {
	include_once 'crm_rest_api.php';
 
	$activities = new crm_rest_api("http://hostname/dirname/rest/index.php/activities");
 
	//Get all activities for ticket with ID 4:
	$result = $activities->crmgetActivities( array(
			'session_id'	=> $session_id,
			'object_id'		=> 4,
			'type'			=> 2,
			'filter'		=> 63 // alle Aktivitäten
   		) 
	);
 
	foreach($result as $activity) {
		echo $activity->type. " " .$activity->subject. "<br>";
	}
}
catch (Exception $e) {
	echo 'Exception abgefangen: ' .$e->getMessage(). "\n";
}



  • No labels