Webservice ido

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
  • 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


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)


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)


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


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)


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


getPossibleSelectfieldValues

Liefert die Auswahlmöglichkeiten eines Selectfeldes

Parameter Datentyp Beschreibung
InstanceID Integer ID der IDO Instanz
SelectfieldID 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
RadiofieldID 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


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


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


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


setContactPerson


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


setMessageContent

setzt den Wert des Hinweisfelds

Parameter Datentyp Beschreibung
InstanceID Integer ID der IDO Instanz
IdoID Integer ID des Datensatzes
Value 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


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


getIdoIDByInstanceIDAndFieldIDByFieldValue

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanzund 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


CreateNewDataset

Erstellt einen neuen, leeren Datensatz

Parameter Datentyp Beschreibung
InstanceID Integer ID der IDO Instanz
ContactPerson Integer UserID des Besitzers
token String Validierungstoken
 
Rückgabewert
IDOID Integer ID des neuen Datensatz

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


Hauptkapitel

Verwandte Themen

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