Page tree
Skip to end of metadata
Go to start of metadata

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

1. Methods

1.1. Tickets

1.1.1. addTicket

Syntax:

int addTicket ( array $ticket )

Beschreibung:

Fügt ein Ticket hinzu.

Gibt eine ticket_id zurück.

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

Eigenschaften von ticket array:

Type(Length)      Eigenschaft          Beschreibung
------------------------------------------------------------------- 
int               $ext_id              Externe ID ( ab Version 4.2 )
string(255)       $cid                 Kontakt-ID
string(255)       $name                Name des Fragestellers
string(255)       $email               E-Mail-Adresse des Fragestellers
string(255)       $phone               Telefonnummer des Fragestellers ( ab Version 4.2.12947 )
int               $start               Start-Datum & -Zeit als Unix-Timestamp 
int               $stop                Stop-Datum & -Zeit als Unix-Timestamp 
int               $affected            User-Id des betroffenen Nutzers
int               $priority            Priorität. Mögliche Werte: 0->Eskalation, 1->Heute, 2->Hoch, 3->Normal, 4->Niedrig
string(255)       $subject             Ticketbetreff
string(255)       $notes               Ticketinhalt, Beschreibung, Notizen ...
int               $status              Ticketstatus. Mögliche Werte: 0->offen, 1->in Bearbeitung, 2->Wartet auf antwort, 3->geschlossen
int               $section             Ticketbereich (0 -> Standard)
int               $pid                 Projekt-ID
string(255)       $category            Ticketkategorie

 
string(255)       $user13              Benutzerdefiniertes Feld Nr. 13
string(255)       $user14              Benutzerdefiniertes Feld Nr. 14
   :                  :                           :
string(255)       $user80              Benutzerdefiniertes Feld Nr. 80 

Beispiel :

<?php
 
$ticket = array(
	'cid'         => 7,
	'name'        => 'Dr John',
	'email'       => 'ticket@tecart.de',
	'start'       => mktime(0, 0, 0, 5, 11, 2007),
	'stop'        => mktime(0, 0, 0, 5, 31, 2007),
	'affected'    => 30,
	'priority'    => 3,
	'subject'     => 'Ticket subject',
	'notes'       => 'Notice here',
	'status'      => 1,
	'category'    => 'Error in System / in Operation',
	'user21'      => '777'
);
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$ticket_id		= $crmapi_tickets->addTicket($ticket);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $ticket_id;



1.1.2. getTicket

Syntax:

array getTicket( int $ticket_id )

Beschreibung:

Gibt ein Array mit einem Ticket-Element zurück.

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

ticket_id ist die Ticket-Id

Properties:

Type(Length)      Eigenschaft             Beschreibung
-------------------------------------------------------------------
int               $id                  Ticket-ID 
int               $ext_id              Externe ID ( ab Version 4.2 )
string(255)       $cid                 Kontakt-ID
string(255)       $name                Name des Fragestellers
string(255)       $email               E-Mail-Adresse des Fragestellers
int               $tnumber             Ticketnummer
string(255)       $phone               Telefonnummer des Fragestellers ( ab Version 4.2.12947 )
int               $start               Start-Datum & Zeit als Unix-Timestamp 
int               $stop                Stop-Datum & Zeit als Unix-Timestamp 
int               $affected            User-Id des betroffenen Nutzers
int               $priority            Priorität. Mögliche Werte: 0->Eskalation, 1->Heute, 2->Hoch, 3->Normal, 4->Niedrig
string(255)       $subject             Ticketbetreff
string(255)       $notes               Ticketinhalt, Beschreibung, Notizen ...
int               $status              Ticketstatus. Mögliche Werte: 0->offen, 1->in Bearbeitung, 2->Wartet auf antwort, 3->geschlossen
int               $section             Ticketbereich (0 -> Standard)
int               $pid                 Projekt-ID
string(255)       $category            Ticketkategorie
int               $createuser          User-Id des Erstellers 
int               $createtime          Unix-Timestamp der Erstellung
int               $chguser             User-Id der letzten Änderung
int               $chgtime             Unix-Timestamp der letzten Änderung
string(255)       $user13              Benutzerdefiniertes Feld Nr. 13
string(255)       $user14              Benutzerdefiniertes Feld Nr. 14
   :                  :                           :
