Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
webservices:soap_webservices:fields [2017/02/07 17:03]
127.0.0.1 Externe Bearbeitung
webservices:soap_webservices:fields [2020/05/06 14:02] (aktuell)
d0dge
Zeile 1: Zeile 1:
 ====== Fields ====== ====== Fields ======
  
- +Bitte besuchen Sie unsere neue Entwickler-Dokumentation unter [[https://docs.tecart.de/display/public/WIKI/Fields+SOAP]]
- +
-===== Hinweis ====== +
- +
- +
-Diese SOAP Klasse und deren Funktionen können mit dem TecArt-System ab Version **4.3** genutzt werden. +
- +
- +
- +
-===== WSDL-URI ====== +
- +
- +
-<​code>​http://​hostname/​dirname/​soap/​index.php?​op=fields&​wsdl</​code>​ +
- +
-z.B. [[https://test.tecart-system.de/soap/index.php?​op=fields&​wsdl|https:​//test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl]] +
- +
- +
-===== Methoden ====== +
- +
- +
- +
-==== crmaddUserfield ===== +
- +
- +
-**Syntax**:​ +
-  int crmaddUserfield( string $session_id,​ int $module, crmFieldItem $crmFieldItem ) +
- +
-**Beschreibung**:​ +
- +
-Fügt ein benutzerdefiniertes Feld zum angegebenen Modul hinzu. +
-  +
- +
-Gibt die field_id bei Erfolg zurück, 0 bei einem Fehler +
- +
- +
-**$crmFieldItem** kann ein assoziatives Array oder ein Objekt sein. +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. Diese Variable muss einen der folgenden Integer-Werte beinhalten:​ +
-   +
-  Wert   ​Modul +
-  ------------------------------- +
-    1    Kontakte +
-    2    Personen +
-    3    Projekte +
-    4    Verträge +
-    5    Angebote +
-    6    Tickets +
-    9    Ressourcen +
-   ​12 ​   Artikel +
-   ​13 ​   Rechnungskonten +
-   ​14 ​   Ausgangsrechnungen +
-   ​15 ​   Zahlungen +
-   ​18 ​   Mahnungen +
-   ​20 ​   Aufträge +
-   ​21 ​   Lieferscheine +
-   ​22 ​   Gutschriften +
-   ​29 ​   Eingangsrechnungen +
-   ​30 ​   Kassenbücher +
- +
- +
- +
- +
-**Eigenschaften von ****//​crmFieldItem//​**:​ +
-   +
-  Type(Length) ​           Eigenschaft ​                   Beschreibung +
-  ------------------------------------------------------------------------------------------------------------------ +
-  string(128) ​            ​$label ​                        ​angezeigter Feldname  +
-  int                     ​$type ​                         Feldtyp +
-  string(255) ​            ​$list ​                         Name der für Dropdown-Listen-Felder anzuzeigenden Liste +
-  int                     ​$listsave ​                     Speichertyp für Dropdown-Listen-Felder (0 = Wert, 1 = Index) +
-  string(255) ​            ​$stdvalue ​                     Standardwert +
-  string(255) ​            ​$title ​                        Titel (Quickinfo) +
-  int                     ​$obligatory ​                   Pflichtfeld (0 = Nein, 1 = Ja) +
-  int                     ​$readonly ​                     Schreibgeschützt (0 = Nein, 1 = Ja) +
-  int                     ​$size ​                         Feldgröße (Textlänge für Textfelder, Anzahl Nachkommastellen für Nummernfelder,​ Höhe für Listenfelder) +
-  int                     ​$width ​                        ​Breite des Feldes in Pixel +
-  int                     ​$pos ​                          ​Position (-1 = fixiert) +
-  int                     ​$view ​                         Anzeigen (0 = Nein, 1 = Ja) +
-  int                     ​$style ​                        Stil (0 = normal, 1 = fett, 2 = kursiv, 3 = unterstrichen) +
-  int                     ​$hidelabel ​                    ​Bezeichnung ausblenden (0 = Nein, 1 = Ja) +
-  int                     ​$grid_width ​                   Initial Spaltenbreite für Anzeige in Grids +
-  int                     ​$keep_edit ​                    ​Bearbeitungsmodus nach Template-Wechsel beibehalten +
-  int                     ​$listsorttype ​                 Sortierung von Listenfeldern (0 = Alphabetisch,​ 1 = Indexwert, 2 = Frei) +
-  string(255) ​            ​$clickevent ​                   Click Event URL für Buttons +
-  int                     ​$clickevent_new_window ​        Click Event URL in neuem Fenster öffnen +
-  int                     ​$clickevent_window_scrollbars ​ Scrollbars in neuem Fenster anzeigen +
-  int                     ​$clickevent_window_width ​      ​Breite des neuen Fensters in Pixel +
-  int                     ​$clickevent_window_height ​     Höhe des neuen Fensters in Pixel +
-  string(255) ​            ​$allow_grp ​                    ​Doppelpunkt-getrennt Liste der Gruppen-IDs mit Leseberechtigung (''​ = Alle) +
-  string(255) ​            ​$allow_grp_write ​              ​Doppelpunkt-getrennt Liste der Gruppen-IDs mit Schreibberechtigung (''​ = Alle) +
- +
- +
-**Feldtypen** +
-   +
-  Wert   ​Feldtyp +
-  ------------------------------- +
-    1    Text +
-    2    Nummer +
-    3    Datum +
-    4    Kontrollkästchen +
-    5    Dropdown-Liste +
-    6    Dropdown-Liste Mehrfachauswahl +
-    7    Währung +
-    8    Kontaktauswahl +
-    9    Projektauswahl +
-   ​10 ​   Button +
-   ​11 ​   Dropdown-Liste Template +
-   ​12 ​   Ticketauswahl +
-   ​13 ​   Vertragsauswahl +
-   ​14 ​   Angebotsauswahl +
-   ​15 ​   Textbereich +
-   ​17 ​   Warengruppenauswahl +
-   ​18 ​   Dropdown-Liste Drucklayout +
-   ​19 ​   Rechnungskontoauswahl +
-   ​20 ​   Artikelauswahl +
-   ​21 ​   Auftragsauswahl +
-   ​23 ​   Kostenstellenauswahl +
-   ​24 ​   Datum mit Uhrzeit +
- +
- +
- +
- +
-**Beispiel:​** +
-<sxh php> +
- +
-<?php +
- +
-ini_set("​soap.wsdl_cache_enabled",​ "​0"​);​ +
- +
-$field = array('​type' ​ => 1,  +
-        '​label'​ => 'Mein Textfeld',​ +
-  '​pos' ​  => -1, +
-        '​size' ​ => 10); +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$field_id = $client_fields->​crmaddUserfield($session_id,​ 1, $field); +
- +
-   echo $field_id;​ +
-+
-catch (SOAPFault $f) { +
-  print $f->​faultstring;​ +
-+
- +
-?> +
- +
-</​sxh>​ +
----- +
- +
- +
-==== crmchangeUserfield ===== +
- +
- +
-**Syntax:​** +
-  int crmchangeUserfield ( string $session_id,​ int $module, int $field_id, crmFieldItem $crmFieldItem ) +
- +
-**Beschreibung**:​ +
- +
-Ändert die Eigenschaften eines benutzerdefiniertes Feldes. +
- +
- +
-Gibt 1 bei Erfolg zurück, 0 bei einem Fehler +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**$field_id**:​ ID des zu ändernden Feldes. +
- +
- +
-**$crmFieldItem** kann ein assoziatives Array oder ein Objekt sein. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**Beispiel** +
- +
-<sxh php> +
- +
-<?php +
- +
-$field = array('​type' ​ => 7,  +
-        '​label'​ => 'Mein Währungsfeld',​ +
-        '​size' ​ => 2); +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$success = $client_fields->​crmchangeUserfield($session_id,​ 1, 30, $field); +
-}  +
-catch (CRMException $e) { +
-  echo $e->​getMessage();​ +
-+
- +
-?> +
- +
-</​sxh>​ +
---------------- +
- +
- +
-==== crmremoveUserfield ===== +
- +
- +
-**Syntax:​** +
-  int crmremoveUserfield ( string $session_id,​ int $module, int $field_id ) +
- +
-**Beschreibung**:​ +
- +
-Löscht ein benutzerdefiniertes Feld. +
- +
- +
-Gibt 1 bei Erfolg zurück, 0 bei einem Fehler +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**$field_id**:​ ID des zu löschenden Feldes. +
- +
- +
-**Beispiel** +
- +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$success = $client_fields->​crmremoveUserfield($session_id,​ 1, 30); +
-}  +
-catch (CRMException $e) { +
-  echo $e->​getMessage();​ +
-+
- +
-?> +
- +
-</​sxh>​ +
---------------- +
- +
- +
-==== crmgetFieldByID ===== +
- +
- +
-**Syntax:​** +
-  array crmgetFieldByID ( string $session_id,​ int $module, int $field_id ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array von Feld-Objekten mit nur einem Element zurück. +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**$field_id**:​ ID des Feldes. +
- +
- +
-**Eigenschaften des zurückgegebenen Feld-Elements**:​ +
-   +
-  Type(Length) ​           Eigenschaft ​                   Beschreibung +
-  ------------------------------------------------------------------------------------------------------------------ +
-  int                     ​$id ​                           ID des Feldes +
-  string(128) ​            ​$label ​                        ​angezeigter Feldname  +
-  string(128) ​            ​$field ​                        Name des Feldes +
-  int                     ​$type ​                         Feldtyp +
-  string(255) ​            ​$list ​                         Name der für Dropdown-Listen-Felder anzuzeigenden Liste +
-  int                     ​$listsave ​                     Speichertyp für Dropdown-Listen-Felder (0 = Wert, 1 = Index) +
-  string(255) ​            ​$stdvalue ​                     Standardwert +
-  string(255) ​            ​$title ​                        Titel (Quickinfo) +
-  int                     ​$obligatory ​                   Pflichtfeld (0 = Nein, 1 = Ja) +
-  int                     ​$readonly ​                     Schreibgeschützt (0 = Nein, 1 = Ja) +
-  int                     ​$size ​                         Feldgröße (Textlänge für Textfelder, Anzahl Nachkommastellen für Nummernfelder,​ Höhe für Listenfelder) +
-  int                     ​$width ​                        ​Breite des Feldes in Pixel +
-  int                     ​$pos ​                          ​Position (-1 = fixiert) +
-  int                     ​$view ​                         Anzeigen (0 = Nein, 1 = Ja) +
-  int                     ​$style ​                        Stil (0 = normal, 1 = fett, 2 = kursiv, 3 = unterstrichen) +
-  int                     ​$hidelabel ​                    ​Bezeichnung ausblenden (0 = Nein, 1 = Ja) +
-  int                     ​$grid_width ​                   Initial Spaltenbreite für Anzeige in Grids +
-  int                     ​$keep_edit ​                    ​Bearbeitungsmodus nach Template-Wechsel beibehalten +
-  int                     ​$listsorttype ​                 Sortierung von Listenfeldern (0 = Alphabetisch,​ 1 = Indexwert, 2 = Frei) +
-  int                     ​$chguser ​                      ​User-Id der letzten Änderung +
-  int                     ​$chgtime ​                      ​Unix-Timestamp der letzten Änderung +
-  string(255) ​            ​$clickevent ​                   Click Event URL für Buttons +
-  int                     ​$clickevent_new_window ​        Click Event URL in neuem Fenster öffnen +
-  int                     ​$clickevent_window_scrollbars ​ Scrollbars in neuem Fenster anzeigen +
-  int                     ​$clickevent_window_width ​      ​Breite des neuen Fensters in Pixel +
-  int                     ​$clickevent_window_height ​     Höhe des neuen Fensters in Pixel +
-  string(255) ​            ​$allow_grp ​                    ​Doppelpunkt-getrennt Liste der Gruppen-IDs mit Leseberechtigung (''​ = Alle) +
-  string(255) ​            ​$allow_grp_write ​              ​Doppelpunkt-getrennt Liste der Gruppen-IDs mit Schreibberechtigung (''​ = Alle) +
- +
- +
-**Beispiel** +
- +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$field = $client_fields->​crmgetFieldByID($session_id,​ 1, 30); +
- +
-   ​print_r($field);​ +
-}  +
-catch (CRMException $e) { +
-  echo $e->​getMessage();​ +
-+
- +
-?> +
- +
-</​sxh>​ +
---------------- +
- +
- +
-==== crmgetFieldByName ===== +
- +
- +
-**Syntax:​** +
-  array crmgetFieldByName ( string $session_id,​ int $module, string $fieldname ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Array von Feld-Objekten mit nur einem Element zurück. +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**$fieldname**:​ Name des Feldes. +
- +
- +
-Eigenschaften des zurückgegebenen Feld-Elements siehe **[[#​crmgetFieldByID]]** +
- +
-**Beispiel** +
- +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$field = $client_fields->​crmgetFieldByName($session_id,​ 1, '​user30'​);​ +
- +
-   ​print_r($field);​ +
-}  +
-catch (CRMException $e) { +
-  echo $e->​getMessage();​ +
-+
- +
-</​sxh>​ +
---------------- +
- +
- +
-==== crmgetUserfields ===== +
- +
- +
-**Syntax:​** +
-  object crmgetUserfields ( string $session_id,​ int $module ) +
- +
-**Beschreibung**:​ +
- +
-Gibt ein Objekt mit einer Liste der benutzerdefinierten Felder des Moduls zurück. +
- +
- +
-**$module**:​ Modul des benutzerdefinierten Feldes. (Eigenschaften siehe **[[#​crmaddUserfield]]**) +
- +
- +
-**Beispiel** +
- +
-<sxh php> +
- +
-<?php +
- +
-try { +
-  $client_logon ​ = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=logon&​wsdl"​);​ +
-     ​$client_fields = new SOAPClient("​https://​test.tecart-system.de/​soap/​index.php?​op=fields&​wsdl"​);​ +
-   +
-     ​$session_id = $client_logon->​crmLogin('​test',​ '​test'​);​ +
-     if (!$session_id) die("​invalid login"​);​ +
- +
-   ​$userfields = $client_fields->​crmgetUserfields($session_id,​ 1); +
- +
-   ​print_r($userfields);​ +
-}  +
-catch (CRMException $e) { +
-  echo $e->​getMessage();​ +
-+
- +
-?> +
- +
-</​sxh>​ +
---------------- +