Webservice ido: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen VersionsunterschiedZum nächsten Versionsunterschied →
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 5: Zeile 5:
http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
http://instanzname.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.
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl" benötigt.


* '''Example'''  
* '''Example'''  
Zeile 54: Zeile 54:




''<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 63:
! 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 71:
| <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 84:
! 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 92:
| <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)
|}
|}


Zeile 105: Zeile 105:
! 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 113:
| <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)
|}
|}


Zeile 126: Zeile 126:
! 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 134:
| <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)
|}
|}


Zeile 147: Zeile 147:
! 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 155:
| <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 168:
! 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 176:
| <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 189:
! 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 197:
| <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 210:
! 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 218:
| <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>''


Gibt die Anzahl der verfügbaren Radiofelder zurück
Liefert die Auswahlmöglichkeiten einer Checkbox


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 234: Zeile 231:
! 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 242: Zeile 241:
| <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)
|}
|}


Zeile 255: Zeile 254:
! 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 265: Zeile 264:
| <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)
|}
|}


Zeile 278: Zeile 277:
! 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 288: Zeile 287:
| <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)
|}
|}


Zeile 301: Zeile 300:
! 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:
| specialFieldType || String ||| Abzufragende Konfiguration, mögliche SpecialFieldTypes:
* archivefield - Ist das Archivfeld aktiviert
* archivefield - Ist das Archivfeld aktiviert
* messagefield - Ist das Hinweisfeld aktiviert
* messagefield - Ist das Hinweisfeld aktiviert
Zeile 318: Zeile 317:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| true/false|| Boolean||| Konfigurationsstatus
| true/false || Boolean ||| Konfigurationsstatus
|}
|}


Zeile 331: Zeile 330:
! 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 339: Zeile 338:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| ContactFields|| Array||| Array mit den verfügbaren Feldern (FeldID,Feldname)
| contactFields || Array ||| Array mit den verfügbaren Feldern (FeldID,Feldname)
|}
|}


Zeile 352: Zeile 351:
! 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 360: Zeile 359:
| <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
| fieldTypeArray || Array ||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|}
|}


Zeile 373: Zeile 372:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| FieldID|| Integer||| ID des Feldes
| fieldID || Integer ||| ID des Feldes
|-
|-
| FieldName|| String||| Name des Feldes
| fieldName || String ||| Name des Feldes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 385: Zeile 384:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Feldtyp|| String||| Typ des Feldes
| feldtyp || String ||| Typ des Feldes
|}
 
 
''<u>getFullIDOStructure</u>''
 
Liefert die vollständige Struktur einer IDO-Instanz
 
{| 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> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getIdoMappingFieldsByInstanceIdAndIdoId</u>''
 
Liefert die Mapping-Felder 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
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>openRemoteIDO</u>''
 
Öffnet einen IDO-Datensatz remote
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| userID    ||Integer ||| UserID des Benutzers
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID    ||Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
|}


Zeile 398: Zeile 466:
! 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, mögliche Feldtypen
| fieldType || String ||| Typ des Feldes, mögliche Feldtypen:
* optfield (Standard)
* optfield (Standard)
* radiofield
* radiofield
* selectfield
* selectfield
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 416: Zeile 483:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| FieldValue|| String||| Wert des Feldes
| fieldValue || String ||| Wert des Feldes
|}
|}


Zeile 429: Zeile 496:
! 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 441: Zeile 508:
| <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
|}
|}


Zeile 454: Zeile 521:
! 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 464: Zeile 531:
| <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
|}
|}


Zeile 477: Zeile 544:
! 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 487: Zeile 554:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| ArchiveContent|| String||| Inhalt des Archivfelds
| archiveContent || String ||| Inhalt des Archivfelds
|}
|}


Zeile 500: Zeile 567:
! 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 510: Zeile 577:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| MessageContent|| String||| Inhalt des Hinweisfelds
| messageContent || String ||| Inhalt des Hinweisfelds
|}
|}


