Webservice ido: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(33 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
Die zur Nutzung der infra-struktur IDO Webservices notwendige WSDL-Datei finden Sie unter:
Die zur Nutzung der infra-struktur IDO Webservices notwendige WSDL-Datei finden Sie unter:


http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
 
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.
 
* '''Example'''


Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices
Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices
Zeile 13: Zeile 9:
   <?php
   <?php
   //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
   //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
   $client = new SoapClient("http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
   $client = new SoapClient("http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
    
    
   //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
   //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
   $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.de","benutzername","passwort"));
   $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));
    
    
   //In der IDO Instanz mit der ID 1, im Datensatz mit der ID 2, das Textfeld mit der ID 3 auf den Wert "vier" setzen
   //In der IDO Instanz mit der ID 1, im Datensatz mit der ID 2, das Textfeld mit der ID 3 auf den Wert "vier" setzen
Zeile 54: Zeile 50:




''<u>GetTextfieldsByInstanceID</u>''
''<u>getInstances</u>''


Liefert sämtliche Textfelder zur gewählten Instanz
Liefert sämtliche verfügbare IDO Instanzen


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 63: Zeile 59:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| instanceID     ||Integer ||| ID der IDO Instanz
| userID     ||Integer ||| UserID des Benutzers
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 71: Zeile 67:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| idoTextFields     || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
| idoInstances     || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
|}
|}




''<u>GetInstances</u>''
''<u>getTextfieldsByInstanceID</u>''


Liefert sämtliche verfügbare IDO Instanzen
Liefert sämtliche Textfelder zur gewählten Instanz


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 84: Zeile 80:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| userID     ||Integer ||| UserID des Benutzers
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 92: Zeile 88:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| idoInstances     || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
| idoTextFields     || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
|}
|}




''<u>GetSelectFieldsByInstanceID</u>''
''<u>getSelectFieldsByInstanceID</u>''


Liefert sämtliche Selectfelder der gewählten Instanz
Liefert sämtliche Selectfelder der gewählten Instanz
Zeile 105: Zeile 101:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 113: Zeile 109:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IdoSelectFields     || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
| idoSelectFields     || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
|}
|}




''<u>GetRadiofieldsByInstanceID</u>''
''<u>getRadiofieldsByInstanceID</u>''


Liefert sämtliche Radiofelder der gewählten Instanz
Liefert sämtliche Radiofelder der gewählten Instanz
Zeile 126: Zeile 122:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 134: Zeile 130:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IdoRadiofields     || Array ||| Array mit den verfügbaren Radiofeldern (FeldID,Feldname)
| idoRadiofields     || Array ||| Array mit den verfügbaren Radiofeldern (FeldID,Feldname)
|}
|}




''<u>GetCheckboxesByInstanceID</u>''
''<u>getCheckboxesByInstanceID</u>''


Liefert sämtliche Checkboxen der gewählten Instanz
Liefert sämtliche Checkboxen der gewählten Instanz
Zeile 147: Zeile 143:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 155: Zeile 151:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IdoRadiofields     || Array ||| Array mit den verfügbaren Checkboxen (FeldID,Feldname)
| idoCheckboxes     || Array ||| Array mit den verfügbaren Checkboxen (FeldID,Feldname)
|}
|}


Zeile 168: Zeile 164:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 176: Zeile 172:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CountCheckboxes     || Integer ||| Anzahl der verfügbaren Felder
| countCheckboxes     || Integer ||| Anzahl der verfügbaren Felder
|}
|}




''<u>CountConfiguredSelectfieldsByInstanceID</u>''


''<u>GetPossibleCheckboxValues</u>''
Gibt die Anzahl der verfügbaren Selectfelder zurück
 
Liefert die Auswahlmöglichkeiten einer Checkbox


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 190: Zeile 185:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| CheckboxID    ||Integer ||| ID der Checkbox
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 200: Zeile 193:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CheckboxValues    || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}
|}




''<u>CountConfiguredSelectfieldsByInstanceID</u>''
''<u>CountConfiguredRadiofieldsByInstanceID</u>''


Gibt die Anzahl der verfügbaren Selectfelder zurück
Gibt die Anzahl der verfügbaren Radiofelder zurück


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 213: Zeile 206:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 221: Zeile 214:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CountSelectfields|| Integer||| Anzahl der verfügbaren Felder
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}
|}




''<u>CountConfiguredRadiofieldsByInstanceID</u>''
''<u>getPossibleCheckboxValues</u>''
 
Liefert die Auswahlmöglichkeiten einer Checkbox


Gibt die Anzahl der verfügbaren Radiofelder zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 233: Zeile 227:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| checkboxID    ||Integer ||| ID der Checkbox
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 241: Zeile 237:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CountSelectfields|| Integer||| Anzahl der verfügbaren Felder
| checkboxValues    || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}
|}




''<u>GetPossibleSelectfieldValues</u>''
''<u>getPossibleSelectfieldValues</u>''


Liefert die Auswahlmöglichkeiten eines Selectfeldes
Liefert die Auswahlmöglichkeiten eines Selectfeldes
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 253: Zeile 250:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| SelectfieldID|| Integer||| ID der Selectbox
| feldID || Integer ||| ID der Selectbox
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 263: Zeile 260:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| SelectfieldsValues|| Array||| Array mit den verfügbaren Values (ValueID,ValueName)
| selectfieldsValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}
|}




