API Activities

Hinweis

API Klassen und deren Funktionen können nur mit CRM System mit Version >= 3.2 genutzt werden

Methods

getActivities

(CRM >= 3.4.5142)

Syntax:

array getActivities( int $obj_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.

• $type ist die Type des Objektes

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

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

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

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

• 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

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 {
    $crmapi_activities = crmapi::activities();
 
    //Get all activities of Contact with ID:4, Sortierung nach dem Änderungsdatum der Aktivitäten absteigend
    $result = $crmapi_activities->getActivities(4, 0, 31, -1, -1, 'chgtime_desc');
}
catch (CRMException $e) {
    echo $e->getMessage();
}
 
foreach($result as $activity) {
    foreach($activity as $key => $val) {
        echo "$key => $val<br/>\n";
    }
    echo "<hr/>";
}
 
?>

---