Webservice ido

• 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

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

• Webservice Dokumentation

Verwandte Themen

• Webservice_activities
• Webservice_calendar
• Webservice_contacts
• Webservice_dms
• Webservice_ido
• Webservice_msg
• Webservice_user
• Webservice_email
• Webservice_task