''<u>GetPossibleRadiofieldValues</u>''
''<u>getPossibleRadiofieldValues</u>''


Liefert die Auswahlmöglichkeiten einer Radiobox
Liefert die Auswahlmöglichkeiten einer Radiobox
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 275: Zeile 273:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| RadiofieldID|| Integer||| ID des Radiofelds
| feldID || Integer ||| ID des Radiofelds
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 285: Zeile 283:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| RadiofieldValues|| Array||| Array mit den verfügbaren Values (ValueID,ValueName)
| radiofieldValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}
|}




''<u>GetIDOInstanceSpecialFieldConfiguration</u>''
''<u>getIDOInstanceSpecialFieldConfiguration</u>''


Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung
Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 297: Zeile 296:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| specialFieldType || String ||| Abzufragende Konfiguration, mögliche SpecialFieldTypes:
* archivefield - Ist das Archivfeld aktiviert
* messagefield - Ist das Hinweisfeld aktiviert
* nextcontacttime - Ist das nächster Kontaktfeld (Uhrzeit) aktiviert
* nextcontact - Ist das nächster Kontaktfeld (Datum) aktiviert
* datasetowner - Ist das Feld Kontaktperson aktiviert
* lastcontact - Ist das Feld letzter Kontakt aktiviert
* deleteright - Ist der Löschen-Button aktiviert
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| true/false || Boolean ||| Konfigurationsstatus
|}
 
 
 
''<u>GenerateFieldTypeArray</u>''
 
Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
|-
| SpecialFieldType|| String||| Abzufragende Konfiguration *
| instanceID    ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
|-
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| fieldTypeArray || Array ||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|}


* mögliche SpecialFieldTypes
''<u>getFieldType</u>''
● archivefield - Ist das Archivfeld aktiviert
 
● messagefield - Ist das Hinweisfeld aktiviert
Liefert den Typ eines bestimmten Feldes zurück
● nextcontacttime - Ist das nächster Kontaktfeld (Uhrzeit)
 
aktiviert
{| class="wikitable" border=1
● nextcontact - Ist das nächster Kontaktfeld (Datum) aktiviert
! width="100px" | Parameter       
● datasetowner - Ist das Feld Kontaktperson aktiviert
! width="100px" | Datentyp 
● lastcontact - Ist das Feld letzter Kontakt aktiviert
! width="400px" | Beschreibung
● deleteright - Ist der Löschen-Button aktiviert
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldName || String ||| Name des Feldes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
| &nbsp; || |||
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| true/false|| Boolian||| Konfigurationsstatus
| feldtyp || String ||| Typ des Feldes
|}
|}




''<u>GetConfiguredContactsTextFields</u>''
''<u>getFullIDOStructure</u>''
 
Liefert die vollständige Struktur einer IDO-Instanz


Liefert die konfigurierten Felder des Ansprechpartnerreiters
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 329: Zeile 373:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 337: Zeile 381:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| ContactFields|| Array||| Array mit den verfügbaren Feldern (FeldID,Feldname)
|     || |||
|}
|}




''<u>GenerateFieldTypeArray</u>''
''<u>getIdoMappingFieldsByInstanceIdAndIdoId</u>''
 
Liefert die Mapping-Felder eines Datensatzes


Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 349: Zeile 394:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| idoID    ||Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 357: Zeile 404:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| FieldTypeArray|| Array||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|     || |||
|}
|}




''<u>GetFieldType</u>''
''<u>openRemoteIDO</u>''
 
Öffnet einen IDO-Datensatz remote


Liefert den Typ eines bestimmten Feldes zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 369: Zeile 417:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| userID     ||Integer ||| UserID des Benutzers
|-
|-
| FieldID|| Integer||| ID des Feldes
| instanceID    ||Integer ||| ID der IDO Instanz
|-
|-
| FieldName|| String||| Name des Feldes
| idoID    ||Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 381: Zeile 429:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Feldtyp|| String||| Typ des Feldes
|     || |||
|}
|}




''<u>GetDataByInstanceIDOIdAndFieldID</u>''
''<u>getDataByInstanceIDOIdAndFieldID</u>''


Liefert den Wert des angegebenen Feldes zurück
Liefert den Wert des angegebenen Feldes zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 393: Zeile 442:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| FieldID|| Integer||| ID des Feldes
| fieldID || Integer ||| ID des Feldes
|-
|-
| FieldType|| String||| Typ des Feldes *
| fieldType || String ||| Typ des Feldes, mögliche Feldtypen:
* optfield (Standard)
* radiofield
* selectfield
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
|-
|-
* mögliche Feldtypen
● optfield (Standard)
● radiofield
● selectfield
| &nbsp; || |||
| &nbsp; || |||
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| FieldValue|| String||| Wert des Feldes
| fieldValue || String ||| Wert des Feldes
|}
|}




''<u>GetCheckedValuesForInstanceAndCheckBoxID</u>''
''<u>getCheckedValuesForInstanceAndCheckBoxID</u>''
 
Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolean zurück


Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolian zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 424: Zeile 472:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| CheckboxID|| Integer ||| ID der Checkbox
| checkboxID || Integer ||| ID der Checkbox
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 436: Zeile 484:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CheckBoxValues|| Array||| Array dessen Key die ValueID und das Value der Name ist
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}
|}