Zeile 523: Zeile 590:
! 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 533: Zeile 600:
| <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
|}
|}


Zeile 546: Zeile 613:
! 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> ||        |||
|-
| nextContactTime || String ||| Uhrzeit des nächsten Kontakts
|}
 
 
''<u>getLastContact</u>''
 
Liefert das Datum des letzten 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
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 556: Zeile 646:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| NextContactTime|| String||| Uhrzeit des nächsten Kontakts
|     || String |||
|}
|}


Zeile 569: Zeile 659:
! 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 579: Zeile 669:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| isTermin|| Boolean||| Termin oder nicht
| isTermin || Boolean ||| Termin oder nicht
|}
|}


Zeile 592: Zeile 682:
! 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
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getFullContactsByIdoId</u>''
 
Liefert alle Ansprechpartner 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
| idoID || Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 602: Zeile 736:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| contactPerson|| Integer||| UserID der Kontaktperson
|     ||  |||
|}
 
 
''<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
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| userId    ||Integer ||| UserID des Benutzers
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token    || String ||| Validierungstoken
|-
| &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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
|}


Zeile 608: Zeile 817:
''<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  
Zeile 615: Zeile 824:
! 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 des Feldes
| value || String ||| Wert des Feldes
|-
|-
| FieldType|| String ||| Feldtyp des Feldes
| fieldType || String ||| Feldtyp des Feldes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 631: Zeile 840:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 637: Zeile 846:
''<u>setTextFieldValue</u>''
''<u>setTextFieldValue</u>''


setzt den Wert eines Textfeldes
Setzt den Wert eines Textfeldes


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 644: Zeile 853:
! 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 658: Zeile 867:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 664: Zeile 873:
''<u>setArchiveContent</u>''
''<u>setArchiveContent</u>''


setzt den Wert des Archivfelds
Setzt den Wert des Archivfelds


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 671: Zeile 880:
! 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
|-
|-
| Value|| String||| Wert der Option
| fieldValue || String ||| Wert der Option
|-
|-
| HandleType|| String ||| Typ der Aktion, mögliche Feldtypen:
| handleType || String ||| Typ der Aktion, mögliche Feldtypen:
* UPDATE (Standard) - ergänzt bestehenden Inhalt
* UPDATE (Standard) - ergänzt bestehenden Inhalt
* OVERWRITE - überschreibt bestehenden Inhalt
* OVERWRITE - überschreibt bestehenden Inhalt
Zeile 687: Zeile 896:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}




''<u>setContactPerson</u>''
''<u>setMessageContent</u>''


Setzt den Wert des Hinweisfelds


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 699: Zeile 909:
! 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
|-
|-
| EmployeeID|| Integer||| UserID der Kontaktperson
| 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
| token    || String ||| Validierungstoken
Zeile 711: Zeile 925:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}




''<u>setMessageContent</u>''
''<u>setContactPerson</u>''


setzt den Wert des Hinweisfelds
Setzt die Kontaktperson eines Datensatzes


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 724: Zeile 938:
! 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
|-
|-
| Value|| String||| Wert der Option
| employeeID || Integer ||| UserID der Kontaktperson
|-
| HandleType|| String ||| Typ der Aktion, mögliche Aktionen:
* UPDATE (Standard) - ergänzt bestehenden Inhalt
* OVERWRITE - überschreibt bestehenden Inhalt
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 740: Zeile 950:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 746: Zeile 956:
''<u>setContactDate</u>''
''<u>setContactDate</u>''


setzt den Wert des Feldes nächster/letzter Kontakt
Setzt den Wert des Feldes nächster/letzter Kontakt


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 753: Zeile 963:
! 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
|-
|-
| HandleType|| String||| Typ des Feldes, mögliche Feldtypen:
| handleType || String ||| Typ des Feldes, mögliche Feldtypen:
* NEXT (Standard) - Feld nächster Kontakt
* NEXT (Standard) - Feld nächster Kontakt
* LAST - Feld letzter Kontakt
* LAST - Feld letzter Kontakt
|-
|-
| Date|| String ||| Datum
| date || String ||| Datum
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 769: Zeile 979:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 775: Zeile 985:
''<u>setContactTime</u>''
''<u>setContactTime</u>''


