Webservice ido: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 73: Zeile 73:
| idoTextFields    || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
| idoTextFields    || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
|}
|}


''<u>GetInstances</u>''
''<u>GetInstances</u>''
Zeile 92: Zeile 93:
|-
|-
| idoInstances    || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
| idoInstances    || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
|}
''<u>GetSelectFieldsByInstanceID</u>''
Liefert sämtliche Selectfelder der gewählten 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> ||        |||
|-
| IdoSelectFields    || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
|}
|}

Version vom 8. Mai 2009, 08:40 Uhr

  • 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)