''<u>GetPossibleValuesForInstanceIDOAndCheckboxID</u>''
''<u>getPossibleValuesForInstanceAndCheckboxID</u>''


Liefert alle verfügbaren Einträge einer Checkbox zurück
Liefert alle verfügbaren Einträge einer Checkbox zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 448: Zeile 497:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| CheckboxID|| Integer ||| ID der Checkbox
| checkboxID || Integer ||| ID der Checkbox
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 458: Zeile 507:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| CheckBoxValues|| Array||| Array dessen Key die ValueID und das Value der Name ist
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}
|}




''<u>GetArchiveContent</u>''
''<u>getArchiveContent</u>''


Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück
Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 470: Zeile 520:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 480: Zeile 530:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| ArchiveContent|| String||| Inhalt des Archivfelds
| archiveContent || String ||| Inhalt des Archivfelds
|}
|}




''<u>GetMessageContent</u>''
''<u>getMessageContent</u>''


Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes
Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 492: Zeile 543:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 502: Zeile 553:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| MessageContent|| String||| Inhalt des Hinweisfelds
| messageContent || String ||| Inhalt des Hinweisfelds
|}
|}




''<u>GetNextContact</u>''
''<u>getNextContact</u>''


Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück
Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 514: Zeile 566:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 524: Zeile 576:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| NextContact|| String||| Datum des nächsten Kontakts
| nextContact || String ||| Datum des nächsten Kontakts
|}
|}




''<u>GetNextContactTime</u>''
''<u>getNextContactTime</u>''


Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück
Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| nextContactTime || String ||| Uhrzeit des nächsten Kontakts
|}
''<u>getLastContact</u>''
Liefert das Datum des letzten Kontakts zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 536: Zeile 612:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 546: Zeile 622:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| NextContactTime|| String||| Uhrzeit des nächsten Kontakts
|     || String |||
|}
|}


Zeile 553: Zeile 629:


Liefert zurück ob der nächste Kontakt ein Termin ist
Liefert zurück ob der nächste Kontakt ein Termin ist
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 558: Zeile 635:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 568: Zeile 645:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| isTermin|| Boolian||| Termin oder nicht
| isTermin || Boolean ||| Termin oder nicht
|}
|}




''<u>GetContactPerson</u>''
''<u>getContactPerson</u>''


Liefert die ausgewählte Kontaktperson des Datensatzes zurück
Liefert die ausgewählte Kontaktperson des Datensatzes zurück
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 580: Zeile 658:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| contactPerson || Integer ||| UserID der Kontaktperson
|}
 
 
''<u>getAllEntries</u>''
 
Liefert alle Einträge einer IDO-Instanz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| instanceID    ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 590: Zeile 689:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| contactPerson|| Integer||| UserID der Kontaktperson
|     || |||
|}
|}




''<u>SetValueForDataset</u>''


Setzt den Wert eines bestimmten Feldes
''<u>getFullIdoInstance</u>''
 
Liefert alle Datensätze einer IDO-Instanz (mit Paginierung und Zeitfilter)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| offset || anyType ||| Startposition (für Paginierung)
|-
| limit || anyType ||| Maximale Anzahl zurückgegebener Datensätze
|-
| lastModificationTimestamp || anyType ||| Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getIdoContextValue</u>''
 
Liefert den Kontextwert eines Datensatzes
 
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 602: Zeile 730:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| userId     ||Integer ||| UserID des Benutzers
|-
|-
| IdoID|| Integer ||| ID des Datensatzes
| instanceID || Integer ||| ID der IDO Instanz
|-
|-
| FieldID|| Integer ||| ID des Feldes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| Value|| String ||| Wert des Feldes
| token    || String ||| Validierungstoken
|-
|-
| FieldType|| String ||| Feldtyp des Feldes
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getIdoListByGivenIDs</u>''
 
Liefert eine Liste von Datensätzen anhand einer Liste von IDs
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoIdList || anyType ||| Array mit den abzufragenden Datensatz-IDs
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 618: Zeile 765:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
|     || |||
|}
|}




''<u>SetValueForDataset</u>''
''<u>setValueForDataset</u>''


Setzt den Wert eines bestimmten Feldes
Setzt den Wert eines bestimmten Feldes
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 630: Zeile 778:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
|-
| FieldID|| Integer ||| ID des Feldes
| fieldID || Integer ||| ID des Feldes
|-
|-
| Value|| String ||| Wert der Option
| value || String ||| Wert des Feldes
|-
| fieldType || String ||| Feldtyp des Feldes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 642: Zeile 794:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}




''<u>SetTextFieldValue</u>''
''<u>setTextFieldValue</u>''


Setzt den Wert eines Textfeldes
Setzt den Wert eines Textfeldes
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 654: Zeile 807:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| idoID || Integer ||| ID des Datensatzes
|-
|-
| FieldID|| Integer||| ID des Feldes
| fieldID || Integer ||| ID des Feldes
|-
|-
| Value|| String ||| Wert der Option
| fieldValue || String ||| Wert der Option
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 668: Zeile 821:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}