setzt die Uhrzeit des nächsten Kontakts
Setzt die Uhrzeit des nächsten Kontakts


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 782: Zeile 992:
! 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
|-
|-
| Time|| String||| Uhrzeit (HH:MM:SS)
| time || String ||| Uhrzeit (HH:MM:SS)
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 794: Zeile 1.004:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 800: Zeile 1.010:
''<u>setTermin</u>''
''<u>setTermin</u>''


setzt den nächsten Kontakt als Termin
Setzt den nächsten Kontakt als Termin


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 807: Zeile 1.017:
! 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
|-
|-
| SwitchStatus|| Boolean||| Termin oder nicht
| switchStatus || Boolean ||| Termin oder nicht
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 819: Zeile 1.029:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 825: Zeile 1.035:
''<u>setCombofield</u>''
''<u>setCombofield</u>''


setzt den Wert eines Combofeldes
Setzt den Wert eines Combofeldes


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 832: Zeile 1.042:
! 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 Combofeldes
| fieldID || Integer ||| ID des Combofeldes
|-
|-
| ValueID|| Integer||| ID der Values
| valueID || Integer ||| ID des Values
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 846: Zeile 1.056:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| status || Boolean ||| Status der Abfrage
|}
|}


Zeile 852: Zeile 1.062:
''<u>setCheckboxValues</u>''
''<u>setCheckboxValues</u>''


setzt den Wert einer Checkbox
Setzt den Wert einer Checkbox


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 859: Zeile 1.069:
! 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 der Checkbox
| fieldID || Integer ||| ID der Checkbox
|-
|-
| Values|| Array||| Checkboxwerte als Array im Format  
| values || Array ||| Checkboxwerte als Array im Format
array('ValueID1' => true, 'ValueID2' => false, ...)
array('ValueID1' => true, 'ValueID2' => false, ...)
|-
|-
Zeile 874: Zeile 1.084:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Status|| Boolean||| Status der Abfrage
| 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>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''
''<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>''


Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanzund dem Match auf den Wert des angegebenen Textfeldes
Fügt einen neuen Wert zu einem Demo-Feld hinzu


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 887: Zeile 1.174:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID     ||Integer ||| ID der IDO Instanz
| instanceID     ||Integer ||| ID der IDO Instanz
|-
|-
| FieldID|| Integer||| ID des Textfeldes
| fieldID || Integer ||| ID des Feldes
|-
|-
| TextfieldValue|| String||| Suchbegriff
| value || String ||| Neuer Wert
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 899: Zeile 1.186:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IDOID|| Integer||| Datensatz ID
|     ||  |||
|}
 
 
''<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> ||        |||
|-
|      ||  |||
|}
|}


Zeile 912: Zeile 1.222:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID||Integer||| ID der IDO Instanz
| instanceID ||Integer ||| ID der IDO Instanz
|-
|-
| ContactPerson|| Integer||| UserID des Besitzers
| contactPersonUserID || Integer ||| UserID des Besitzers
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 922: Zeile 1.232:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| IDOID|| Integer||| ID des neuen Datensatz
| 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
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| definedIDOID || Integer ||| Vordefinierte ID des neuen Datensatzes
|-
| contactpersonUserID || Integer ||| UserID des Besitzers
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>deleteIDO</u>''
Löscht einen Datensatz
{| 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>restoreIDO</u>''
Stellt einen gelöschten Datensatz wieder her
{| 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}


''<u>getIDOCount</u>''
''<u>getIDOCount</u>''
Zeile 934: Zeile 1.316:
! 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 942: Zeile 1.324:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| || Integer||| Anzahl Datensätze
| || Integer ||| Anzahl Datensätze
|}
|}


