Webservice dms: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
← Zum vorherigen Versionsunterschied
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
(13 dazwischenliegende Versionen von 3 Benutzern werden nicht angezeigt)
Zeile 3: Zeile 3:
Die zur Nutzung der infra-struktur Dokumentenmanagement Webservices notwendige WSDL-Datei finden Sie unter:
Die zur Nutzung der infra-struktur Dokumentenmanagement Webservices notwendige WSDL-Datei finden Sie unter:


http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?dms
http://demo.infra-struktur.eu/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
Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices


   <?php
   <?php
   $client = new SoapClient("http://instanz.infra-struktur.de/webservice/wsdl/wsdl.php?dms",array('exceptions'=>false));
   $client = new SoapClient("http://instanz.infra-struktur.eu/webservice/wsdl/wsdl.php?dms",array('exceptions'=>false));
   $token = $client->__soapCall("authenticate",array("http://instanz.infra-struktur.de","username","passwort"));
   $token = $client->__soapCall("authenticate",array("http://instanz.infra-struktur.eu","username","passwort"));
   $documentContent = file_get_contents("http://localhost/bild.jpg");
   $documentContent = file_get_contents("http://localhost/bild.jpg");
   $document = array("filename" => "bild.jpg", "filetype" => "image/jpeg","filesource" => base64_encode($documentContent));
   $document = array("filename" => "bild.jpg", "filetype" => "image/jpeg","filesource" => base64_encode($documentContent));
Zeile 73: Zeile 69:
| Password|| String <nowiki>|</nowiki> null ||| Passwort für das Dokument
| Password|| String <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
|-
| Date|| Integer/null||| Datum als Timestamp
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
|-
| Status|| Integer||| Status des Dokuments
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|-
| &nbsp; || |||
| &nbsp; || |||
Zeile 235: Zeile 231:
| Token|| String||| Authentifizierungstoken
| Token|| String||| Authentifizierungstoken
|-
|-
|}
''<u>getDocumentsForIDO</u>''
Gibt ein Array mit Dokumenten IDs zu einem Datensatz
{| class="wikitable" border=1
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| Result || Array||| Array mit den DokumentIDs
|}
|}


Zeile 460: Zeile 477:
| CategoryID|| Integer||| ID der Kategorie
| CategoryID|| Integer||| ID der Kategorie
|}
|}
''<u>addDocumentVersion</u>''
Fügt einem Dokument eine neue Version hinzu
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID    ||Integer ||| ID des Dokuments
|-
| Document    ||Array ||| Array mit den Daten des Dokuments array("filename" => "bild.jpg","filetype" => "image/jpeg","filesource" => some binary stuff)
|-
| Change    ||String ||| Größe der Änderung (small oder big)
|-
| ReleaseNotes    ||String ||| Releasenotes der Version
|-
| Title    ||String ||| Titel der neuen Version
|-
| UserID    ||Integer ||| ID des Autors
|-
| Token    || String ||| Authentifizierungstoken
|-
| Date    ||Integer ||| Timestamp
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getAllDocumentIDsForPostbox</u>''
Liefert alle Dokument-IDs einer Ablage
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID    ||Integer ||| ID der Ablage
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getDocument</u>''
Liefert ein Dokument als Array mit Metadaten und base64-kodiertem Dateiinhalt
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token|| String||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
| colspan="3" | Array mit folgenden Feldern:
|-
| DocumentID|| Integer||| ID des Dokuments
|-
| DocumentSourceID|| Integer <nowiki>|</nowiki> null||| Interne Quellen-ID
|-
| DocumentFilesize|| Integer||| Dateigröße in Bytes
|-
| DocumentMimetype|| String||| MIME-Typ der Datei (z.B. application/msword)
|-
| DocumentFilename|| String||| Dateiname inkl. Dateiendung (z.B. word.doc)
|-
| DocumentSource|| String||| Base64-kodierter Dateiinhalt – muss vor Verwendung dekodiert werden (base64_decode)
|}
''<u>getDocumentDetails</u>''
Liefert einen bestimmten Detailwert eines Dokuments. Rückgabe ist ein String oder null.
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID    ||Integer ||| ID des Dokuments
|-
| Information    ||String ||| Angeforderter Detailtyp, mögliche Werte:
* MIMETYPE – MIME-Typ der Datei
* BOXID – ID der Ablage
* FILESIZE – Dateigröße in KB
* TITLE – Titel des Dokuments (UTF-8)
* DESCRIPTION – Schlagworte / Beschreibung
* FILENAME – Dateiname (UTF-8)
* DATE – Datum als Unix-Timestamp
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      || String &#124; null ||| Wert des angefragten Detailtyps als String, oder null wenn nicht vorhanden. DATE wird als Unix-Timestamp zurückgegeben.
|}
''<u>getPostboxesWithArchiveRightsForUser</u>''
Liefert Ablagen, auf die ein Benutzer Archivrechte hat
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID    ||Integer ||| ID des Benutzers
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>getUsersWithRightOnPostbox</u>''
Liefert Benutzer mit Rechten auf eine Ablage
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID    ||Integer ||| ID der Ablage
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
''<u>isAllowedUserForPostBox</u>''
Prüft ob ein Benutzer Zugriff auf eine Ablage hat
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID    ||anyType ||| ID des Benutzers
|-
| BoxID    ||anyType ||| ID der Ablage
|-
| Token    || String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
== Hauptkapitel ==
* [[Webservice Dokumentation]]
== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Aktuelle Version vom 18. Mai 2026, 13:10 Uhr

  • WSDL Datei

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