''<u>SetArchiveContent</u>''
''<u>setArchiveContent</u>''


Setzt den Wert des Archivfelds
Setzt den Wert des Archivfelds
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || String ||| Wert der Option
|-
| handleType || String ||| Typ der Aktion, mögliche Feldtypen:
* UPDATE (Standard) - ergänzt bestehenden Inhalt
* OVERWRITE - überschreibt bestehenden Inhalt
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setMessageContent</u>''
Setzt den Wert des Hinweisfelds
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || String ||| Wert der Option
|-
| handleType || String ||| Typ der Aktion, mögliche Aktionen:
* UPDATE (Standard) - ergänzt bestehenden Inhalt
* OVERWRITE - überschreibt bestehenden Inhalt
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setContactPerson</u>''
Setzt die Kontaktperson eines Datensatzes
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| employeeID || Integer ||| UserID der Kontaktperson
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setContactDate</u>''
Setzt den Wert des Feldes nächster/letzter Kontakt
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| handleType || String ||| Typ des Feldes, mögliche Feldtypen:
* NEXT (Standard) - Feld nächster Kontakt
* LAST - Feld letzter Kontakt
|-
| date || String ||| Datum
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setContactTime</u>''
Setzt die Uhrzeit des nächsten Kontakts
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| time || String ||| Uhrzeit (HH:MM:SS)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setTermin</u>''
Setzt den nächsten Kontakt als Termin
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| switchStatus || Boolean ||| Termin oder nicht
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setCombofield</u>''
Setzt den Wert eines Combofeldes
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| valueID || Integer ||| ID des Values
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setCheckboxValues</u>''
Setzt den Wert einer Checkbox
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID der Checkbox
|-
| values || Array ||| Checkboxwerte als Array im Format
array('ValueID1' => true, 'ValueID2' => false, ...)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>setValueOfMappedField</u>''
Setzt den Wert eines Feldes anhand seines Mapping-Keys
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| idoId || Integer ||| ID des Datensatzes
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Wert des Feldes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| status || Boolean ||| Status der Abfrage
|}
''<u>addCombovalue</u>''
Fügt einen neuen Wert zu einem Combofeld hinzu
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>addValueForComboField</u>''
Fügt einen neuen Wert zu einem Combofeld hinzu
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>addValueForDemoField</u>''
Fügt einen neuen Wert zu einem Demo-Feld hinzu
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| value || String ||| Neuer Wert
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>refreshTheIdoUserInterface</u>''
Aktualisiert die IDO-Benutzeroberfläche
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>CreateNewDataset</u>''
Erstellt einen neuen, leeren Datensatz
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 680: Zeile 1.176:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID    ||Integer ||| ID der IDO Instanz
| instanceID ||Integer ||| ID der IDO Instanz
|-
| contactPersonUserID || Integer ||| UserID des Besitzers
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| idoID || Integer ||| ID des neuen Datensatz
|}
 
 
''<u>createNewDatasetWithID</u>''
 
Erstellt einen neuen Datensatz mit einer vordefinierten ID
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| instanceID ||Integer ||| ID der IDO Instanz
|-
|-
| Value|| String||| Wert der Option
| definedIDOID || Integer ||| Vordefinierte ID des neuen Datensatzes
|-
|-
| HandleType|| String ||| Typ der Aktion *
| contactpersonUserID || Integer ||| UserID des Besitzers
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
|-
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>deleteIDO</u>''
Löscht einen Datensatz


* mögliche Feldtypen
{| class="wikitable" border=1
● UPDATE (Standard) - ergänzt bestehenden Inhalt
! width="100px" | Parameter       
● OVERWRITE - überschreibt bestehenden Inhalt
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
| &nbsp; || |||
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
|     || |||
|}
|}




''<u>SetContactPerson</u>''
''<u>restoreIDO</u>''


Stellt einen gelöschten Datensatz wieder her


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 710: Zeile 1.247:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID    ||Integer ||| ID der IDO Instanz
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IdoID|| Integer||| ID des Datensatzes
|     || |||
|}
 
 
''<u>getIDOCount</u>''
 
Gibt die Anzahl aller Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.17)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
|-
| EmployeeID|| Integer||| UserID der Kontaktperson
| instanceID ||Integer ||| ID der IDO Instanz
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 722: Zeile 1.278:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
| || Integer ||| Anzahl Datensätze
|}
|}




''<u>SetMessageContent</u>''
''<u>getDatasetIDList</u>''
 
Gibt ein Array mit den IDs aller aktiven Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.36)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| || Array ||| DatensatzID-Array
|}
 
 
''<u>isIDOLock</u>''
 
Prüft ob ein Datensatz gesperrt ist
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      || Boolean |||
|}
 
 
''<u>setIDOLock</u>''
 
Sperrt einen Datensatz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| userID ||Integer ||| UserID des sperrenden Benutzers
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>releaseIDOLock</u>''
 
Gibt die Sperre eines Datensatzes frei
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''
 
Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanz und dem Match auf den Wert des angegebenen Textfeldes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| idoID || Integer ||| Datensatz ID
|}
 
 
''<u>getIDOIDByInstanceIdMappingKeyAndFieldValue</u>''
 