string(255)       $user80              Benutzerdefiniertes Feld Nr. 80 

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$ticket			= $crmapi_tickets->getTicket(1);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($ticket as $key=>$value) {
	echo $key . " => " . $value . "<br>  ";
}



1.1.3. countTickets

Syntax:

int countTickets()

Beschreibung:

Gibt die Gesamtanzahl an Tickets zurück.

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

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$amount			= $crmapi_tickets->countTickets();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $amount;
 



1.1.4. getTicketIds

Syntax:

array getTicketIds( int $timestamp )

Beschreibung:

Gibt ein Array mit Ticket-IDs zurück die seit timestamp geändert wurden.

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

Eigenschaften:

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

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Get all ticket ids
	$result = $crmapi_tickets->getTicketIds(0);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



1.1.5. changeTicket

Syntax:

int changeTicket( int $ticket_id, array $ticket )

Beschreibung:

Ändert Eigenschaften eines existierenden Tickets.

Gibt die ticket_id zurück.

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

Eigenschaften von crmTicketItem: same as for addTicket

Beispiel:

<?php
 
try {
	$ticket = array();
	$ticket['name'] = 'API-Ticket changed';
 
	$crmapi_tickets = crmapi::tickets();
 
	// change ticket with id = 1234
	$ticket_id = $crmapi_tickets->ChangeTicket(1234, $ticket);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $ticket_id;



1.1.6. getChangedTickets

Syntax:

array getChangedTickets ( int $timestamp )

Beschreibung:

Gibt ein Array mit Tickets die seit timestamp geändert wurde zurück.

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

Eigenschaften:

sind die selben wie für getTicket

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Get all tickets, that have been changed since 10.04.2007
	$tickets = $crmapi_tickets->getChangedTickets(1176208357);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($tickets as $ticket) {
	foreach($ticket as $key => $value) {
		echo $key . '=>' . $value . '<br>';
	}
	echo "<hr>";
}



1.1.7. getChangedTicketsLimit

Syntax:

array getChangedTicketsLimit( int $timestamp, int $count, int $offset )

Beschreibung:

Gibt ein Array mit Tickets zurück die seit timestamp geändert wurden, limitiert von count und offset.

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

Eigenschaften:

sind die selben wie für getTicket

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Get only 10 tickets, that have been changed since 10.04.2007
	$tickets = $crmapi_tickets->getChangedTicketsLimit(1176208357, 10, 0);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($tickets as $ticket) {
	foreach($ticket as $key => $value) {
		echo $key . '=>' . $value . '<br>';
	}
	echo "<hr>";
}



1.1.8. deleteTicket

Syntax:

void deleteTicket ( int $ticket_id )

Beschreibung:

Löscht ein Ticket.

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

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
   
	// Delete ticket with id = 123
	$tickets = $crmapi_tickets->deleteTicket(123);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.1.9. getResponsibleUser

Syntax:

int getResponsibleUser( int $section_id )

Beschreibung:

Gibt die Benutzer-ID des Standard-Benutzers für Webservices zurück, die in Administration> Module > Trouble-Tickets für den entsprechenden Bereich vergeben wurde.

section_id (optional), ID des Bereiches.

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

Beispiel:

<?php
 
try {
	$crmapi_tickets			= crmapi::tickets();
	$responsibler_userid	= $crmapi_tickets->getResponsibleUser();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $responsibler_userid;



1.1.10. getTicketGroup

Syntax:

int getTicketGroup(int $section_id = 0)

Beschreibung:

Gibt die Gruppen-Auswahl für verantwortliche Personen zurück, die in Administration> Module> Trouble-Tickets vergeben wurde.

section_id (optional), ID des Bereiches.

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

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$ticket_group	= $crmapi_tickets->getTicketGroup();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $ticket_group;



1.1.11. getMinMaxCreateTime

Syntax:

array getMinMaxCreateTime( int $cid )

Beschreibung:

Gibt ein Array mit der Min-und Max CreateTime aller Tickets für die eingegebene $cid.

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

Eigenschaften:

Type(Length)      Eigenschaft          Beschreibung
-------------------------------------------------------------------
int               $min                 Min createtime (Time Unix-Timestamp)
int               $max                 Max createtime (Time Unix-Timestamp)

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$result			= $crmapi_tickets->getMinMaxCreateTime();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo 'Min: '. date('m-d-Y', $result['min']);
echo 'Max: '. date('m-d-Y', $result['max']);



1.1.12. getTicketByCondition

Syntax:

array getTicketByCondition ( array $condition )

Beschreibung:

Gibt ein Array von Tickets zurück, welche mit den Bedingungen übereinstimmen. Die Bedingungen werden mit 'AND' verknüpft.

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

Eigenschaften von $condition Array:

Type(Length)      Eigenschaft          Beschreibung
------------------------------------------------------------------- 
int               $cid                 Kontakt-ID
int               $status              Ticketstatus. Mögliche Werte: 0->offen, 1->in Bearbeitung, 2->Wartet auf antwort, 3->geschlossen, -1-> alle außer abgeschlossene
int               $begin_time          Unix-Time : Erstellungszeit eines Tickets
int               $end_time            Unix-Time : Erstellungszeit eines Tickets

(nur mit der Version >= 3.4.5371) gibt's folgenden Params

int               $affected            User-ID des Zuständigers
int               $section             Bereich der Tickets
int               $pid                 Projekt-ID
int               $count               Anzahl der zuholenden Tickets
int               $offset              Die Offset Position der Ergebnisse, die zurückgegeben werden sollen.
string            $search              Der Suchstring. Es werden 2 Platzhalter am Anfang und Ender des Strings hinzugefügt.
array             $sorting             Eine Array mit: 
                                          $key   -> Name des sortierenden Feld ('createtime' oder 'subject' oder 'start' oder 'stop')
                                          $value -> Type der Sortierung        ('ASC' oder 'DESC')
array             $search_fields       Die Suchfelder. Wird nur benötigt, wenn $search gesetzt wird. Beim Default wird der Suchstring in den Feldern 'subject' oder 'notes' oder 'tnumber' oder 'email' oder 'name' gesucht.
                                       

Eigenschaften von zurückgegebenen Array:

sind die selben wie für getTicket

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	//Example 1: Get tickets, which are created from 01.01.2011 to 31.12.2011
	$condition = array('begin_time' => 1293836400, 'end_time' => 1325286000);
 
	//Example 2: Get tickets, which belong to contact id 4 and responsible user id 7
	$condition = array('cid' => 4, 'affected' => 7);
 
	//Example 3: Get tickets, which belong to contact id 4. Sorting ascending with 'createtime'.
	$sorting   = array('createtime' => 'ASC');
	$condition = array('cid' => 4, 'sorting' => $sorting);
 
	//Example 4: Search tickets with subject like '%crm%' or notes like '%crm%' AND belong to contact 4
	$search_fields = array('subject', 'notes');
	$condition = array('search' => 'crm', 'search_fields' => $search_fields, 'cid' => 4);
 
	//Example 5: Search tickets with subject like '%crm%' or notes like '%crm%' or tnumber like '%crm%' or email like '%crm%' or name like '%crm%'
	$condition = array('search' => 'crm');
 
	$tickets = $crmapi_tickets->getTicketByCondition($condition);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($tickets as $ticket) {
	echo 'Ticket ID: '. $ticket['id'] . '<br>;
	echo 'Subject: '. $ticket['subject'] .'<br>';
}



1.1.13. getTicketFields

(Version >= 3.3.3391)

Syntax:

array getTicketFields()

Beschreibung:

Gibt ein Array mit Information der Feldern für Ticket zurück. Die Info enthält die Felder in der Datenbank, die angezeigte Namen und die Typen der Felder.

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

Eignenschaften von zurückgegebenen array:

Typ(Länge)              Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
string(255)             Key                       Name des Feldes in der Datenbank
array(255)              Value                     Array mit 
                                                  label: der angezeigte Name des Feldes
                                                  field: Name des Feldes in der Datenbank
                                                  type:  Typ des Feldes

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$fields			= $crmapi_tickets->getTicketFields();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach( $fields as $key => $val) {
    echo $key ." => ". $val['label'] ."<br/>";
}



1.1.14. getTicketSection

(Version >= 3.7.8870)

Syntax:

array getTicketSections()

Beschreibung:

Gibt ein Array mit den zur Verfügung stehenden Ticketbereichen zurück.

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

Eignenschaften von zurückgegebenen array:

Typ(Länge)              Eigenschaft               Beschreibung
---------------------------------------------------------------------------------------------
int                     section_id                ID des Ticketsbereiches
string(255)             name                      Name des Ticketsbereiches

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$sections		= $crmapi_tickets->getTicketSections();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach( $sections as $key => $val) {
    echo $key ." => ". $val ."<br>";
}



1.1.15. getTicketIdByExtId

(Version >= 4.2)

Syntax:

array getTicketIdByExtId( string $external_id )

Beschreibung

Liefert interne ID(s) eines Tickets mit der übergebenen externen ID zurück.

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

Eigenschaften des zurückgegebenen ticket ids array:

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

Beispiel:

<?php
 
try {   
	$crmapi_tickets	= crmapi::tickets();
	$result			= $crmapi_tickets->getTicketIdByExtId(12345);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {
	echo $id."<br>  ";
}



1.1.16. getAllTicketExtIds

(Version >= 4.2)

Syntax:

array getAllTicketExtIds( string $external_id )

Beschreibung

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

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

Eigenschaften des zurückgegebenen ticket ids array:

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

Beispiel:

<?php
 
try {   
	$crmapi_tickets	= crmapi::tickets();
	$result			= $crmapi_tickets->getAllTicketExtIds();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {   
	echo $id."<br>  ";
}



1.1.17. setDuplicatecheckConfig

(Version >= 4.4)

Syntax:

boolean|string CRMException message setDuplicatecheckConfig( [array( [string <fieldname>, string <fieldname>...]) | NULL] )

Beschreibung:

Ermöglicht eine temporäre Überschreibung der Dublettenprüfungsfelder für die Laufzeit der angemeldeten Session.

Standardübergabe ist ein leeres Array, was gleichbedeutend mit einer nicht stattfindenden Dublettenprüfung ist.

Zurückgesetzt werden kann die temporäre Dublettenprüfung Feldkonfiguration, wenn NULL anstatt eines Array übergeben wird.

Beispiel:

<?php
 
try {   
	$api     = crmapi::tickets();
	$fields  = array('tnumber', 'category');
	// adding a ticket will execute an exists-check looking for identical values in fields "tnumber" and "category" 
	// and will result in an "object already exists" trigger
	$success = $api->setDuplicatecheckConfig($fields);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo ($success === true ? 'override successful' : $success);



1.1.18. getDuplicatecheckConfig

(Version >= 4.4)

Syntax:

array | string CRMException message getDuplicatecheckConfig( )

Beschreibung:

Gibt Array mit aktueller Feldkonfiguration der Dublettenprüfung zurück.

Sollte aktuell keine temporäre Überschreibung der Feldkonfiguration aktiv sein (siehe setDuplicatecheckConfig), wird die durch die Administration konfigurierte Feldliste als Array zurückgegeben.

Beispiel:

<?php
 
try { 
	$api    = crmapi::tickets();
	$fields = $api->getDuplicatecheckConfig();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo print_r($fields, true);



1.1.19. searchTickets

(Version >= 4.5)

Syntax:

array | string CRMException message searchTickets(string $search, int $count = 0, int $offset = 0)

Beschreibung:

Gibt Array mit Tickets zurück, die über Volltextsuche nach $search gefunden werden.

$count schränkt die Anzahl der zurückgegebenen Tickets ein.

$offset gibt an, wieviele Einträge vom Beginn des Suchresultats übersprungen werden sollen.

Eigenschaften:

sind die selben wie für getTicket

Beispiel:

<?php
 
try { 
	$api     = crmapi::tickets();
	$tickets = $api->searchTickets('My Ticket', 500, 0);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo print_r($tickets, true);



1.1.20. getTicketSectionOption

(Version >= 4.5.17301)

Syntax:

mixed | string CRMException message getTicketSectionOption( int $section_id, string $option_name )

Beschreibung:

Gibt den Wert einer mit $option_name spezifizierten Administrations- Einstellung für den mit $section_id bestimmten Ticket Bereich (0 = Standardbereich) zurück.

Beispiel:

<?php
 
try { 
	$api     = crmapi::tickets();
	$option  = $api->getTicketSectionOption(0, 'ticket_action_char');
}
catch (CRMException $e) {
	echo $e->getMessage();
}
// $option should contain the character '#', which is the default setting for this option
echo 'ticket action separator char: '.$option;



1.1.21. getTicketSectionMailbody

(Version >= 4.5.17301)

Syntax:

string getTicketSectionMailbody( int $section_id, int $ticket_id, string $action, string &$subject )

Beschreibung:

Gibt den Vorlagentext für eine Ticket Aktion eines Ticket Bereichs als Zeichenkette zurück und speichert die dabei generierte Betreffzeile in der übergebenen Referenz $subject.

  • $section_id bestimmt den Ticket Bereich (0 = Standardbereich)

  • $ticket_id spezifiziert das Ticket, aus dem die Daten bezogen werden sollen

  • $action bezeichnet die Art der Aktion und der zu verwendenden E-Mail Vorlage

Mögliche Aktionen:

  
          * 'info': Standard Informations E-Mail
          * 'open': Zur Eröffnung eines Tickets
          * 'close:' Zur Schließung eines Tickets
          * 'open_webservice': Eröffnung über Webservice
          * 'close_webservice': Schließung über Webservice
          * 'action_open_webservice': Neue Aktion über Webservice
          * 'document_upload_notification': Information über neues Dokument im Ticket
  
    * //$subject// Pointer Variable für die ermittelte Betreffzeile

Beispiel:

<?php
 
try { 
	$api      = crmapi::tickets();
	$subject  = 'my subject';
     // fetch mailbody & subject for Ticket w/ ID 1337 from standard section (ID 0)
     $mailbody = $api->getTicketSectionMailbody(0, 1337, 'info', $subject);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
echo 'subject: '.$subject.'<br>';
echo htmlspecialchars($mailbody);



1.1.22. getTicketContactRelations

(Version >= 4.5.17283)

Syntax:

array getTicketContactRelations( int $ticket_id )

Beschreibung:

Liefert ein Array mit Kontakten zurück, die zum mit $ticket_id spezifizierten Ticket mittels Verknüpfungsübersicht verbunden worden sind.

Eigenschaften des zurückgegebenen Kontakte Arrays:

Array [
    int relation ID => Array [

        int 'id'                     interne Kontakt ID
        string 'realnumber'          Kontakt Nummer
        string 'company'             Kontakt Firma
        string 'department'          Kontakt Abteilung
        string 'street'              Kontakt Anschrift
        string 'postcode'            Postleitzahl
        string 'city'                Ort
        string 'region'              Region/Bundesland
        string 'country'             Staat
        string 'email'               Primäre E-Mail Adresse
        string 'email2'              weitere E-Mail Adressen 
        string 'email3'              ...
        string 'phone'               Telefon
        string 'fax'                 Fax
        string 'notes'               Notizen 
        string 'password' 
        string 'website'             Kontakt Website
        string 'client_account_id'   Kontakt Rechnungskonto
        string 'acc_holder'          Bankdaten: Kontotinhaber 
        string 'acc_nr'                         Kontonummer 
        string 'bankcode'                       Bankleitzahl
        string 'bankname'                       Name Kreditinstitut 
        string 'swift'                          SWIFT ID
        string 'iban'                           IBAN ID 
        string 'category'            Kontakt Kategorie
        string 'branch'              Kontakt Branche(n) 
        int 'userid'                 verantwortlicher CRM Benutzer
        string 'code'                generierter Kontakt Code
        string 'ustnr'               Kontakt Umsatzsteuer Nummer 
        string 'type'                Kontakt Typ
        string 'superior'            übergeordnet(e) Kontakt(e)  
        string 'md5check'            MD5 Prüfsumme
        int 'createuser'             Ersteller CRM Benutzer ID
        int 'createtime'             Erstellungsdatum Unix Timestamp
        int 'chguser'                Änderungsbenutzer ID
        int 'chgtime'                Änderungsdatum Unix Timestamp
        string 'ext_id'              Externe Kontakt ID
        int 'edituser'               aktuell bearbeitender Benutzer
        int 'email_status'           Empfängerstatus für Serien E-Mails
    ]
] 

Beispiel:

<?php
 
try { 
	$api      = crmapi::tickets();
	// get related contacts for Ticket w/ ID 1337
	$contacts = $api->getTicketContactRelations(1337);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo print_r($contact, true);



1.1.23. addTicketContactRelation

(Version >= 4.5.17283)

Syntax:

boolean addTicketContactRelation( int $ticket_id, int $contact_id )

Beschreibung:

Fügt eine Ticket- Kontakt Verknüpfung hinzu.

Beispiel:

<?php
 
try { 
	$api      = crmapi::tickets();
	// add a new ticket - contact relation for ticket w/ ID 1337 and contact w/ ID 1234
	$success  = $api->getTicketContactRelations(1337, 1234);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
if ($success) {
	echo 'relation successfully added';
}
else {
	echo 'failed to add relation';
}



1.2. Ticket Actions

1.2.1. addTicketAction

Syntax:

int addTicketAction( array $ticket_action )

Beschreibung:

Fügt eine Ticketaction hinzu.

Gibt eine ticket_action_id zurück.

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

Eigenschaften von ticket_action array:

Type(Length)      Eigenschaft             Beschreibung
------------------------------------------------------------------- 
int               $ticket_id           Ticket-Id
int               $userid              User-Id der verantwortlichen Person
string(65535)     $notes               Hinweis, Beschreibun ...
int               $atype               Typ: 0 = intern, 1 = extern
string(255)       $subject             Ticketaction-Betreff
float             $duration            Dauer
int               $ext_id              Externe ID ( ab Version 4.2 ),
int               $action_date         Unix-Timestamp, benutzerdefiniertes Aktionsdatum ( ab Version 4.3 )

Beispiel:

<?php
 
$ticket_action = array(
	'ticket_id'   => 7,
	'userid'      => 55,
	'notes'       => 'Notice here',
	'atype'       => 1,
	'subject'     => 'Ticket action subject',
	'duration'    => 1,5,
	'action_date' => time()
);
 
try {
	$crmapi_tickets		= crmapi::tickets(); 
	$ticket_action_id	= $crmapi_tickets->addTicketAction($ticket_action );
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $ticket_action_id;



1.2.2. getTicketAction

(Version >= 3.4.5380)

Syntax:

array getTicketAction( int $ticket_action_id )

Beschreibung:

Gibt eine Array mit Information von einer Ticket-Aktion anhand der $ticket_action_id zurück.

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

Eigenschaften der zurückgegebenen Array zurück:

die selben wie für getTicketActionsByTicketID

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$ticket_action	= $crmapi_tickets->getTicketAction(7);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($ticket_action as $key => $value) {
	echo $key . '=>' . $value . '<br>';
}



1.2.3. getTicketActionsByTicketID

Syntax:

array getTicketActionsByTicketID( int $ticket_id )

Beschreibung:

Gibt ein Array mit Ticketactions zurück welche zum Ticket mit der ticket_id gehören.

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

Eigenschaften von $ticket_action array:

Type(Length)      Eigenschaft             Beschreibung
-------------------------------------------------------------------
int               $id                  Ticket Action-Id
int               $ticket_id           Ticket-Id 
int               $userid              user-Id des verantwortlichen Nutzers
string(65535)     $notes               Hinweis, Beschreibung ...
int               $atype               Typ: 0 = intern, 1 = extern
string(255)       $subject             Ticketaction-Betreff
int               $createuser          User-Id der Erstellers
int               $createtime          Unix-Timestamp der Erstellung
int               $chguser             User-Id der letzten Änderung
int               $chgtime             Unix-Timestamp der letzten Änderung
float             $duration            Dauer
int               $ext_id              Externe ID ( ab Version 4.2 )
int               $action_date         Unix-Timestamp, benutzerdefiniertes Aktionsdatum ( ab Version 4.3 )

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Get Ticket actions, which belong to the ticket with id: 180
	$result = $crmapi_tickets->getTicketActionsByTicketID(180);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $ticket_action) {
	foreach($ticket_action as $key => $value) {
		echo $key . '=>' . $value . '<br>';
	}
	echo "<hr>";
}



1.2.4. changeTicketAction

Syntax:

int changeTicketAction(int $ticket_action_id, array $ticket_action )

Beschreibung:

Ändert die Eigenschaften einer existierenden Ticketaction.

Gibt eine ticket_action_id zurück.

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

Eigenschaften von $ticket_action array:

die selben wie für addTicketAction

Beispiel:

<?php
 
$ticket_action = array();
$ticket_action['subject'] = 'API Ticket Action changed';
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Change ticket action with id 180
	$ticket_action_id = $crmapi_tickets->changeTicketAction( 180, $ticket_action );
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
echo $ticket_action_id;



1.2.5. deleteTicketAction

Syntax:

void crmdeleteTicketAction ( int $ticket_action_id )

Beschreibung:

Löscht ein Ticket.

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

Beispiel:

<?php
 
try {
	$crmapi_tickets = crmapi::tickets();
 
	// Delete ticket action with id 180
	$ticket_action_id = $crmapi_tickets->deleteTicketAction(180);
}
catch (CRMException $e) {
	echo $e->getMessage();
}



1.2.6. getTicketActionByCondition

Syntax:

array getTicketActionByCondition ( array $condition )

Beschreibung:

Gibt ein Array von Ticket-Aktion zurück, welche mit den Bedingungen übereinstimmen.

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

Eigenschaften von $condition Array:

Type(Length)      Eigenschaft          Beschreibung
------------------------------------------------------------------- 
int               $tid                 Ticket-Id
int               $tids                kommagetrennter String von Ids
int               $atype               1 = Externe ( Default ), 0 = Interne, -1 = Beide
int               $userid              User-Id des Verantwortlichen
string(255)       $search              Suche in Betreff, Notizen
int               $count               Anzahl Ergebnisse
int               $offset              Startposition Ergebnisse
boolean           $costs               0 = Es werden keine Kosten zurückgeliefert
int               $action_date         Unix-Timestamp, benutzerdefiniertes Aktionsdatum ( ab Version 4.3 )

Eigenschaften von zurückgegebenen Array:

sind die selben wie für getTicketActionsByTicketID

Beispiel:

<?php
 
try {
	$crmapi_tickets	= crmapi::tickets();
	$condition		= array('tids'=> '1,2,3,4,5,6,7');
	$ticket_actions = $crmapi_tickets->getTicketActionByCondition($condition);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($ticket_actions as $ticket_action) {
	echo 'Ticket ID: '. $ticket_action['ticket_id'] .'<br>';
	echo 'Subject: '. $ticket_action['subject'] .'<br>';
}



1.2.7. getTicketActionIdByExtId

(Version >= 4.2)

Syntax:

array getTicketActionIdByExtId( string $external_id )

Beschreibung

Liefert interne ID(s) einer Ticket Action mit der übergebenen externen ID zurück.

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

Eigenschaften des zurückgegebenen ticket ids array:

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

Beispiel:

<?php
 
try {   
	$crmapi_tickets	= crmapi::tickets();
	$result			= $crmapi_tickets->getTicketActionIdByExtId(12345);
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {   
	echo $id."<br>  ";
}



1.2.8. getAllTicketActionExtIds

(Version >= 4.2)

Syntax:

array getAllTicketActionExtIds( string $external_id )

Beschreibung

Liefert eine Liste aller externen IDs in Ticket Actions zurück.

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

Eigenschaften des zurückgegebenen ticket ids array:

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

Beispiel:

<?php
 
try {   
	$crmapi_tickets	= crmapi::tickets();
	$result			= $crmapi_tickets->getAllTicketActionExtIds();
}
catch (CRMException $e) {
	echo $e->getMessage();
}
 
foreach($result as $id) {   
	echo $id."<br>  ";
}
  • No labels