Zeile 955: Zeile 1.337:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| InstanceID||Integer||| ID der IDO Instanz
| 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)
 
{| 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>searchIDOByInstanceIDAndCheckboxIDByValueID</u>''
 
Sucht Datensätze anhand eines gesetzten Checkbox-Wertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceId    ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID der Checkbox
|-
| valueId || String ||| ID des Checkbox-Wertes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>searchIDOByInstanceIDAndCombofieldIDByValueID</u>''
 
Sucht Datensätze anhand eines gesetzten Combofeld-Wertes
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! 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; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getContactCount</u>''
 
Gibt die Anzahl der Ansprechpartner eines Datensatzes 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> ||        |||
|-
|      || Integer |||
|}
 
 
''<u>getContacts</u>''
 
Liefert alle Ansprechpartner eines Datensatzes
 
{| 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getContactFields</u>''
 
Liefert die verfügbaren Felder des Ansprechpartner-Reiters
 
{| 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> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getContactDataByInstanceIDOIDAndFieldID</u>''
 
Liefert den Wert eines bestimmten Feldes eines Ansprechpartners
 
{| 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 Feldes
|-
| contactID ||Integer ||| ID des Ansprechpartners
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>getNextContactID</u>''
 
Liefert die ID des nächsten Ansprechpartners
 
{| 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> ||        |||
|-
|      || Integer |||
|}
 
 
''<u>searchContactByValue</u>''
 
Sucht Ansprechpartner anhand eines Suchbegriffs
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| searchString ||String ||| Suchbegriff
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>addContact</u>''
 
Fügt einen neuen Ansprechpartner zu einem Datensatz hinzu
 
{| 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>setContactValue</u>''
 
Setzt den Wert eines Feldes eines Ansprechpartners
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| instanceID    ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| contactID ||Integer ||| ID des Ansprechpartners
|-
| fieldID ||Integer ||| ID des Feldes
|-
| value ||String ||| Wert des Feldes
|-
| token    || String ||| Validierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>createTask</u>''
 
Erstellt eine neue Aufgabe
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | 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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<u>linkTaskToIdo</u>''
 
Verknüpft eine Aufgabe mit einem IDO-Datensatz
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! 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; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
 
 
''<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
 
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| noteId    ||Integer ||| ID der Notiz
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
|-
| token    || String ||| Validierungstoken
| token    || String ||| Validierungstoken
Zeile 963: Zeile 1.991:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| || array||| DatensatzID-Array
|     || |||
|}
|}


Version vom 13. Mai 2026, 08:12 Uhr

  • WSDL Datei

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

http://instanzname.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 

  <?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


getConfiguredContactsTextFields

Liefert die konfigurierten Felder des Ansprechpartnerreiters

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


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


getFullContactsByIdoId

Liefert alle Ansprechpartner eines Datensatzes

Parameter Datentyp Beschreibung
instanceId Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
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


getContactCount

Gibt die Anzahl der Ansprechpartner eines Datensatzes zurück

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


getContacts

Liefert alle Ansprechpartner eines Datensatzes

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


getContactFields

Liefert die verfügbaren Felder des Ansprechpartner-Reiters

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


getContactDataByInstanceIDOIDAndFieldID

Liefert den Wert eines bestimmten Feldes eines Ansprechpartners

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


getNextContactID

Liefert die ID des nächsten Ansprechpartners

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


searchContactByValue

Sucht Ansprechpartner anhand eines Suchbegriffs

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


addContact

Fügt einen neuen Ansprechpartner zu einem Datensatz hinzu

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


setContactValue

Setzt den Wert eines Feldes eines Ansprechpartners

Parameter Datentyp Beschreibung
instanceID Integer ID der IDO Instanz
idoID Integer ID des Datensatzes
contactID Integer ID des Ansprechpartners
fieldID Integer ID des Feldes
value String Wert des Feldes
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=2755“