Liefert die ID eines Datensatzes anhand eines Mapping-Keys und eines Feldwertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Suchbegriff
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      || Integer |||
|}
 
 
''<u>GetIDOsByCantactperson</u>''
 
Liefert alle Datensätze einer Instanz, die einer bestimmten Kontaktperson zugeordnet sind
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| contactpersonID    ||Integer ||| ID der Kontaktperson
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchIDOByInstanceIDAndFieldIDByValue</u>''
 
Sucht Datensätze anhand eines exakten Textfeldwertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (exakter Treffer)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchLikeIDOByInstanceIDAndFieldIDByValue</u>''
 
Sucht Datensätze anhand eines Textfeldwertes (LIKE-Suche)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (Teilstring-Suche)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchIDOByInstanceIDAndFieldIDByNumberValue</u>''
 
Sucht Datensätze anhand eines exakten numerischen Feldwertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Wert)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchLikeIDOByInstanceIDAndFieldIDByNumberValue</u>''
 
Sucht Datensätze anhand eines numerischen Feldwertes (LIKE-Suche)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Teilstring)
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''
 
Sucht Datensätze anhand mehrerer Textfelder und deren Werte (exakte Suche)
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchLikeIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''
 
Sucht Datensätze anhand mehrerer Textfelder und deren Werte (LIKE-Suche)


Setzt den Wert des Hinweisfelds
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 734: Zeile 1.579:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceId     ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchIDOByInstanceIDAndCheckboxIDByValueID</u>''
 
Sucht Datensätze anhand eines gesetzten Checkbox-Wertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| instanceId    ||Integer ||| ID der IDO Instanz
|-
|-
| Value|| String||| Wert der Option
| fieldId || Integer ||| ID der Checkbox
|-
|-
| HandleType|| String ||| Typ der Aktion *
| valueId || String ||| ID des Checkbox-Wertes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
|-
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>searchIDOByInstanceIDAndCombofieldIDByValueID</u>''
Sucht Datensätze anhand eines gesetzten Combofeld-Wertes


-mögliche Aktionen
{| class="wikitable" border=1
● UPDATE (Standard) - ergänzt bestehenden Inhalt
! width="100px" | Parameter       
● OVERWRITE - überschreibt bestehenden Inhalt
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Combofeldes
|-
| valueId || String ||| ID des Combofeld-Wertes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
| &nbsp; || |||
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
|     || |||
|}
|}




''<u>SetContactDate</u>''


Setzt den Wert des Feldes nächster/letzter Kontakt
''<u>createTask</u>''
 
Erstellt eine neue Aufgabe
 
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 764: Zeile 1.653:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| title     ||String ||| Titel der Aufgabe
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| content ||String ||| Inhalt / Beschreibung der Aufgabe
|-
|-
| HandleType|| String||| Typ des Feldes *
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
|-
| Date|| String ||| Datum
| forerunTime ||Integer ||| Vorwarnzeit in Sekunden
|-
| alarmTimestamp ||Integer ||| Alarmzeitpunkt als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| responsibleUserId ||Integer ||| UserID des Verantwortlichen
|-
| responsibleUserState ||Integer ||| Status des Verantwortlichen
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
|-
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>linkTaskToIdo</u>''
Verknüpft eine Aufgabe mit einem IDO-Datensatz


* mögliche Feldtypen
{| class="wikitable" border=1
● NEXT (Standard) - Feld nächster Kontakt
! width="100px" | Parameter       
● LAST - Feld letzter Kontakt
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| taskId    ||Integer ||| ID der Aufgabe
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
| &nbsp; || |||
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
|     || |||
|}
|}




''<u>SetContactTime</u>''
''<u>createNote</u>''
 
Erstellt eine neue Notiz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| title    ||String ||| Titel der Notiz
|-
| content ||String ||| Inhalt der Notiz
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| ownerUserState ||Integer ||| Status des Erstellers
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>linkNoteToIdo</u>''
 
Verknüpft eine Notiz mit einem IDO-Datensatz


Setzt die Uhrzeit des nächsten Kontakts
{| class="wikitable" border=1  
{| class="wikitable" border=1  
! width="100px" | Parameter         
! width="100px" | Parameter         
Zeile 794: Zeile 1.742:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| noteId     ||Integer ||| ID der Notiz
|-
|-
| IdoID|| Integer||| ID des Datensatzes
| instanceId ||Integer ||| ID der IDO Instanz
|-
|-
| Time|| String||| Uhrzeit (HH:MM:SS)
| idoId ||Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 806: Zeile 1.754:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolian||| Status der Abfrage
|     || |||
|}
|}
== Hauptkapitel ==
* [[Webservice Dokumentation]]
== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Aktuelle Version vom 13. Mai 2026, 11:57 Uhr

  • WSDL Datei

Die zur Nutzung der infra-struktur IDO Webservices notwendige WSDL-Datei finden Sie unter:

http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido

Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices 

  <?php
  //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
  $client = new SoapClient("http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
  
  //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
  $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));
  
  //In der IDO Instanz mit der ID 1, im Datensatz mit der ID 2, das Textfeld mit der ID 3 auf den Wert "vier" setzen
  $client->__soapCall("setTextfieldValue",array(1,2,3,"vier",$token));
  
  //Alle Textfelder der Instanz mit der ID 1 ermitteln und die dazugehörigen Werte ausgeben
  foreach($client->__soapCall("getTextfieldsByInstanceID",array(1,$token)) as $feldID => $feldName)
  {
      //Den Namen des ermittelten Felds in den UTF-8 Zeichensatz konvertieren und ausgeben
      echo "Name des Feldes: ".utf8_decode($feldName);
  }
  ?>
  • Funktionsübersicht