http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?dms

Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices 

  <?php
  $client = new SoapClient("http://instanz.infra-struktur.eu/webservice/wsdl/wsdl.php?dms",array('exceptions'=>false));
  $token = $client->__soapCall("authenticate",array("http://instanz.infra-struktur.eu","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 | 0 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


setArchiveStatus

Archiviert ein Dokument

Parameter Datentyp Beschreibung
DocumentID Integer ID des zu archivierenden Dokuments
DocumentID String Authentifizierungstoken
 
Rückgabewert
Status Boolean Ergebnis des Aufrufs


setGlobalisation

globalisiert ein Dokument

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
ReceiverID Integer BenutzerID des Empfängers
SenderID Integer BenutzerID des Senders
GlobalisationMessage String Nachricht zur Globalisierung
Token String Authentifizierungstoken
 
Rückgabewert
GlobalID Integer ID der Globalisierung


addVersion

Fügt einem Dokument eine weitere Version hinzu

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Document Array Array mit den Daten des Dokuments array("filename" => "bild.jpg","filetype" => "image/jpeg","filesource" => some binary stuff)
Change String Größe der Änderung (small oder big)
Releasenotes String Releasenotes der Version
Title String Titel der neuen Version
UserID Integer ID des Autors
Token String Authentifizierungstoken
Date Integer Timestamp
 
Rückgabewert
Status Boolean Status der Funktion


setStatusForAllAllowedUsers

Setzt den Status für jeden Benutzer mit Recht auf das entsprechende Postfach

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Status Integer Status des Dokuments (0,1,2)
Token String Authentifizierungstoken
 
Rückgabewert
Status Boolean Status der Funktion


getBoxes

Liefert ein array mit allen verfügbaren DMS Ablagen


setIDO

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
IdoID Integer ID des Datensatz
InstanceID Integer ID der Instanz
Token String Authentifizierungstoken


getDocumentsForIDO

Gibt ein Array mit Dokumenten IDs zu einem Datensatz

Parameter Datentyp Beschreibung
InstanceID Integer ID der Instanz
IDOID Integer ID des Datensatzes
Token String Authentifizierungstoken
Rückgabewert
Result Array Array mit den DokumentIDs


setCategoryForDocumentAndIDO

Kategorisierte in Dokument in einer Kategorie des jeweiligen verknüpften Datensatz

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
InstanceID Integer ID der Instanz
IdoID Integer ID des Datensatz
CategoryID Integer ID der Kategorie
Token String Authentifizierungstoken
UpdateOnFailure Boolean Ändert bei bereits vorhandener Kategorisierung die Kategorie
 
Rückgabewert
Status Boolean Status der Aktion


changeDocumentTitle

Ändert den Titel eines Dokuments

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
DocumentTitle String Neuer Titel
Token String Authentifizierungstoken
 
Rückgabewert
Status Boolean Status der Aktion


getBoxes

Liefert eine Liste der verfügbaren Postfächer zurück

Parameter Datentyp Beschreibung
Token String Authentifizierungstoken
 
Rückgabewert
Boxes Array Array mit BoxID und Title


getMaxAllowedFilesize

Liefert die konfigurierte Maximalgröße für Dokumente in KB zurück

Parameter Datentyp Beschreibung
Token String Authentifizierungstoken
 
Rückgabewert
MaxDocumentSize Integer Max. Dateigröße in Kilobyte


getPostboxesForUserID

Liefert eine Liste der verfügbaren Postfächern für einen speziellen User zurück

Parameter Datentyp Beschreibung
UserID Integer ID des Users
Token String Authentifizierungstoken
 
Rückgabewert
Boxes Array Array mit BoxID und Titel


getDocumentTitle

Liefert den Titel eines Dokuments zurück

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Token String Authentifizierungstoken
 
Rückgabewert
DocumentTitle String Titel des Dokuments


getAuthorID

Liefert den Autor eines Dokuments zurück

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Token String Authentifizierungstoken
 
Rückgabewert
AuthorID Integer UserID des Autors


getDocumentStatus

Liefert den Status eines bestimmten Benutzers für ein Dokument zurück

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
UserID Integer ID des Benutzers
Token String Authentifizierungstoken
 
Rückgabewert
Status Integer Status des Dokuments (1/2/3)


getCategoriesForIDO

Liefert sämtliche einem Datensatz zugehörigen Kategorien

Parameter Datentyp Beschreibung
IdoID Integer ID des Datensatzes
InstanceID Integer ID der Instanz
Token String Authentifizierungstoken
 
Rückgabewert
Categories Array Verfügbare Kategorien


getCategoryForDocumentAndIDO

Liefert die Kategorie zurück mit welcher ein bestimmtes Dokument verknüpft ist

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
InstanceID Integer ID der Instanz
IdoID Integer ID des Datensatzes
Token String Authentifizierungstoken
 
Rückgabewert
CategoryID Integer ID der Kategorie

addDocumentVersion

Fügt einem Dokument eine neue Version hinzu

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Document Array Array mit den Daten des Dokuments array("filename" => "bild.jpg","filetype" => "image/jpeg","filesource" => some binary stuff)
Change String Größe der Änderung (small oder big)
ReleaseNotes String Releasenotes der Version
Title String Titel der neuen Version
UserID Integer ID des Autors
Token String Authentifizierungstoken
Date Integer Timestamp
 
Rückgabewert


getAllDocumentIDsForPostbox

Liefert alle Dokument-IDs einer Ablage

Parameter Datentyp Beschreibung
PostboxID Integer ID der Ablage
Token String Authentifizierungstoken
 
Rückgabewert


getDocument

Liefert ein Dokument als Array mit Metadaten und base64-kodiertem Dateiinhalt

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Token String Authentifizierungstoken
 
Rückgabewert
Array mit folgenden Feldern:
DocumentID Integer ID des Dokuments
DocumentSourceID Integer | null Interne Quellen-ID
DocumentFilesize Integer Dateigröße in Bytes
DocumentMimetype String MIME-Typ der Datei (z.B. application/msword)
DocumentFilename String Dateiname inkl. Dateiendung (z.B. word.doc)
DocumentSource String Base64-kodierter Dateiinhalt – muss vor Verwendung dekodiert werden (base64_decode)


getDocumentDetails

Liefert einen bestimmten Detailwert eines Dokuments. Rückgabe ist ein String oder null.

Parameter Datentyp Beschreibung
DocumentID Integer ID des Dokuments
Information String Angeforderter Detailtyp, mögliche Werte:
  • MIMETYPE – MIME-Typ der Datei
  • BOXID – ID der Ablage
  • FILESIZE – Dateigröße in KB
  • TITLE – Titel des Dokuments (UTF-8)
  • DESCRIPTION – Schlagworte / Beschreibung
  • FILENAME – Dateiname (UTF-8)
  • DATE – Datum als Unix-Timestamp
Token String Authentifizierungstoken
 
Rückgabewert
String | null Wert des angefragten Detailtyps als String, oder null wenn nicht vorhanden. DATE wird als Unix-Timestamp zurückgegeben.


getPostboxesWithArchiveRightsForUser

Liefert Ablagen, auf die ein Benutzer Archivrechte hat

Parameter Datentyp Beschreibung
UserID Integer ID des Benutzers
Token String Authentifizierungstoken
 
Rückgabewert


getUsersWithRightOnPostbox

Liefert Benutzer mit Rechten auf eine Ablage

Parameter Datentyp Beschreibung
PostboxID Integer ID der Ablage
Token String Authentifizierungstoken
 
Rückgabewert


isAllowedUserForPostBox

Prüft ob ein Benutzer Zugriff auf eine Ablage hat

Parameter Datentyp Beschreibung
UserID anyType ID des Benutzers
BoxID anyType ID der Ablage
Token String Authentifizierungstoken
 
Rückgabewert


Hauptkapitel

Verwandte Themen

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