Webservice ido

• WSDL Datei

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

http://instanzname.infra-struktur.de/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.de/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.de","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

• 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

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
SpecialFieldType	String	Abzufragende Konfiguration *
token	String	Validierungstoken
Rückgabewert
true/false	Boolian	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

• mögliche Feldtypen

● optfield (Standard) ● radiofield ● selectfield

Parameter	Datentyp	Beschreibung
InstanceID	Integer	ID der IDO Instanz
IdoID	Integer	ID des Datensatzes
FieldID	Integer	ID des Feldes
FieldType	String	Typ des Feldes *
token	String	Validierungstoken
Rückgabewert
FieldValue	String	Wert des Feldes