Authenticate

Authentifiziert einen Benutzer am Webservice

Parameter Datentyp Beschreibung
instanceName String Vollständiger Pfad der Instanz
userName String infra-struktur Benutzername
password String infra-struktur Passwort
 
Rückgabewert
token String Authentifizierungstoken für weitere Anfragen am Webservice


getInstances

Liefert sämtliche verfügbare IDO Instanzen

Parameter Datentyp Beschreibung
userID Integer UserID des Benutzers
token String Validierungstoken
 
Rückgabewert
idoInstances Array Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)


getTextfieldsByInstanceID

Liefert sämtliche Textfelder zur gewählten Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
idoTextFields Array Array mit den verfügbaren Textfeldern (FeldID,Feldname)


getSelectFieldsByInstanceID

Liefert sämtliche Selectfelder der gewählten Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
idoSelectFields Array Array mit den verfügbaren Selectfeldern (FeldID,Feldname)


getRadiofieldsByInstanceID

Liefert sämtliche Radiofelder der gewählten Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
idoRadiofields Array Array mit den verfügbaren Radiofeldern (FeldID,Feldname)


getCheckboxesByInstanceID

Liefert sämtliche Checkboxen der gewählten Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
idoCheckboxes Array Array mit den verfügbaren Checkboxen (FeldID,Feldname)


CountConfigurenCheckboxesByInstanceID

Gibt die Anzahl der verfügbaren Checkboxen zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
countCheckboxes Integer Anzahl der verfügbaren Felder


CountConfiguredSelectfieldsByInstanceID

Gibt die Anzahl der verfügbaren Selectfelder zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
countSelectfields Integer Anzahl der verfügbaren Felder


CountConfiguredRadiofieldsByInstanceID

Gibt die Anzahl der verfügbaren Radiofelder zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
countSelectfields Integer Anzahl der verfügbaren Felder


getPossibleCheckboxValues

Liefert die Auswahlmöglichkeiten einer Checkbox

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
checkboxID Integer ID der Checkbox
token String Validierungstoken
 
Rückgabewert
checkboxValues Array Array mit den verfügbaren Values (ValueID,ValueName)


getPossibleSelectfieldValues

Liefert die Auswahlmöglichkeiten eines Selectfeldes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
feldID Integer ID der Selectbox
token String Validierungstoken
 
Rückgabewert
selectfieldsValues Array Array mit den verfügbaren Values (ValueID,ValueName)


getPossibleRadiofieldValues

Liefert die Auswahlmöglichkeiten einer Radiobox

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
feldID Integer ID des Radiofelds
token String Validierungstoken
 
Rückgabewert
radiofieldValues Array Array mit den verfügbaren Values (ValueID,ValueName)


getIDOInstanceSpecialFieldConfiguration

Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
specialFieldType String Abzufragende Konfiguration, mögliche SpecialFieldTypes:
  • archivefield - Ist das Archivfeld aktiviert
  • messagefield - Ist das Hinweisfeld aktiviert
  • nextcontacttime - Ist das nächster Kontaktfeld (Uhrzeit) aktiviert
  • nextcontact - Ist das nächster Kontaktfeld (Datum) aktiviert
  • datasetowner - Ist das Feld Kontaktperson aktiviert
  • lastcontact - Ist das Feld letzter Kontakt aktiviert
  • deleteright - Ist der Löschen-Button aktiviert
token String Validierungstoken
 
Rückgabewert
true/false Boolean Konfigurationsstatus


GenerateFieldTypeArray

Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
fieldTypeArray Array Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname


getFieldType

Liefert den Typ eines bestimmten Feldes zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Feldes
fieldName String Name des Feldes
token String Validierungstoken
 
Rückgabewert
feldtyp String Typ des Feldes


getFullIDOStructure

Liefert die vollständige Struktur einer IDO-Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


getIdoMappingFieldsByInstanceIdAndIdoId

Liefert die Mapping-Felder eines Datensatzes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


openRemoteIDO

Öffnet einen IDO-Datensatz remote

Parameter Datentyp Beschreibung
userID Integer UserID des Benutzers
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


getDataByInstanceIDOIdAndFieldID

Liefert den Wert des angegebenen Feldes zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID des Feldes
fieldType String Typ des Feldes, mögliche Feldtypen:
  • optfield (Standard)
  • radiofield
  • selectfield
token String Validierungstoken
 
Rückgabewert
fieldValue String Wert des Feldes


getCheckedValuesForInstanceAndCheckBoxID

Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolean zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
checkboxID Integer ID der Checkbox
token String Validierungstoken
 
Rückgabewert
checkBoxValues Array Array dessen Key die ValueID und das Value der Name ist


getPossibleValuesForInstanceAndCheckboxID

Liefert alle verfügbaren Einträge einer Checkbox zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
checkboxID Integer ID der Checkbox
token String Validierungstoken
 
