Webservice dms: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 82: Zeile 82:
|-
|-
| DocumentID|| Integer||| ID des Dokuments in der Datenbank
| DocumentID|| Integer||| ID des Dokuments in der Datenbank
|}
''<u>setDocumentStatus</u>''
Setzt den Status eines Dokuments
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID der Statusänderung
|-
| DocumentID|| Integer||| DokumentID der Statusänderung
|-
| UserStatus|| Integer||| Gewünschter Status
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}
|}

Version vom 8. Mai 2009, 12:54 Uhr

  • WSDL Datei

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

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?dms

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
  $client = new SoapClient("http://instanz.infra-struktur.de/webservice/wsdl/wsdl.php?dms",array('exceptions'=>false));
  $token = $client->__soapCall("authenticate",array("http://instanz.infra-struktur.de","username","passwort"));
  $documentContent = file_get_contents("http://localhost/bild.jpg");
  $document = array("filename" => "bild.jpg", "filetype" => "image/jpeg","filesource" => base64_encode($documentContent));
  $document2 = array("filename" => "bild.jpg", "filetype" => "image/jpeg","filesource" => base64_encode($documentContent));
  $documentID = $client->__soapCall("insertNewDocument",array("tolles Bild","mein tolles Bild",$PostBoxID,$AuthorID,$document,$token));
  $client->__soapCall("setArchiveStatus",array($documentID));
  echo $client->__soapCall("addVersion",array($documentID,
  $document2,"small","neues tolles Bild","Version 2 vom Bild",$AuthorID,$token));
  $client->__soapCall("setIDO",array($documentID,7,1,$token));
  ?>


  • 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


insertNewDocument

Speichert ein neues Dokument in der Datenbank

Parameter Datentyp Beschreibung
Title String Titel des Dokuments im DMS
Description String Beschreibungstext des Dokuments
BoxID Integer ID der Zielablage im DMS
AuthorID Integer BenutzerID des Autors
Document Array Array mit den Daten des Dokuments array("filename" => "bild.jpg","filetype" => "image/jpeg","filesource" => some binary stuff)
Token String Authentifizierungstoken
Password String/null Passwort für das Dokument
Date Integer/null Datum als Timestamp
Status Integer Status des Dokuments
 
Rückgabewert
DocumentID Integer ID des Dokuments in der Datenbank


setDocumentStatus

Setzt den Status eines Dokuments

Parameter Datentyp Beschreibung
UserID Integer BenutzerID der Statusänderung
DocumentID Integer DokumentID der Statusänderung
UserStatus Integer Gewünschter Status
Token String Authentifizierungstoken
 
Rückgabewert
Status Boolean Ergebnis des Aufrufs