Rückgabewert
checkBoxValues Array Array dessen Key die ValueID und das Value der Name ist


getArchiveContent

Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
archiveContent String Inhalt des Archivfelds


getMessageContent

Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
messageContent String Inhalt des Hinweisfelds


getNextContact

Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
nextContact String Datum des nächsten Kontakts


getNextContactTime

Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
nextContactTime String Uhrzeit des nächsten Kontakts


getLastContact

Liefert das Datum des letzten Kontakts zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
String


IsTerminOnNextContact

Liefert zurück ob der nächste Kontakt ein Termin ist

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
isTermin Boolean Termin oder nicht


getContactPerson

Liefert die ausgewählte Kontaktperson des Datensatzes zurück

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
contactPerson Integer UserID der Kontaktperson


getAllEntries

Liefert alle Einträge einer IDO-Instanz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


getFullIdoInstance

Liefert alle Datensätze einer IDO-Instanz (mit Paginierung und Zeitfilter)

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
offset anyType Startposition (für Paginierung)
limit anyType Maximale Anzahl zurückgegebener Datensätze
lastModificationTimestamp anyType Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden
token String Validierungstoken
 
Rückgabewert


getIdoContextValue

Liefert den Kontextwert eines Datensatzes

Parameter Datentyp Beschreibung
userId Integer UserID des Benutzers
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


getIdoListByGivenIDs

Liefert eine Liste von Datensätzen anhand einer Liste von IDs

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoIdList anyType Array mit den abzufragenden Datensatz-IDs
token String Validierungstoken
 
Rückgabewert


setValueForDataset

Setzt den Wert eines bestimmten Feldes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID des Feldes
value String Wert des Feldes
fieldType String Feldtyp des Feldes
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setTextFieldValue

Setzt den Wert eines Textfeldes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID des Feldes
fieldValue String Wert der Option
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setArchiveContent

Setzt den Wert des Archivfelds

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldValue String Wert der Option
handleType String Typ der Aktion, mögliche Feldtypen:
  • UPDATE (Standard) - ergänzt bestehenden Inhalt
  • OVERWRITE - überschreibt bestehenden Inhalt
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setMessageContent

Setzt den Wert des Hinweisfelds

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldValue String Wert der Option
handleType String Typ der Aktion, mögliche Aktionen:
  • UPDATE (Standard) - ergänzt bestehenden Inhalt
  • OVERWRITE - überschreibt bestehenden Inhalt
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setContactPerson

Setzt die Kontaktperson eines Datensatzes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
employeeID Integer UserID der Kontaktperson
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setContactDate

Setzt den Wert des Feldes nächster/letzter Kontakt

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
handleType String Typ des Feldes, mögliche Feldtypen:
  • NEXT (Standard) - Feld nächster Kontakt
  • LAST - Feld letzter Kontakt
date String Datum
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setContactTime

Setzt die Uhrzeit des nächsten Kontakts

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
time String Uhrzeit (HH:MM:SS)
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setTermin

Setzt den nächsten Kontakt als Termin

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
switchStatus Boolean Termin oder nicht
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setCombofield

Setzt den Wert eines Combofeldes

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID des Combofeldes
valueID Integer ID des Values
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setCheckboxValues

Setzt den Wert einer Checkbox

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
fieldID Integer ID der Checkbox
values Array Checkboxwerte als Array im Format

array('ValueID1' => true, 'ValueID2' => false, ...)

token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


setValueOfMappedField

Setzt den Wert eines Feldes anhand seines Mapping-Keys

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
idoId Integer ID des Datensatzes
mappingKey String Mapping-Key des Feldes
fieldValue String Wert des Feldes
token String Validierungstoken
 
Rückgabewert
status Boolean Status der Abfrage


addCombovalue

Fügt einen neuen Wert zu einem Combofeld hinzu

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Combofeldes
value String Neuer Wert
token String Validierungstoken
 
Rückgabewert


addValueForComboField

Fügt einen neuen Wert zu einem Combofeld hinzu

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Combofeldes
value String Neuer Wert
token String Validierungstoken
 
Rückgabewert


addValueForDemoField

Fügt einen neuen Wert zu einem Demo-Feld hinzu

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Feldes
value String Neuer Wert
token String Validierungstoken
 
Rückgabewert


refreshTheIdoUserInterface

Aktualisiert die IDO-Benutzeroberfläche

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


CreateNewDataset

Erstellt einen neuen, leeren Datensatz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
contactPersonUserID Integer UserID des Besitzers
token String Validierungstoken
 
Rückgabewert
idoID Integer ID des neuen Datensatz


createNewDatasetWithID

Erstellt einen neuen Datensatz mit einer vordefinierten ID

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
definedIDOID Integer Vordefinierte ID des neuen Datensatzes
contactpersonUserID Integer UserID des Besitzers
token String Validierungstoken
 
Rückgabewert


deleteIDO

Löscht einen Datensatz

Parameter Datentyp Beschreibung
idoID Integer ID des Datensatzes
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


restoreIDO

Stellt einen gelöschten Datensatz wieder her

Parameter Datentyp Beschreibung
idoID Integer ID des Datensatzes
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


getIDOCount

Gibt die Anzahl aller Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.17)

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
Integer Anzahl Datensätze


getDatasetIDList

Gibt ein Array mit den IDs aller aktiven Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.36)

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert
Array DatensatzID-Array


isIDOLock

Prüft ob ein Datensatz gesperrt ist

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert
Boolean


setIDOLock

Sperrt einen Datensatz

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
userID Integer UserID des sperrenden Benutzers
token String Validierungstoken
 
Rückgabewert


releaseIDOLock

Gibt die Sperre eines Datensatzes frei

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


getIdoIDByInstanceIDAndFieldIDByFieldValue

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanz und dem Match auf den Wert des angegebenen Textfeldes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldId Integer ID des Textfeldes
textfieldValue String Suchbegriff
token String Validierungstoken
 
Rückgabewert
idoID Integer Datensatz ID


getIDOIDByInstanceIdMappingKeyAndFieldValue

Liefert die ID eines Datensatzes anhand eines Mapping-Keys und eines Feldwertes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
mappingKey String Mapping-Key des Feldes
fieldValue String Suchbegriff
token String Validierungstoken
 
Rückgabewert
Integer


GetIDOsByCantactperson

Liefert alle Datensätze einer Instanz, die einer bestimmten Kontaktperson zugeordnet sind

Parameter Datentyp Beschreibung
contactpersonID Integer ID der Kontaktperson
instanceID Integer ID der IDO Instanz
token String Validierungstoken
 
Rückgabewert


searchIDOByInstanceIDAndFieldIDByValue

Sucht Datensätze anhand eines exakten Textfeldwertes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldId Integer ID des Textfeldes
textfieldValue String Suchbegriff (exakter Treffer)
token String Validierungstoken
 
Rückgabewert


searchLikeIDOByInstanceIDAndFieldIDByValue

Sucht Datensätze anhand eines Textfeldwertes (LIKE-Suche)

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Textfeldes
textfieldValue String Suchbegriff (Teilstring-Suche)
token String Validierungstoken
 
Rückgabewert


searchIDOByInstanceIDAndFieldIDByNumberValue

Sucht Datensätze anhand eines exakten numerischen Feldwertes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldId Integer ID des Feldes
textfieldValue String Suchbegriff (numerischer Wert)
token String Validierungstoken
 
Rückgabewert


searchLikeIDOByInstanceIDAndFieldIDByNumberValue

Sucht Datensätze anhand eines numerischen Feldwertes (LIKE-Suche)

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
fieldID Integer ID des Feldes
textfieldValue String Suchbegriff (numerischer Teilstring)
token String Validierungstoken
 
Rückgabewert


searchIDOByInstanceIdAndMultipleTextfieldIdsWithValues

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (exakte Suche)

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldIdWithValues anyType Array mit Feld-IDs und zugehörigen Suchwerten
token String Validierungstoken
 
Rückgabewert


searchLikeIDOByInstanceIdAndMultipleTextfieldIdsWithValues

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (LIKE-Suche)

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldIdWithValues anyType Array mit Feld-IDs und zugehörigen Suchwerten
token String Validierungstoken
 
Rückgabewert


searchIDOByInstanceIDAndCheckboxIDByValueID

Sucht Datensätze anhand eines gesetzten Checkbox-Wertes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldId Integer ID der Checkbox
valueId String ID des Checkbox-Wertes
token String Validierungstoken
 
Rückgabewert


searchIDOByInstanceIDAndCombofieldIDByValueID

Sucht Datensätze anhand eines gesetzten Combofeld-Wertes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
fieldId Integer ID des Combofeldes
valueId String ID des Combofeld-Wertes
token String Validierungstoken
 
Rückgabewert


createTask

Erstellt eine neue Aufgabe

Parameter Datentyp Beschreibung
title String Titel der Aufgabe
content String Inhalt / Beschreibung der Aufgabe
fixedMaturityTimestamp Integer Fälligkeitsdatum als Unix-Timestamp
forerunTime Integer Vorwarnzeit in Sekunden
alarmTimestamp Integer Alarmzeitpunkt als Unix-Timestamp
ownerUserId Integer UserID des Erstellers
responsibleUserId Integer UserID des Verantwortlichen
responsibleUserState Integer Status des Verantwortlichen
token String Validierungstoken
 
Rückgabewert


linkTaskToIdo

Verknüpft eine Aufgabe mit einem IDO-Datensatz

Parameter Datentyp Beschreibung
taskId Integer ID der Aufgabe
instanceId Integer ID der IDO Instanz
idoId Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


createNote

Erstellt eine neue Notiz

Parameter Datentyp Beschreibung
title String Titel der Notiz
content String Inhalt der Notiz
fixedMaturityTimestamp Integer Fälligkeitsdatum als Unix-Timestamp
ownerUserId Integer UserID des Erstellers
ownerUserState Integer Status des Erstellers
token String Validierungstoken
 
Rückgabewert


linkNoteToIdo

Verknüpft eine Notiz mit einem IDO-Datensatz

Parameter Datentyp Beschreibung
noteId Integer ID der Notiz
instanceId Integer ID der IDO Instanz
idoId Integer ID des Datensatzes
token String Validierungstoken
 
Rückgabewert


Hauptkapitel

Verwandte Themen

Abgerufen von „https://adminwiki210.infra-struktur.de/index.php?title=Webservice_ido&oldid=2797“