infra-struktur AdminWiki 2.10 - Benutzerbeiträge [de]

MediaWiki:Sidebar

2026-10-19T09:52:07Z

Jan:

* navigation
** portal-url|portal
** randompage-url|randompage
* SEARCH
* TOOLBOX
* LANGUAGES

MediaWiki:Sidebar

2026-10-19T09:43:05Z

Jan:

* navigation
** portal-url|portal
** randompage-url|randompage
* SEARCH
* TOOLBOX
** Special:PandocExport|Seite exportieren
* LANGUAGES

Webservice task

2026-08-07T05:58:58Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>createTask</u>''

Erstellt eine Aufgabe in der infra-struktur.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title || string ||| Titel der Aufgabe
|-
| content || string ||| Inhalt der Aufgabe
|-
| fixedMaturityTimestamp || time() ||| Timestamp der des Datums der Aufgabe
|-
| forerunTime || integer ||| Vorlaufzeit in Tagen
|-
| alarmTimestamp || time() ||| Timestamp des Alarms
|-
| ownerUserId || integer ||| UserID der Erstellers
|-
| responsibleUserId || integer ||| UserID des Bearbeiters
|-
| responsibleUserState || integer ||| Status der Aufgabe (1=rot, 2=gelb, 3=grün)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Legt eine Aufgabe in der infra-struktur an
|}

''<u>linkTaskToIdo</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId || integer ||| ID der Aufgabe
|-
| instanceId || integer ||| ID der IDO-Instanz aus der verknüpft wird
|-
| idoId || integer ||| ID des Datensatzes der verknüpft wird
|-
| token || string ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Verknüpft eine Aufgabe
|}

== 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]]

Webservice dms

2026-05-18T13:10:43Z

Jan:

* '''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'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>insertNewDocument</u>''

Speichert ein neues Dokument in der Datenbank

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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 <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setArchiveStatus</u>''

Archiviert ein Dokument
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des zu archivierenden Dokuments
|-
| DocumentID|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setGlobalisation</u>''

globalisiert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| GlobalID|| Integer||| ID der Globalisierung
|}

''<u>addVersion</u>''

Fügt einem Dokument eine weitere 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>setStatusForAllAllowedUsers</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Status|| Integer||| Status des Dokuments (0,1,2)
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>getBoxes</u>''

Liefert ein array mit allen verfügbaren DMS Ablagen

''<u>setIDO</u>''

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| IdoID|| Integer||| ID des Datensatz
|-
| InstanceID|| Integer||| ID der Instanz
|-
| 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
|}

''<u>setCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>changeDocumentTitle</u>''

Ändert den Titel eines Dokuments

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| DocumentTitle|| String||| Neuer Titel
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>getBoxes</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Title
|}

''<u>getMaxAllowedFilesize</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MaxDocumentSize|| Integer||| Max. Dateigröße in Kilobyte
|}

''<u>getPostboxesForUserID</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Users
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Titel
|}

''<u>getDocumentTitle</u>''

Liefert den Titel eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentTitle|| String||| Titel des Dokuments
|}

''<u>getAuthorID</u>''

Liefert den Autor eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AuthorID|| Integer||| UserID des Autors
|}

''<u>getDocumentStatus</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| UserID||Integer||| ID des Benutzers
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Integer||| Status des Dokuments (1/2/3)
|}

''<u>getCategoriesForIDO</u>''

Liefert sämtliche einem Datensatz zugehörigen Kategorien

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IdoID||Integer||| ID des Datensatzes
|-
| InstanceID||Integer||| ID der Instanz
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Categories|| Array||| Verfügbare Kategorien
|}

''<u>getCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| InstanceID||Integer||| ID der Instanz
|-
| IdoID||Integer||| ID des Datensatzes
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || String | 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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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]]

Webservice dms

2026-05-18T12:11:07Z

Jan:

* '''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'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>insertNewDocument</u>''

Speichert ein neues Dokument in der Datenbank

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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 <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setArchiveStatus</u>''

Archiviert ein Dokument
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des zu archivierenden Dokuments
|-
| DocumentID|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setGlobalisation</u>''

globalisiert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| GlobalID|| Integer||| ID der Globalisierung
|}

''<u>addVersion</u>''

Fügt einem Dokument eine weitere 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>setStatusForAllAllowedUsers</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Status|| Integer||| Status des Dokuments (0,1,2)
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>getBoxes</u>''

Liefert ein array mit allen verfügbaren DMS Ablagen

''<u>setIDO</u>''

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| IdoID|| Integer||| ID des Datensatz
|-
| InstanceID|| Integer||| ID der Instanz
|-
| 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
|}

''<u>setCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>changeDocumentTitle</u>''

Ändert den Titel eines Dokuments

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| DocumentTitle|| String||| Neuer Titel
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>getBoxes</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Title
|}

''<u>getMaxAllowedFilesize</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MaxDocumentSize|| Integer||| Max. Dateigröße in Kilobyte
|}

''<u>getPostboxesForUserID</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Users
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Titel
|}

''<u>getDocumentTitle</u>''

Liefert den Titel eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentTitle|| String||| Titel des Dokuments
|}

''<u>getAuthorID</u>''

Liefert den Autor eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AuthorID|| Integer||| UserID des Autors
|}

''<u>getDocumentStatus</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| UserID||Integer||| ID des Benutzers
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Integer||| Status des Dokuments (1/2/3)
|}

''<u>getCategoriesForIDO</u>''

Liefert sämtliche einem Datensatz zugehörigen Kategorien

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IdoID||Integer||| ID des Datensatzes
|-
| InstanceID||Integer||| ID der Instanz
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Categories|| Array||| Verfügbare Kategorien
|}

''<u>getCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| InstanceID||Integer||| ID der Instanz
|-
| IdoID||Integer||| ID des Datensatzes
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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 Details zu einem Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID ||anyType ||| ID des Dokuments
|-
| Information ||anyType ||| Angeforderter Detailtyp
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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]]

Webservice dmstagging

2026-05-13T12:04:34Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getFirstDocumentIDForPostbox</u>''

Liefert die niedrigste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getFollowingDocumentID</u>''

Liefert die naechsthoehere ID in einem Postfach. Ausgangspunkt ist die ueberlieferte Dokument ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Ausgangsdokuments
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastDocumentIDForPostbox</u>''

Liefert die hoechste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastStatusUpdate</u>''

liefert den Timestamp des letzten Änderungsdatums.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Timestamp|| Integer||| Timestamp der letzten Änderung oder 0
|}

''<u>getTagsForDocument</u>''

Liefert die bestehenden Tags eines Dokuments. Sollte das Dokument passwortgeschuetzt sein, wird eine SoapFault Exception vom Typ AUTHORISATION_ERROR mit der Meldung PASSWORD_PROTECTED gesendet

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Tags|| String||| Tags des Dokuments
|}

''<u>updateTagsForDocument</u>''

Updatet die Tags fuer ein bestimmtes Dokument. Die Tags hinter dem Trenner werden ersetzt. Die Tags for dem Trenner bleiben so erhalten

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Tags|| String ||| zu setztende Tags
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true or false
|}

== 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]]

Webservice Dokumentation

2026-05-13T12:00:28Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraltet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[Webservice_activities]]==
==[[Webservice_calendar]]==
==[[Webservice_contacts]]==
==[[Webservice_dms]]==
==[[Webservice_dmstagging]]==
==[[Webservice_ido]]==
==[[Webservice_idolinkings]]==
==[[Webservice_msg]]==
==[[Webservice_user]]==
==[[Webservice_email]]==
==[[Webservice_task]]==

Webservice Dokumentation

2026-05-13T11:59:54Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraltet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[Webservice_activities]]==
==[[Webservice_calendar]]==
==[[Webservice_contacts]]==
==[[Webservice_dms]]==
==[[Webservice_dmstagging]]==
==[[Webservice_ido]]==
==[[Webservice_idolinkings]]==
==[[Webservice_message]]==
==[[Webservice_user]]==
==[[Webservice_email]]==
==[[Webservice_task]]==

Webservice Dokumentation

2026-05-13T11:58:52Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraltet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[webservice_activities]]==
==[[webservice_calendar]]==
==[[webservice_contacts]]==
==[[webservice_dms]]==
==[[webservice_dmstagging]]==
==[[webservice_ido]]==
==[[webservice idolinkings]]==
==[[webservice_msg]]==
==[[webservice_user]]==
==[[webservice_email]]==
==[[webservice_task]]==

Webservice task

2026-05-13T11:57:40Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>createTask</u>''

Erstellt eine Aufgabe in der infra-struktur.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title || string ||| Titel der Aufgabe
|-
| content || string ||| Inhalt der Aufgabe
|-
| forerunTime || integer ||| Vorlaufzeit in Tagen
|-
| fixedMaturityTimestamp || time() ||| Timestamp der des Datums der Aufgabe
|-
| alarmTimestamp || time() ||| Timestamp des Alarms
|-
| ownerUserId || integer ||| UserID der Erstellers
|-
| responsibleUserId || integer ||| UserID des Bearbeiters
|-
| responsibleUserState || integer ||| Status der Aufgabe (1=rot, 2=gelb, 3=grün)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Legt eine Aufgabe in der infra-struktur an
|}

''<u>linkTaskToIdo</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId || integer ||| ID der Aufgabe
|-
| instanceId || integer ||| ID der IDO-Instanz aus der verknüpft wird
|-
| idoId || integer ||| ID des Datensatzes der verknüpft wird
|-
| token || string ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Verknüpft eine Aufgabe
|}

== 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]]

Webservice email

2026-05-13T11:57:34Z

Jan:

* '''WSDL Datei'''

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

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

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse schmelzer@netzkultur.de zu schicken

<?php

$instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
$username = "webservice";
$password = "123456789";
$userID = 4;

$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));

$attachments = array();
$toArray = array(
'1' => 'schmelzer@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$attachments[] = array('AttachmentFilename' => $fileName,
'AttachmentFilesize' => filesize($filePath),
'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))

$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);

$Client->__soapCall('sendMail', array ($mailTemplate, $token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>archiveMail</u>''

Wechselt den Archivierungsstatus einer Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}

''<u>createDraft</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array aus Mailvorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}

''<u>getEmptyMailTemplateJson</u>''

Holt eine leere Mailvorlage (das mailData Array)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}

''<u>getMailGroupsForUser</u>''

Gibt die Mailgruppen des angegebenen Users aus.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}

''<u>getNewDirectEmailCount</u>''

Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}

''<u>getNewGlobalizedEmailCount</u>''

Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}

''<u>getPostboxesForUser</u>''

Zeigt die Postfächer eines gewählten Users an.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}

''<u>getStandardTemplateForMailAccountAndUser</u>''

Gibt die ID der Standardvorlage eines Users für ein Postfach.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| templateID || integer ||| ID der Standardvorlage
|}

''<u>getWebmailTemplate</u>''

Holt die Ausgewählte Vorlage in ein Array.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}

''<u>openComposeWindow</u>''

Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}

''<u>sendBulkMail</u>''

Versendet eine Massenmail

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Massenmail
|}

''<u>sendMail</u>''

Versendet eine Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Mail.
|}

''<u>createDraftFromJSON</u>''

Erstellt einen Entwurf aus einem JSON-String

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailData ||String ||| Maildaten als JSON-String
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setIDO</u>''

Verknüpft eine Mail mit einem Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailId ||Integer ||| ID der Mail
|-
| IdoID ||Integer ||| ID des Datensatzes
|-
| InstanceID ||Integer ||| ID der IDO Instanz
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <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]]

Webservice user

2026-05-13T11:57:27Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getUserIDByLoginname</u>''

Liefert die UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| LoginName||String ||| Loginname des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserIDByKuerzel</u>''

Liefert das Kürzel UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserKuerzel||String ||| Kuerzel des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserList</u>''

Liefert eine Liste aller im System registrierten Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserList|| Array||| Alle UserIDs im System
|}

''<u>getUsername</u>''

Liefert den Benutzernamen zur angegebenen UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID|| Integer||| UserID des Benutzers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserName|| String||| Angeforderter Benutzername
|}

''<u>getActiveUserlist</u>''

Liefert eine Liste der aktuell aktiven Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getRealUsernameByUserId</u>''

Liefert den vollständigen Benutzernamen anhand der UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUserAbbreviationById</u>''

Liefert das Kürzel eines Benutzers anhand der UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUserstatus</u>''

Liefert den aktuellen Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| ID des Benutzers
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfUserstatus</u>''

Liefert eine Liste aller verfügbaren Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfUsersWithStatus</u>''

Liefert eine Liste aller Benutzer mit einem bestimmten Status

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfAutomaticUserstatus</u>''

Liefert eine Liste aller automatischen Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatus</u>''

Setzt den Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| userstatusID ||Integer ||| ID des gewünschten Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatusAvailable</u>''

Setzt den Status eines Benutzers auf verfügbar

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setCustomUserstatus</u>''

Setzt einen benutzerdefinierten Status

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| customStatus ||String ||| Benutzerdefinierter Statustext
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setAutomaticUserstatus</u>''

Setzt einen automatischen Status für einen Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| automaticStateID ||Integer ||| ID des automatischen Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteAutomaticUserstatus</u>''

Löscht den automatischen Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatusBackgroundColorHex</u>''

Setzt die Hintergrundfarbe des Benutzerstatus als Hexadezimalwert

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| hex ||String ||| Hexadezimalwert der Farbe (z.B. #FF0000)
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteUserstatusBackgroundColorHex</u>''

Löscht die Hintergrundfarbe des Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>refreshTheUseronlineList</u>''

Aktualisiert die Liste der online Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <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]]

Webservice msg

2026-05-13T11:57:21Z

Jan:

* '''WSDL Datei'''

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

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

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?message",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Der User mit der ID1 schickt eine Message an den User mit der ID2
$MessageID = $client->__soapCall("createNewMessage",array(1,"Das ist ein Test",array(2),null,$token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getMessageReadStatus</u>''

Liefert den gelesen-Status der Message zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||String ||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Empfängers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Gelesen oder nicht
|}

''<u>setMessageReadStatus</u>''

Markiert eine Message als gelesen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Benutzers
|-
| ReadStatus|| Boolean||| Boolean
|-
| Token|| String ||| Authentifizierungstoken
|}

''<u>createNewMessage</u>''

Erstellt und versendet eine Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| SenderID||Integer||| UserID des Absenders
|-
| MessageText|| String||| Text der Message
|-
| ReceiverIDArray|| Array||| UserIDs der Empfänger
|-
| MessageSendTime|| Integer||| Timestamp des Sendezeitpunkts (default: aktuelle Zeit)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MessageID|| Integer||| ID der gesendeten Message
|}

''<u>setIDO (ab Version 2.9.7.37)</u>''

Eine vorhande Nachricht mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

''<u>createAnswerMessage</u>''

Erstellt eine Antwort auf eine bestehende Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| senderId ||Integer ||| UserID des Absenders
|-
| receiverId ||Integer ||| UserID des Empfängers
|-
| messageText ||String ||| Text der Antwort
|-
| answeredMessageId ||Integer ||| ID der beantworteten Message
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getMessage</u>''

Liefert eine Message anhand ihrer ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getMessageHistory</u>''

Liefert den Nachrichtenverlauf einer Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUnreadMessages</u>''

Liefert ungelesene Messages eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| UserID des Benutzers
|-
| Count ||Integer ||| Maximale Anzahl zurückzugebender Messages
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getReadMessages</u>''

Liefert gelesene Messages eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| UserID des Benutzers
|-
| Count ||Integer ||| Maximale Anzahl zurückzugebender Messages
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>readMessage</u>''

Markiert eine Message als gelesen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID ||Integer ||| ID der Message
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getGreenMessageIdsForUser</u>''

Liefert die IDs der grünen Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getYellowMessageIdsForUser</u>''

Liefert die IDs der gelben Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getRedMessageIdsForUser</u>''

Liefert die IDs der roten Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoLinkingsForMessage</u>''

Liefert die verknüpften IDO-Datensätze einer Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setMessageSenderState</u>''

Setzt den Status einer Message für den Absender

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| state ||Integer ||| Neuer Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setMessageReceiverState</u>''

Setzt den Status einer Message für einen Empfänger

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| receiverId ||Integer ||| UserID des Empfängers
|-
| state ||Integer ||| Neuer Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <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]]

Webservice idolinkings

2026-05-13T11:57:15Z

Jan:

* '''WSDL Datei'''

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

http://demo.infra-struktur.de/webservice/wsdl/wsdl.php?idolinkings

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?idolinkings",array('exceptions'=>false));
$Token = $client->__soapCall("authenticate",array("http://instanz.infra-struktur.de","USERNAME","PASSWORD"));
var_dump($client->__soapCall("getLinkedIDOList",array(INSTANZ_ID, IDO_ID, TOKEN, array(INSTANZ_ID, INSTANZ_ID))));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getLinkedIDOList</u>''

Der Webservice liefert ein Array mit Instanz IDs und IDOs der Beziehungen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID ||Integer ||| ID der IDO-Instanz
|-
| IDOID || Integer ||| ID des Datensatzes des Verknüfungen interessant sind
|-
| Token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|-
| LimitToInstances || Array ||| optionales Array um die Rückgabe auf einzelne Instanzen zu beschränken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| result || Array ||| Liefert alle verknüpften Datensätze zurück ($Result[INSTANZ_ID][] = DATENSATZ_ID
|}

''<u>addIDOButton</u>''

Fügt eine IDO-Verknüpfungsschaltfläche hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| EntryID ||anyType ||| ID des Eintrags
|-
| ModuleID ||anyType ||| ID des Moduls
|-
| InstanceID ||anyType ||| ID der IDO Instanz
|-
| IdoID ||anyType ||| ID des Datensatzes
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <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]]

Webservice ido

2026-05-13T11:57:10Z

Jan:

* '''WSDL Datei'''

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

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

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

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getInstances</u>''

Liefert sämtliche verfügbare IDO Instanzen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoInstances || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
|}

''<u>getTextfieldsByInstanceID</u>''

Liefert sämtliche Textfelder zur 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoTextFields || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
|}

''<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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoSelectFields || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
|}

''<u>getRadiofieldsByInstanceID</u>''

Liefert sämtliche Radiofelder 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoRadiofields || Array ||| Array mit den verfügbaren Radiofeldern (FeldID,Feldname)
|}

''<u>getCheckboxesByInstanceID</u>''

Liefert sämtliche Checkboxen 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoCheckboxes || Array ||| Array mit den verfügbaren Checkboxen (FeldID,Feldname)
|}

''<u>CountConfigurenCheckboxesByInstanceID</u>''

Gibt die Anzahl der verfügbaren Checkboxen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countCheckboxes || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredSelectfieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Selectfelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredRadiofieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Radiofelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>getPossibleCheckboxValues</u>''

Liefert die Auswahlmöglichkeiten einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID ||Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkboxValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleSelectfieldValues</u>''

Liefert die Auswahlmöglichkeiten eines Selectfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID der Selectbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| selectfieldsValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleRadiofieldValues</u>''

Liefert die Auswahlmöglichkeiten einer Radiobox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID des Radiofelds
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| radiofieldValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getIDOInstanceSpecialFieldConfiguration</u>''

Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| true/false || Boolean ||| Konfigurationsstatus
|}

''<u>GenerateFieldTypeArray</u>''

Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldTypeArray || Array ||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|}

''<u>getFieldType</u>''

Liefert den Typ eines bestimmten Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldName || String ||| Name des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| feldtyp || String ||| Typ des Feldes
|}

''<u>getFullIDOStructure</u>''

Liefert die vollständige Struktur einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoMappingFieldsByInstanceIdAndIdoId</u>''

Liefert die Mapping-Felder eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>openRemoteIDO</u>''

Öffnet einen IDO-Datensatz remote

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDataByInstanceIDOIdAndFieldID</u>''

Liefert den Wert des angegebenen Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldValue || String ||| Wert des Feldes
|}

''<u>getCheckedValuesForInstanceAndCheckBoxID</u>''

Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolean zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getPossibleValuesForInstanceAndCheckboxID</u>''

Liefert alle verfügbaren Einträge einer Checkbox zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getArchiveContent</u>''

Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| archiveContent || String ||| Inhalt des Archivfelds
|}

''<u>getMessageContent</u>''

Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| messageContent || String ||| Inhalt des Hinweisfelds
|}

''<u>getNextContact</u>''

Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContact || String ||| Datum des nächsten Kontakts
|}

''<u>getNextContactTime</u>''

Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContactTime || String ||| Uhrzeit des nächsten Kontakts
|}

''<u>getLastContact</u>''

Liefert das Datum des letzten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || String |||
|}

''<u>IsTerminOnNextContact</u>''

Liefert zurück ob der nächste Kontakt ein Termin ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| isTermin || Boolean ||| Termin oder nicht
|}

''<u>getContactPerson</u>''

Liefert die ausgewählte Kontaktperson des Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| contactPerson || Integer ||| UserID der Kontaktperson
|}

''<u>getAllEntries</u>''

Liefert alle Einträge einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullIdoInstance</u>''

Liefert alle Datensätze einer IDO-Instanz (mit Paginierung und Zeitfilter)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| offset || anyType ||| Startposition (für Paginierung)
|-
| limit || anyType ||| Maximale Anzahl zurückgegebener Datensätze
|-
| lastModificationTimestamp || anyType ||| Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoContextValue</u>''

Liefert den Kontextwert eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoListByGivenIDs</u>''

Liefert eine Liste von Datensätzen anhand einer Liste von IDs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoIdList || anyType ||| Array mit den abzufragenden Datensatz-IDs
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setValueForDataset</u>''

Setzt den Wert eines bestimmten Feldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTextFieldValue</u>''

Setzt den Wert eines Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldValue || String ||| Wert der Option
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setArchiveContent</u>''

Setzt den Wert des Archivfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setMessageContent</u>''

Setzt den Wert des Hinweisfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactPerson</u>''

Setzt die Kontaktperson eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| employeeID || Integer ||| UserID der Kontaktperson
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactDate</u>''

Setzt den Wert des Feldes nächster/letzter Kontakt

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactTime</u>''

Setzt die Uhrzeit des nächsten Kontakts

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| time || String ||| Uhrzeit (HH:MM:SS)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTermin</u>''

Setzt den nächsten Kontakt als Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| switchStatus || Boolean ||| Termin oder nicht
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCombofield</u>''

Setzt den Wert eines Combofeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| valueID || Integer ||| ID des Values
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCheckboxValues</u>''

Setzt den Wert einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setValueOfMappedField</u>''

Setzt den Wert eines Feldes anhand seines Mapping-Keys

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId || Integer ||| ID des Datensatzes
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Wert des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>addCombovalue</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForComboField</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForDemoField</u>''

Fügt einen neuen Wert zu einem Demo-Feld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>refreshTheIdoUserInterface</u>''

Aktualisiert die IDO-Benutzeroberfläche

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>CreateNewDataset</u>''

Erstellt einen neuen, leeren Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| contactPersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| ID des neuen Datensatz
|}

''<u>createNewDatasetWithID</u>''

Erstellt einen neuen Datensatz mit einer vordefinierten ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| definedIDOID || Integer ||| Vordefinierte ID des neuen Datensatzes
|-
| contactpersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteIDO</u>''

Löscht einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>restoreIDO</u>''

Stellt einen gelöschten Datensatz wieder her

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIDOCount</u>''

Gibt die Anzahl aller Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.17)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer ||| Anzahl Datensätze
|}

''<u>getDatasetIDList</u>''

Gibt ein Array mit den IDs aller aktiven Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.36)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array ||| DatensatzID-Array
|}

''<u>isIDOLock</u>''

Prüft ob ein Datensatz gesperrt ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Boolean |||
|}

''<u>setIDOLock</u>''

Sperrt einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| userID ||Integer ||| UserID des sperrenden Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>releaseIDOLock</u>''

Gibt die Sperre eines Datensatzes frei

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanz und dem Match auf den Wert des angegebenen Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| Datensatz ID
|}

''<u>getIDOIDByInstanceIdMappingKeyAndFieldValue</u>''

Liefert die ID eines Datensatzes anhand eines Mapping-Keys und eines Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer |||
|}

''<u>GetIDOsByCantactperson</u>''

Liefert alle Datensätze einer Instanz, die einer bestimmten Kontaktperson zugeordnet sind

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| contactpersonID ||Integer ||| ID der Kontaktperson
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines exakten Textfeldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (exakter Treffer)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines Textfeldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (Teilstring-Suche)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines exakten numerischen Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Wert)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines numerischen Feldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Teilstring)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (exakte Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCheckboxIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Checkbox-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID der Checkbox
|-
| valueId || String ||| ID des Checkbox-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCombofieldIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Combofeld-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Combofeldes
|-
| valueId || String ||| ID des Combofeld-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createTask</u>''

Erstellt eine neue Aufgabe

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Aufgabe
|-
| content ||String ||| Inhalt / Beschreibung der Aufgabe
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| forerunTime ||Integer ||| Vorwarnzeit in Sekunden
|-
| alarmTimestamp ||Integer ||| Alarmzeitpunkt als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| responsibleUserId ||Integer ||| UserID des Verantwortlichen
|-
| responsibleUserState ||Integer ||| Status des Verantwortlichen
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkTaskToIdo</u>''

Verknüpft eine Aufgabe mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId ||Integer ||| ID der Aufgabe
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createNote</u>''

Erstellt eine neue Notiz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Notiz
|-
| content ||String ||| Inhalt der Notiz
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| ownerUserState ||Integer ||| Status des Erstellers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkNoteToIdo</u>''

Verknüpft eine Notiz mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| noteId ||Integer ||| ID der Notiz
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <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]]

Webservice dmstagging

2026-05-13T11:57:03Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getFirstDocumentIDForPostbox</u>''

Liefert die niedrigste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getFollowingDocumentID</u>''

Liefert die naechsthoehere ID in einem Postfach. Ausgangspunkt ist die ueberlieferte Dokument ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastDocumentIDForPostbox</u>''

Liefert die hoechste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastStatusUpdate</u>''

liefert den Timestamp des letzten Änderungsdatums.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Timestamp|| Integer||| Timestamp der letzten Änderung oder 0
|}

''<u>getTagsForDocument</u>''

Liefert die bestehenden Tags eines Dokuments. Sollte das Dokument passwortgeschuetzt sein, wird eine SoapFault Exception vom Typ AUTHORISATION_ERROR mit der Meldung PASSWORD_PROTECTED gesendet

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Tags|| String||| Tags des Dokuments
|}

''<u>updateTagsForDocument</u>''

Updatet die Tags fuer ein bestimmtes Dokument. Die Tags hinter dem Trenner werden ersetzt. Die Tags for dem Trenner bleiben so erhalten

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Tags|| String ||| zu setztende Tags
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true or false
|}

== 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]]

Webservice dms

2026-05-13T11:56:57Z

Jan:

* '''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'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>insertNewDocument</u>''

Speichert ein neues Dokument in der Datenbank

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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 <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setArchiveStatus</u>''

Archiviert ein Dokument
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des zu archivierenden Dokuments
|-
| DocumentID|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setGlobalisation</u>''

globalisiert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| GlobalID|| Integer||| ID der Globalisierung
|}

''<u>addVersion</u>''

Fügt einem Dokument eine weitere 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>setStatusForAllAllowedUsers</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Status|| Integer||| Status des Dokuments (0,1,2)
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>getBoxes</u>''

Liefert ein array mit allen verfügbaren DMS Ablagen

''<u>setIDO</u>''

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| IdoID|| Integer||| ID des Datensatz
|-
| InstanceID|| Integer||| ID der Instanz
|-
| 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
|}

''<u>setCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>changeDocumentTitle</u>''

Ändert den Titel eines Dokuments

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| DocumentTitle|| String||| Neuer Titel
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>getBoxes</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Title
|}

''<u>getMaxAllowedFilesize</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MaxDocumentSize|| Integer||| Max. Dateigröße in Kilobyte
|}

''<u>getPostboxesForUserID</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Users
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Titel
|}

''<u>getDocumentTitle</u>''

Liefert den Titel eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentTitle|| String||| Titel des Dokuments
|}

''<u>getAuthorID</u>''

Liefert den Autor eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AuthorID|| Integer||| UserID des Autors
|}

''<u>getDocumentStatus</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| UserID||Integer||| ID des Benutzers
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Integer||| Status des Dokuments (1/2/3)
|}

''<u>getCategoriesForIDO</u>''

Liefert sämtliche einem Datensatz zugehörigen Kategorien

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IdoID||Integer||| ID des Datensatzes
|-
| InstanceID||Integer||| ID der Instanz
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Categories|| Array||| Verfügbare Kategorien
|}

''<u>getCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| InstanceID||Integer||| ID der Instanz
|-
| IdoID||Integer||| ID des Datensatzes
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDocument</u>''

Liefert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID ||Integer ||| ID des Dokuments
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDocumentDetails</u>''

Liefert Details zu einem Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID ||anyType ||| ID des Dokuments
|-
| Information ||anyType ||| Angeforderter Detailtyp
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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]]

Webservice contacts

2026-05-13T11:56:48Z

Jan:

* '''WSDL Datei'''

Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getContacts</u>''

Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IDOID|| Integer||| Datensatz ID
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Contacts|| Array||| Array Aufbau: Array->ContactID->FieldID->FieldValue
|}

''<u>getContactFields</u>''

Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Configuration|| Array||| Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration
|}

''<u>getContactCount</u>''

Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der Ansprechpartner
|}

''<u>searchContactByValue</u>''

Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| SearchString|| String||| Suchbegriff
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch
|}

''<u>getNextContactID</u>''

Liefert die nächste freie AnsprechpartnerID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des nächsten Ansprechartners
|}

''<u>setContactValue</u>''

Setzt den Wert eines speziellen Ansprechpartnerfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| ContactID|| Integer||| Ansprechpartner ID
|-
| FieldID|| Integer||| Feld ID
|-
| Value|| String||| Neuer Inhalt des Feldes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true/false
|}

''<u>addContact</u>''

Erzeugt einen neuen leeren Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des neuen Ansprechpartners
|}

''<u>getConfiguredContactsTextFields</u>''

Liefert die konfigurierten Textfelder des Ansprechpartner-Reiters

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullContactsByIdoId</u>''

Liefert alle Ansprechpartner eines Datensatzes (vollständig)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceId ||Integer ||| ID der IDO Instanz
|-
| IdoID ||Integer ||| ID des Datensatzes
|-
| Token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getContactDataByInstanceIDOIDAndFieldID</u>''

Liefert den Wert eines bestimmten Feldes eines Ansprechpartners

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| fieldID ||Integer ||| ID des Feldes
|-
| ContactID ||Integer ||| ID des Ansprechpartners
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>set_contacts</u>''

Setzt Ansprechpartner-Daten

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
|   || |||
|-
| <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]]

Webservice calendar

2026-05-13T11:56:41Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>GetAppointmentsForUserStartByRevisionID</u>''

Liefert sämtliche Termine eines definierten Benutzers beginnend mit der angegebenen Revisionsnummer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| RevisionID|| Integer||| Start-Revisionsnummer
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentsForUserByDate</u>''

Liefert sämtliche Termine eines definieten Benutzers an einem
bestimmten Tag zurück.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| Date|| String||| Datum im Format jjjj-mm-dd
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''DeleteAppointment'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentByID</u>''

Liefert einen Termin anhand seiner ID zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Appointment|| Array||| Termin
|}

''<u>GetAppointmentMemberUserIDs</u>''

Liefert eine Liste der UserIDs der am Termin beteiligten Personen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserIDs|| Array||| Liste der teilnehmenden Benutzer
|}

''<u>GetAppointmentMemberCount</u>''

Liefert die Anzahl der an einem Termin teilnehmenden Personen zurück
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der teilnehmenden Benut
|}

''<u>GetDeletedAppointmentsByStartRevision</u>''

Liefert eine Liste an TerminIDs gelöschter Termine ab einer bestimmten Revision zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Benutzers
|-
| RevisionID|| Integer||| Revisionsnummer
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AppointmentIDs|| Array||| Liste gelöschter Termine
|}

''<u>getIDOForAppointment</u>''

Liefert die IDO IDs zu einem Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array mit der Instanz_ID in der ersten Dimension und das Value der zweiten Dimension sind die IDO IDs
|}

''<u>SaveAppointment</u>''

Speichert einen neuen Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentTitle||String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>UpdateAppointment</u>''

Einen vorhandenen Termin bearbeiten
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| AppointmentTitle|| String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>AddAppointmentMember</u>''

Einem vorhanden Termin einen weiteren Teilnehmer zubuchen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| UserID|| Integer||| BenutzerID
|-
| Alarm|| Boolean||| Soll Benutzer alarmiert werden
|-
| Active|| Boolean||| aktiv oder informativ
|-
| WritePermission|| Boolean||| Schreibrecht
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>DeleteAppointment</u>''

Einem vorhanden Termin entfernen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich gelöscht?
|}

''<u>setIDO</u>''

Einem vorhanden Termin mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

''<u>SaveAppointmentWithReturnID</u>''

Speichert einen neuen Termin und gibt dessen ID zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentTitle ||String ||| Titel des Termins
|-
| AppointmentDescription ||String ||| Text des Termins
|-
| AppointmentType ||Integer ||| TermintypID
|-
| AppointmentTimestamp ||Integer ||| Timestamp des Termins
|-
| AppointmentDuration ||Integer ||| Dauer des Termins in Minuten
|-
| AppointmentAccess ||String ||| Private or public
|-
| AppointmentGenerator ||Integer ||| UserID des Erstellers
|-
| AppointmentConfirm ||Boolean ||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence ||Boolean ||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm ||anyType ||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday ||anyType ||| Ganztägiger Termin
|-
| AppointmentMember ||anyType ||| Terminteilnehmer Array
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getAppointmentTypeList</u>''

Liefert eine Liste der verfügbaren Termintypen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||anyType ||| ID des Benutzers
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getAppointmentIDsByInstanceIDAndIDOID</u>''

Liefert alle Termin-IDs die mit einem Datensatz verknüpft sind

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>removeIDO</u>''

Entfernt die Verknüpfung eines Termins mit einem Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| InstanceID ||Integer ||| ID der IDO Instanz
|-
| IDOID ||Integer ||| ID des Datensatzes
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>SetRevision</u>''

Setzt die Revision eines Termins auf den aktuellen Stand

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>SetRevisionForAppointment</u>''

Setzt eine bestimmte Revision für einen Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| Revision ||Integer ||| Revisionsnummer
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <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]]

Webservice activities

2026-05-13T11:56:36Z

Jan:

* '''WSDL Datei'''

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

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

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?activities",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Es wird im Datensatz eine Planaktivität angelegt
$PA = $client->__soapCall('addActivity',array(1,2,0123456789,8,"Titel","Beschreibung",1,1,22,10,2,$token));
?>

* '''Example für Demo Instanz'''

<?php
$benutzer="admin";
$passwort="infra-struktur";

//Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
$client_activities = new SoapClient("https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities",array('exceptions'=>false));

//Authetifizieren am webservice
$token = $client_activities->__soapCall("authenticate",array("https://demo.infra-struktur.eu",$benutzer,$passwort));

// Planaktivität anlegen in der Demoversion, Benutzer "holling"
//$client_activities->__soapCall('addActivity',array($instanzid,$DatensatzID,$timestamp,$kommartid,$titel,$beschreibung,$bearbeiterid,$verfasserid,$dauersekunden,$alarmsekunden,$status1bis3,$token));
$client_activities->__soapCall('addActivity',array(9,1,1389718401,1,"Testeintrag über Webservice","hier steht es",2,2,120,0,1,$token));
?>

* '''Funktionsübersicht'''

''<u>AddActivity</u>''

Fügt einem Datensatz eine neue Aktivität hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| ActivityStartTime|| Integer||| Timestamp der Startzeit
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|-
| ActivityTitle|| String ||| Titel der Aktivität
|-
| ActivityContent|| String ||| Text der Aktivität
|-
| ContactPersonID|| Integer||| UserID der Kontaktperson
|-
| AuthorID|| Integer||| UserID des Verfassers
|-
| ActivityDuration|| Integer||| Dauer der Aktivität in Minuten
|-
| AlarmBeforeStarttime|| Integer||| Alarm in Minuten vor StartTime
|-
| ActivityStatus|| Integer||| Status der Aktivität, Statusmöglichkeiten:
* 1 – Rot
* 2 – Gelb
* 3 – Grün
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| EntryID|| Integer||| ID der Aktivität
|}

''<u>GetActivityTypeIDByName</u>''

Liefert die TypenID der jeweiligen Aktivität zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| ActivityTypeName|| String||| Name des Aktivitätentyps
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|}

''<u>AddActivityToIDO</u>''

Fügt eine zuvor gesetzte Aktivität an einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| ActivityID||Integer||| ID der Aktivität
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolian||| Status der Aktion
|}

''<u>getActivityTypes</u>''

Gibt eine Liste aller verfügbaren Aktivitätentypen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array||| Aktivitätentypen
|}

''<u>setActivityState</u>''

Setzt den Status einer Aktivität

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| activityID ||Integer ||| ID der Aktivität
|-
| activityStatus ||Integer ||| Neuer Status der Aktivität, Statusmöglichkeiten:
* 1 – Rot
* 2 – Gelb
* 3 – Grün
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <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]]

Webservice Dokumentation

2026-05-13T11:54:43Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraltet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[Webservice_activities]]==
==[[webservice_calendar]]==
==[[webservice_contacts]]==
==[[webservice_dms]]==
==[[webservice_dmstagging]]==
==[[webservice_ido]]==
==[[Webservice idolinkings]]==
==[[webservice_msg]]==
==[[webservice_user]]==
==[[webservice_email]]==
==[[webservice_task]]==

Webservice dmstagging

2026-05-13T11:52:29Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getFirstDocumentIDForPostbox</u>''

Liefert die niedrigste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getFollowingDocumentID</u>''

Liefert die naechsthoehere ID in einem Postfach. Ausgangspunkt ist die ueberlieferte Dokument ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastDocumentIDForPostbox</u>''

Liefert die hoechste ID innerhalb des genannten Postfachs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| PostboxID||Integer ||| ID der DMS Ablage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentID|| Integer||| ID des Dokuments
|}

''<u>getLastStatusUpdate</u>''

liefert den Timestamp des letzten Änderungsdatums.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Timestamp|| Integer||| Timestamp der letzten Änderung oder 0
|}

''<u>getTagsForDocument</u>''

Liefert die bestehenden Tags eines Dokuments. Sollte das Dokument passwortgeschuetzt sein, wird eine SoapFault Exception vom Typ AUTHORISATION_ERROR mit der Meldung PASSWORD_PROTECTED gesendet

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Tags|| String||| Tags des Dokuments
|}

''<u>updateTagsForDocument</u>''

Updatet die Tags fuer ein bestimmtes Dokument. Die Tags hinter dem Trenner werden ersetzt. Die Tags for dem Trenner bleiben so erhalten

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer ||| ID des Dokuments
|-
| Tags|| String ||| zu setztende Tags
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true or false
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]

infra-struktur AdminWiki 2.10:Gemeinschaftsportal

2026-05-13T11:52:04Z

Jan:

[[Datei:ifslogo500.png|Logo]]

Dieses Wiki ist die moderne Version des Administrator Handbuchs. Hier finden Sie zu allen Themen Hilfestellung zur Konfiguration der infra-struktur.

----

[https://adminwiki210.infra-struktur.de/index.php?title=infra-struktur_AdminWiki_2.10:Gemeinschaftsportal Eine Ebene öffnen/schließen]

----

{{#tree:id=siteTree|openlevels=2|root=Anwenderwiki|image=folderOpen|

*[[Einleitung]]
*[[Administration öffnen]]

*[[Allgemeinverwaltung (NEU)]]
**[[Login]]

*[[Anrufverwaltung]]
**[[Anruflisten]]
**[[Anruflisten - MSN]]

**[[Anruflisten - Anzeige]]
**[[Anruflisten - DS]]

**[[Print-DS-Config]]

**[[Nummernformatierung]]
**[[Anruflisten - Allgemein]]

**[[Benutzer - Anruflisten]]
**[[Benutzer - Extra]]
**[[Aufgabenverwaltung]]

*[[Benutzerverwaltung]]

*[[Benutzerstatus]]

*[[DMS-Verwaltung | Dokumente]]
**[[Einstellungen]]
**[[Ablage anlegen]]
**[[Ablage bearbeiten]]
**[[Benutzer zu Ablage]]
**[[Benutzerrechte]]
**[[Recht veröffentlichte Dokumente zu sehen]]
**[[Recht veröffentlichte Dokumente zu sehen neu berechnen]]
**[[IDO/DS Instanzen]]

*[[Gatewayverwaltung]]
**[[Gateway erstellen]]
**[[Gateway bearbeiten]]
**[[Benutzerkonten]]
**[[IDO-Konfiguration]]
**[[IDO entsperren]]
*[[IDO Linkverwaltung]]
*[[IDO Verwaltung]]
**[[Neue Instanz]]
**[[Instanz wählen]]
**[[Instanz umbenennen]]
**[[Datenimport]]
**[[Datensätze löschen]]
**[[Zusatzfeld Verwaltung]]
**[[Feld Verwaltung]]
***[[Felder hinzufügen/löschen/umbenennen]]
***[[Felder in der Tabellenansicht konfigurieren]]
***[[Felder in der Datensatzansicht konfigurieren]]
**[[Farb Verwaltung]]
**[[Reiterverwaltung]]
**[[RTF Druckverwaltung]]

*[[jAnrufmonitor]]

*[[Kalenderadmin]]
**[[Kalenderadmin]]
**[[ICal_Export]]
**[[ICal-Abonnement_mit_Android_Device|iCal Export mit Android]]

*[[Logoverwaltung]]

*[[Menüverwaltung]]

*[[Mitarbeiterverwaltung]]

*[[Merkzettel entsperren]]

*[[Rechteverwaltung]]
**[[Rechte]]
**[[Benutzer]]

**[[Rechte(Matrix)]]
***[[Userrechte]]
***[[Menü_rv|Menü]]
***[[Gateways_rv|Gateways]]
***[[Rechteverwaltung_IDO-Beziehungen|IDO-Beziehungen]]
***[[IDO-WV]]
***[[Kalender SU]]
***[[IDO_rv|IDO]]
***[[Rollenrechte]]
***[[User/Rolle]]
***[[Admin_rv|Admin]]

*[[Virtuelle Gruppen]]
**[[Virtuelle Gruppen]]
*[[Webmailverwaltung|E-Mails]]
**[[Allgemeine Einstellungen]]
**[[Postfach anlegen - POP3]]
**[[Postfach anlegen - IMAP]]
**[[Postfach bearbeiten]]
**[[SMTP anlegen]]
**[[SMTP bearbeiten]]
**[[Postfach zu SMTP]]
**[[User zu Postfach]]
**[[Postfach zu globalem Postfach]]
**[[Mails veröffentlichen]]
**[[Veröffentlichen neu berechnen]]
**[[Verfassenfenster-Suchfelder]]
**[[Fax to Mail]]
**[[IDO-DS Instanzen]]

*[[Übersetzung]]
**[[Übersetzung]]

*[[Wählhilfe]]

*[[Welcomeverwaltung]]

*[[Allgemeine Ablauftipps]]

*[[Besondere Funktionen]]
**[[delegieren]]
**[[veröffentlichen]]
**[[Veröffentlichen-Button]]
**[[Puzzle-Button]]
**[[IDO]]
**[["fragezeichen"-Suche]]
**[[Mailparser]]
**[[Veröffentlichen neu berechnen]]
**[[Wildcards für eMails]]

*[[Bekannte Probleme]]
**[[ipad Nutzung 2.10]]
**[[Courier-IMAP]]
**[[Mailausgang über Proxy]]
**[[Messages in Prism]]
**[[Passwörter mit Umlaut]]
**[[winmail.dat]]
**[[Exchange imap Abruf]]

*[[Best Practice]]
**[[Neue IDO-Instanz anlegen]]
**[[Neuen Benutzer anlegen]]
**[[Standardkonfiguration_DMS|Standardkonfiguration DMS]]
**[[TAPI mit Agfeo]]
**[[Wildcards_für_eMails|Wildcards für E-Mails]]

*[[FAQ]]
**[[Neuen Benutzer anlegen|Best Practice - Neuen Benutzer anlegen]]
**[[Benutzer löschen]]
**[[Empfangsbestätigung für Mail]]
**[[Mails fehlen]]
**[[Suchfeld im Menü]]
**[[Supportgrundsätze]]
**[[Dokumente schreibgeschützt]]
**[[ICal-Export überträgt keine Termine]]
**[[ICal-Abonnement mit Android Device]]
**[[Wann_kommt_das_nächste_Update%3F|Wann kommt das nächste Update?]]

*[[Firefox Tipps]]

*[[Freischaltung]]

*[[Handbücher]]

*[[IKK Barebone]]

*[[Tapimaster]]
**[[Tapimaster Installation]]
**[[Tapimaster Einstellungen]]
**[[Tapimaster Pro Installation]]

*[[Import alter Mails]]

*[[Notification IDO]]

*[[Registration]]
**[[Useranzahl erhöhen]]

*[[Glossar]]

*[[Webservice Dokumentation]]
**[[webservice_activities]]
**[[webservice_calendar]]
**[[webservice_contacts]]
**[[webservice_dms]]
**[[webservice_dmstagging]]
**[[webservice_ido]]
**[[webservice_idolinkings]]
**[[webservice_msg]]
**[[webservice_user]]
**[[webservice_email]]
**[[webservice_task]]

*[[Windows Installation]]
**[[Bsp. Konfigurationsdateien]]

*[[XML-RPC Dokumentation]]
**[[Anruf XML-RPC Schnittstelle]]
**[[Fax XML-RPC Schnittstelle]]
**[[Audio XML-RPC Schnittstelle]]
**[[Anruf HTTP GET Schnittstelle]]
**[[Anruf HTTP GET Schnittstelle V2]]
**[[Anruf Webhook für Anrufernamen]]
**[[Sipgate Schnittstelle]]
**[[Placetel Schnittstelle]]
**[[Fax2mail]]
**[[Tasker]]
**[[Android Anrufe mit IFTTT]]

*[[Zusatzmodule]]
**[[Anwenderwiki]]
**[[Actindoreiter]]
**[[BOM]]
**[[Dublettenchecker]]
**[[Geokarte]]
**[[iCal Export]]
**[[infra-struktur für Android]]
**[[Komfortsuche]]
**[[Planaktivitätenübersicht]]
**[[Servicemodul]]
**[[Statistik]]
**[[Tag Cloud]]
**[[Tec4Home]]
**[[Workflow Manager]]
***[[WM Example]]
***[[WM Zusatzmodul]]
**[[Zeitenreiter]]
**[[Bewegungen]]
**[[Easybill]]
**[[Clicksend]]
}}

Webservice Dokumentation

2026-05-13T11:11:30Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraltet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[Webservice activities]]==
==[[webservice_calendar]]==
==[[webservice_contacts]]==
==[[webservice_dms]]==
==[[webservice_dmstagging]]==
==[[webservice_ido]]==
==[[Webservice idolinkings]]==
==[[webservice_msg]]==
==[[webservice_user]]==
==[[webservice_email]]==
==[[webservice_task]]==

Webservice Dokumentation

2026-05-13T10:59:32Z

Jan:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren.

Die genauen Funktionsbeschreibungen finden Sie im Wiki, ganz aktuelle Entwicklungen und damit eine vollständige Funktionsübersicht können Sie über die WSDL-Dateien direkt einsehen, Bsp.:
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
oder
https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
oder (veraletet)
https://demo-classic.infra-struktur.eu/webservice/wsdl/wsdl.php?ido
also einfach hinter dem Fragezeichen den Namen des Webservice angeben.

==[[Webservice activities]]==
==[[webservice_calendar]]==
==[[webservice_contacts]]==
==[[webservice_dms]]==
==[[webservice_dmstagging]]==
==[[webservice_ido]]==
==[[Webservice idolinkings]]==
==[[webservice_msg]]==
==[[webservice_user]]==
==[[webservice_email]]==
==[[webservice_task]]==

Webservice user

2026-05-13T10:47:40Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getUserIDByLoginname</u>''

Liefert die UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| LoginName||String ||| Loginname des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserIDByKuerzel</u>''

Liefert das Kürzel UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserKuerzel||String ||| Kuerzel des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserList</u>''

Liefert eine Liste aller im System registrierten Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserList|| Array||| Alle UserIDs im System
|}

''<u>getUsername</u>''

Liefert den Benutzernamen zur angegebenen UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID|| Integer||| UserID des Benutzers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserName|| String||| Angeforderter Benutzername
|}

''<u>getActiveUserlist</u>''

Liefert eine Liste der aktuell aktiven Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getRealUsernameByUserId</u>''

Liefert den vollständigen Benutzernamen anhand der UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUserAbbreviationById</u>''

Liefert das Kürzel eines Benutzers anhand der UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUserstatus</u>''

Liefert den aktuellen Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| ID des Benutzers
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfUserstatus</u>''

Liefert eine Liste aller verfügbaren Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfUsersWithStatus</u>''

Liefert eine Liste aller Benutzer mit einem bestimmten Status

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getListOfAutomaticUserstatus</u>''

Liefert eine Liste aller automatischen Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatus</u>''

Setzt den Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| userstatusID ||Integer ||| ID des gewünschten Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatusAvailable</u>''

Setzt den Status eines Benutzers auf verfügbar

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setCustomUserstatus</u>''

Setzt einen benutzerdefinierten Status

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| customStatus ||String ||| Benutzerdefinierter Statustext
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setAutomaticUserstatus</u>''

Setzt einen automatischen Status für einen Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| automaticStateID ||Integer ||| ID des automatischen Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteAutomaticUserstatus</u>''

Löscht den automatischen Status eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setUserstatusBackgroundColorHex</u>''

Setzt die Hintergrundfarbe des Benutzerstatus als Hexadezimalwert

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| hex ||String ||| Hexadezimalwert der Farbe (z.B. #FF0000)
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteUserstatusBackgroundColorHex</u>''

Löscht die Hintergrundfarbe des Benutzerstatus

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| ID des Benutzers
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>refreshTheUseronlineList</u>''

Aktualisiert die Liste der online Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice msg

2026-05-13T10:47:29Z

Jan:

* '''WSDL Datei'''

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

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

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?message",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Der User mit der ID1 schickt eine Message an den User mit der ID2
$MessageID = $client->__soapCall("createNewMessage",array(1,"Das ist ein Test",array(2),null,$token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getMessageReadStatus</u>''

Liefert den gelesen-Status der Message zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||String ||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Empfängers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Gelesen oder nicht
|}

''<u>setMessageReadStatus</u>''

Markiert eine Message als gelesen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Benutzers
|-
| ReadStatus|| Boolean||| Boolean
|-
| Token|| String ||| Authentifizierungstoken
|}

''<u>createNewMessage</u>''

Erstellt und versendet eine Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| SenderID||Integer||| UserID des Absenders
|-
| MessageText|| String||| Text der Message
|-
| ReceiverIDArray|| Array||| UserIDs der Empfänger
|-
| MessageSendTime|| Integer||| Timestamp des Sendezeitpunkts (default: aktuelle Zeit)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MessageID|| Integer||| ID der gesendeten Message
|}

''<u>setIDO (ab Version 2.9.7.37)</u>''

Eine vorhande Nachricht mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

''<u>createAnswerMessage</u>''

Erstellt eine Antwort auf eine bestehende Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| senderId ||Integer ||| UserID des Absenders
|-
| receiverId ||Integer ||| UserID des Empfängers
|-
| messageText ||String ||| Text der Antwort
|-
| answeredMessageId ||Integer ||| ID der beantworteten Message
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getMessage</u>''

Liefert eine Message anhand ihrer ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getMessageHistory</u>''

Liefert den Nachrichtenverlauf einer Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getUnreadMessages</u>''

Liefert ungelesene Messages eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| UserID des Benutzers
|-
| Count ||Integer ||| Maximale Anzahl zurückzugebender Messages
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getReadMessages</u>''

Liefert gelesene Messages eines Benutzers

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||Integer ||| UserID des Benutzers
|-
| Count ||Integer ||| Maximale Anzahl zurückzugebender Messages
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>readMessage</u>''

Markiert eine Message als gelesen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID ||Integer ||| ID der Message
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getGreenMessageIdsForUser</u>''

Liefert die IDs der grünen Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getYellowMessageIdsForUser</u>''

Liefert die IDs der gelben Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getRedMessageIdsForUser</u>''

Liefert die IDs der roten Messages eines Benutzers (paginiert)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| page ||Integer ||| Seitennummer (Paginierung)
|-
| size ||Integer ||| Anzahl Einträge pro Seite
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoLinkingsForMessage</u>''

Liefert die verknüpften IDO-Datensätze einer Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setMessageSenderState</u>''

Setzt den Status einer Message für den Absender

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| state ||Integer ||| Neuer Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setMessageReceiverState</u>''

Setzt den Status einer Message für einen Empfänger

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| messageId ||Integer ||| ID der Message
|-
| receiverId ||Integer ||| UserID des Empfängers
|-
| state ||Integer ||| Neuer Status
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice idolinkings

2026-05-13T10:15:17Z

Jan:

Webservice email

2026-05-13T10:14:59Z

Jan:

* '''WSDL Datei'''

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

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

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse schmelzer@netzkultur.de zu schicken

<?php

$instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
$username = "webservice";
$password = "123456789";
$userID = 4;

$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));

$attachments = array();
$toArray = array(
'1' => 'schmelzer@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$attachments[] = array('AttachmentFilename' => $fileName,
'AttachmentFilesize' => filesize($filePath),
'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))

$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);

$Client->__soapCall('sendMail', array ($mailTemplate, $token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>archiveMail</u>''

Wechselt den Archivierungsstatus einer Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}

''<u>createDraft</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array aus Mailvorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}

''<u>getEmptyMailTemplateJson</u>''

Holt eine leere Mailvorlage (das mailData Array)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}

''<u>getMailGroupsForUser</u>''

Gibt die Mailgruppen des angegebenen Users aus.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}

''<u>getNewDirectEmailCount</u>''

Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}

''<u>getNewGlobalizedEmailCount</u>''

Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}

''<u>getPostboxesForUser</u>''

Zeigt die Postfächer eines gewählten Users an.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}

''<u>getStandardTemplateForMailAccountAndUser</u>''

Gibt die ID der Standardvorlage eines Users für ein Postfach.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| templateID || integer ||| ID der Standardvorlage
|}

''<u>getWebmailTemplate</u>''

Holt die Ausgewählte Vorlage in ein Array.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}

''<u>openComposeWindow</u>''

Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}

''<u>sendBulkMail</u>''

Versendet eine Massenmail

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Massenmail
|}

''<u>sendMail</u>''

Versendet eine Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Mail.
|}

''<u>createDraftFromJSON</u>''

Erstellt einen Entwurf aus einem JSON-String

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailData ||String ||| Maildaten als JSON-String
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setIDO</u>''

Verknüpft eine Mail mit einem Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailId ||Integer ||| ID der Mail
|-
| IdoID ||Integer ||| ID des Datensatzes
|-
| InstanceID ||Integer ||| ID der IDO Instanz
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice dms

2026-05-13T10:14:50Z

Jan:

* '''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'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>insertNewDocument</u>''

Speichert ein neues Dokument in der Datenbank

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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 <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setArchiveStatus</u>''

Archiviert ein Dokument
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des zu archivierenden Dokuments
|-
| DocumentID|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setGlobalisation</u>''

globalisiert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| GlobalID|| Integer||| ID der Globalisierung
|}

''<u>addVersion</u>''

Fügt einem Dokument eine weitere 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>setStatusForAllAllowedUsers</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Status|| Integer||| Status des Dokuments (0,1,2)
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>getBoxes</u>''

Liefert ein array mit allen verfügbaren DMS Ablagen

''<u>setIDO</u>''

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| IdoID|| Integer||| ID des Datensatz
|-
| InstanceID|| Integer||| ID der Instanz
|-
| 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
|}

''<u>setCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>changeDocumentTitle</u>''

Ändert den Titel eines Dokuments

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| DocumentTitle|| String||| Neuer Titel
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>getBoxes</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Title
|}

''<u>getMaxAllowedFilesize</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MaxDocumentSize|| Integer||| Max. Dateigröße in Kilobyte
|}

''<u>getPostboxesForUserID</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Users
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Titel
|}

''<u>getDocumentTitle</u>''

Liefert den Titel eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentTitle|| String||| Titel des Dokuments
|}

''<u>getAuthorID</u>''

Liefert den Autor eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AuthorID|| Integer||| UserID des Autors
|}

''<u>getDocumentStatus</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| UserID||Integer||| ID des Benutzers
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Integer||| Status des Dokuments (1/2/3)
|}

''<u>getCategoriesForIDO</u>''

Liefert sämtliche einem Datensatz zugehörigen Kategorien

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IdoID||Integer||| ID des Datensatzes
|-
| InstanceID||Integer||| ID der Instanz
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Categories|| Array||| Verfügbare Kategorien
|}

''<u>getCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| InstanceID||Integer||| ID der Instanz
|-
| IdoID||Integer||| ID des Datensatzes
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDocument</u>''

Liefert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID ||Integer ||| ID des Dokuments
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDocumentDetails</u>''

Liefert Details zu einem Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID ||anyType ||| ID des Dokuments
|-
| Information ||anyType ||| Angeforderter Detailtyp
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice contacts

2026-05-13T10:14:40Z

Jan:

* '''WSDL Datei'''

Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getContacts</u>''

Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IDOID|| Integer||| Datensatz ID
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Contacts|| Array||| Array Aufbau: Array->ContactID->FieldID->FieldValue
|}

''<u>getContactFields</u>''

Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Configuration|| Array||| Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration
|}

''<u>getContactCount</u>''

Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der Ansprechpartner
|}

''<u>searchContactByValue</u>''

Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| SearchString|| String||| Suchbegriff
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch
|}

''<u>getNextContactID</u>''

Liefert die nächste freie AnsprechpartnerID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des nächsten Ansprechartners
|}

''<u>setContactValue</u>''

Setzt den Wert eines speziellen Ansprechpartnerfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| ContactID|| Integer||| Ansprechpartner ID
|-
| FieldID|| Integer||| Feld ID
|-
| Value|| String||| Neuer Inhalt des Feldes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true/false
|}

''<u>addContact</u>''

Erzeugt einen neuen leeren Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des neuen Ansprechpartners
|}

''<u>getConfiguredContactsTextFields</u>''

Liefert die konfigurierten Textfelder des Ansprechpartner-Reiters

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullContactsByIdoId</u>''

Liefert alle Ansprechpartner eines Datensatzes (vollständig)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceId ||Integer ||| ID der IDO Instanz
|-
| IdoID ||Integer ||| ID des Datensatzes
|-
| Token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getContactDataByInstanceIDOIDAndFieldID</u>''

Liefert den Wert eines bestimmten Feldes eines Ansprechpartners

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| fieldID ||Integer ||| ID des Feldes
|-
| ContactID ||Integer ||| ID des Ansprechpartners
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>set_contacts</u>''

Setzt Ansprechpartner-Daten

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice calendar

2026-05-13T10:14:23Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>GetAppointmentsForUserStartByRevisionID</u>''

Liefert sämtliche Termine eines definierten Benutzers beginnend mit der angegebenen Revisionsnummer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| RevisionID|| Integer||| Start-Revisionsnummer
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentsForUserByDate</u>''

Liefert sämtliche Termine eines definieten Benutzers an einem
bestimmten Tag zurück.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| Date|| String||| Datum im Format jjjj-mm-dd
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''DeleteAppointment'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentByID</u>''

Liefert einen Termin anhand seiner ID zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Appointment|| Array||| Termin
|}

''<u>GetAppointmentMemberUserIDs</u>''

Liefert eine Liste der UserIDs der am Termin beteiligten Personen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserIDs|| Array||| Liste der teilnehmenden Benutzer
|}

''<u>GetAppointmentMemberCount</u>''

Liefert die Anzahl der an einem Termin teilnehmenden Personen zurück
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der teilnehmenden Benut
|}

''<u>GetDeletedAppointmentsByStartRevision</u>''

Liefert eine Liste an TerminIDs gelöschter Termine ab einer bestimmten Revision zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Benutzers
|-
| RevisionID|| Integer||| Revisionsnummer
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AppointmentIDs|| Array||| Liste gelöschter Termine
|}

''<u>getIDOForAppointment</u>''

Liefert die IDO IDs zu einem Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array mit der Instanz_ID in der ersten Dimension und das Value der zweiten Dimension sind die IDO IDs
|}

''<u>SaveAppointment</u>''

Speichert einen neuen Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentTitle||String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>UpdateAppointment</u>''

Einen vorhandenen Termin bearbeiten
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| AppointmentTitle|| String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>AddAppointmentMember</u>''

Einem vorhanden Termin einen weiteren Teilnehmer zubuchen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| UserID|| Integer||| BenutzerID
|-
| Alarm|| Boolean||| Soll Benutzer alarmiert werden
|-
| Active|| Boolean||| aktiv oder informativ
|-
| WritePermission|| Boolean||| Schreibrecht
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>DeleteAppointment</u>''

Einem vorhanden Termin entfernen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich gelöscht?
|}

''<u>setIDO</u>''

Einem vorhanden Termin mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

''<u>SaveAppointmentWithReturnID</u>''

Speichert einen neuen Termin und gibt dessen ID zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentTitle ||String ||| Titel des Termins
|-
| AppointmentDescription ||String ||| Text des Termins
|-
| AppointmentType ||Integer ||| TermintypID
|-
| AppointmentTimestamp ||Integer ||| Timestamp des Termins
|-
| AppointmentDuration ||Integer ||| Dauer des Termins in Minuten
|-
| AppointmentAccess ||String ||| Private or public
|-
| AppointmentGenerator ||Integer ||| UserID des Erstellers
|-
| AppointmentConfirm ||Boolean ||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence ||Boolean ||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm ||anyType ||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday ||anyType ||| Ganztägiger Termin
|-
| AppointmentMember ||anyType ||| Terminteilnehmer Array
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getAppointmentTypeList</u>''

Liefert eine Liste der verfügbaren Termintypen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID ||anyType ||| ID des Benutzers
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getAppointmentIDsByInstanceIDAndIDOID</u>''

Liefert alle Termin-IDs die mit einem Datensatz verknüpft sind

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>removeIDO</u>''

Entfernt die Verknüpfung eines Termins mit einem Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| InstanceID ||Integer ||| ID der IDO Instanz
|-
| IDOID ||Integer ||| ID des Datensatzes
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>SetRevision</u>''

Setzt die Revision eines Termins auf den aktuellen Stand

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>SetRevisionForAppointment</u>''

Setzt eine bestimmte Revision für einen Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID ||Integer ||| ID des Termins
|-
| Revision ||Integer ||| Revisionsnummer
|-
| Token || String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice activities

2026-05-13T10:13:57Z

Jan:

* '''WSDL Datei'''

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

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

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?activities",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Es wird im Datensatz eine Planaktivität angelegt
$PA = $client->__soapCall('addActivity',array(1,2,0123456789,8,"Titel","Beschreibung",1,1,22,10,2,$token));
?>

* '''Example für Demo Instanz'''

<?php
$benutzer="admin";
$passwort="infra-struktur";

//Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
$client_activities = new SoapClient("https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities",array('exceptions'=>false));

//Authetifizieren am webservice
$token = $client_activities->__soapCall("authenticate",array("https://demo.infra-struktur.eu",$benutzer,$passwort));

// Planaktivität anlegen in der Demoversion, Benutzer "holling"
//$client_activities->__soapCall('addActivity',array($instanzid,$DatensatzID,$timestamp,$kommartid,$titel,$beschreibung,$bearbeiterid,$verfasserid,$dauersekunden,$alarmsekunden,$status1bis3,$token));
$client_activities->__soapCall('addActivity',array(9,1,1389718401,1,"Testeintrag über Webservice","hier steht es",2,2,120,0,1,$token));
?>

* '''Funktionsübersicht'''

''<u>AddActivity</u>''

Fügt einem Datensatz eine neue Aktivität hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| ActivityStartTime|| Integer||| Timestamp der Startzeit
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|-
| ActivityTitle|| String ||| Titel der Aktivität
|-
| ActivityContent|| String ||| Text der Aktivität
|-
| ContactPersonID|| Integer||| UserID der Kontaktperson
|-
| AuthorID|| Integer||| UserID des Verfassers
|-
| ActivityDuration|| Integer||| Dauer der Aktivität in Minuten
|-
| AlarmBeforeStarttime|| Integer||| Alarm in Minuten vor StartTime
|-
| ActivityStatus|| Integer||| Status der Aktivität, Statusmöglichkeiten:
* 1 – Rot
* 2 – Gelb
* 3 – Grün
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| EntryID|| Integer||| ID der Aktivität
|}

''<u>GetActivityTypeIDByName</u>''

Liefert die TypenID der jeweiligen Aktivität zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| ActivityTypeName|| String||| Name des Aktivitätentyps
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|}

''<u>AddActivityToIDO</u>''

Fügt eine zuvor gesetzte Aktivität an einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| ActivityID||Integer||| ID der Aktivität
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolian||| Status der Aktion
|}

''<u>getActivityTypes</u>''

Gibt eine Liste aller verfügbaren Aktivitätentypen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array||| Aktivitätentypen
|}

''<u>setActivityState</u>''

Setzt den Status einer Aktivität

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| activityID ||Integer ||| ID der Aktivität
|-
| activityStatus ||Integer ||| Neuer Status der Aktivität, Statusmöglichkeiten:
* 1 – Rot
* 2 – Gelb
* 3 – Grün
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice ido

2026-05-13T10:13:25Z

Jan:

* '''WSDL Datei'''

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

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

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

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getInstances</u>''

Liefert sämtliche verfügbare IDO Instanzen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoInstances || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
|}

''<u>getTextfieldsByInstanceID</u>''

Liefert sämtliche Textfelder zur 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoTextFields || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
|}

''<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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoSelectFields || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
|}

''<u>getRadiofieldsByInstanceID</u>''

Liefert sämtliche Radiofelder 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoRadiofields || Array ||| Array mit den verfügbaren Radiofeldern (FeldID,Feldname)
|}

''<u>getCheckboxesByInstanceID</u>''

Liefert sämtliche Checkboxen 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoCheckboxes || Array ||| Array mit den verfügbaren Checkboxen (FeldID,Feldname)
|}

''<u>CountConfigurenCheckboxesByInstanceID</u>''

Gibt die Anzahl der verfügbaren Checkboxen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countCheckboxes || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredSelectfieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Selectfelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredRadiofieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Radiofelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>getPossibleCheckboxValues</u>''

Liefert die Auswahlmöglichkeiten einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID ||Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkboxValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleSelectfieldValues</u>''

Liefert die Auswahlmöglichkeiten eines Selectfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID der Selectbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| selectfieldsValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleRadiofieldValues</u>''

Liefert die Auswahlmöglichkeiten einer Radiobox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID des Radiofelds
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| radiofieldValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getIDOInstanceSpecialFieldConfiguration</u>''

Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| true/false || Boolean ||| Konfigurationsstatus
|}

''<u>GenerateFieldTypeArray</u>''

Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldTypeArray || Array ||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|}

''<u>getFieldType</u>''

Liefert den Typ eines bestimmten Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldName || String ||| Name des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| feldtyp || String ||| Typ des Feldes
|}

''<u>getFullIDOStructure</u>''

Liefert die vollständige Struktur einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoMappingFieldsByInstanceIdAndIdoId</u>''

Liefert die Mapping-Felder eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>openRemoteIDO</u>''

Öffnet einen IDO-Datensatz remote

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDataByInstanceIDOIdAndFieldID</u>''

Liefert den Wert des angegebenen Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldValue || String ||| Wert des Feldes
|}

''<u>getCheckedValuesForInstanceAndCheckBoxID</u>''

Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolean zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getPossibleValuesForInstanceAndCheckboxID</u>''

Liefert alle verfügbaren Einträge einer Checkbox zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getArchiveContent</u>''

Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| archiveContent || String ||| Inhalt des Archivfelds
|}

''<u>getMessageContent</u>''

Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| messageContent || String ||| Inhalt des Hinweisfelds
|}

''<u>getNextContact</u>''

Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContact || String ||| Datum des nächsten Kontakts
|}

''<u>getNextContactTime</u>''

Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContactTime || String ||| Uhrzeit des nächsten Kontakts
|}

''<u>getLastContact</u>''

Liefert das Datum des letzten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || String |||
|}

''<u>IsTerminOnNextContact</u>''

Liefert zurück ob der nächste Kontakt ein Termin ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| isTermin || Boolean ||| Termin oder nicht
|}

''<u>getContactPerson</u>''

Liefert die ausgewählte Kontaktperson des Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| contactPerson || Integer ||| UserID der Kontaktperson
|}

''<u>getAllEntries</u>''

Liefert alle Einträge einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullIdoInstance</u>''

Liefert alle Datensätze einer IDO-Instanz (mit Paginierung und Zeitfilter)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| offset || anyType ||| Startposition (für Paginierung)
|-
| limit || anyType ||| Maximale Anzahl zurückgegebener Datensätze
|-
| lastModificationTimestamp || anyType ||| Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoContextValue</u>''

Liefert den Kontextwert eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoListByGivenIDs</u>''

Liefert eine Liste von Datensätzen anhand einer Liste von IDs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoIdList || anyType ||| Array mit den abzufragenden Datensatz-IDs
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setValueForDataset</u>''

Setzt den Wert eines bestimmten Feldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTextFieldValue</u>''

Setzt den Wert eines Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldValue || String ||| Wert der Option
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setArchiveContent</u>''

Setzt den Wert des Archivfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setMessageContent</u>''

Setzt den Wert des Hinweisfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactPerson</u>''

Setzt die Kontaktperson eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| employeeID || Integer ||| UserID der Kontaktperson
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactDate</u>''

Setzt den Wert des Feldes nächster/letzter Kontakt

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactTime</u>''

Setzt die Uhrzeit des nächsten Kontakts

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| time || String ||| Uhrzeit (HH:MM:SS)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTermin</u>''

Setzt den nächsten Kontakt als Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| switchStatus || Boolean ||| Termin oder nicht
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCombofield</u>''

Setzt den Wert eines Combofeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| valueID || Integer ||| ID des Values
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCheckboxValues</u>''

Setzt den Wert einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setValueOfMappedField</u>''

Setzt den Wert eines Feldes anhand seines Mapping-Keys

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId || Integer ||| ID des Datensatzes
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Wert des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>addCombovalue</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForComboField</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForDemoField</u>''

Fügt einen neuen Wert zu einem Demo-Feld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>refreshTheIdoUserInterface</u>''

Aktualisiert die IDO-Benutzeroberfläche

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>CreateNewDataset</u>''

Erstellt einen neuen, leeren Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| contactPersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| ID des neuen Datensatz
|}

''<u>createNewDatasetWithID</u>''

Erstellt einen neuen Datensatz mit einer vordefinierten ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| definedIDOID || Integer ||| Vordefinierte ID des neuen Datensatzes
|-
| contactpersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteIDO</u>''

Löscht einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>restoreIDO</u>''

Stellt einen gelöschten Datensatz wieder her

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIDOCount</u>''

Gibt die Anzahl aller Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.17)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer ||| Anzahl Datensätze
|}

''<u>getDatasetIDList</u>''

Gibt ein Array mit den IDs aller aktiven Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.36)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array ||| DatensatzID-Array
|}

''<u>isIDOLock</u>''

Prüft ob ein Datensatz gesperrt ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Boolean |||
|}

''<u>setIDOLock</u>''

Sperrt einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| userID ||Integer ||| UserID des sperrenden Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>releaseIDOLock</u>''

Gibt die Sperre eines Datensatzes frei

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanz und dem Match auf den Wert des angegebenen Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| Datensatz ID
|}

''<u>getIDOIDByInstanceIdMappingKeyAndFieldValue</u>''

Liefert die ID eines Datensatzes anhand eines Mapping-Keys und eines Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer |||
|}

''<u>GetIDOsByCantactperson</u>''

Liefert alle Datensätze einer Instanz, die einer bestimmten Kontaktperson zugeordnet sind

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| contactpersonID ||Integer ||| ID der Kontaktperson
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines exakten Textfeldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (exakter Treffer)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines Textfeldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (Teilstring-Suche)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines exakten numerischen Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Wert)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines numerischen Feldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Teilstring)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (exakte Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCheckboxIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Checkbox-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID der Checkbox
|-
| valueId || String ||| ID des Checkbox-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCombofieldIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Combofeld-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Combofeldes
|-
| valueId || String ||| ID des Combofeld-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createTask</u>''

Erstellt eine neue Aufgabe

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Aufgabe
|-
| content ||String ||| Inhalt / Beschreibung der Aufgabe
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| forerunTime ||Integer ||| Vorwarnzeit in Sekunden
|-
| alarmTimestamp ||Integer ||| Alarmzeitpunkt als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| responsibleUserId ||Integer ||| UserID des Verantwortlichen
|-
| responsibleUserState ||Integer ||| Status des Verantwortlichen
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkTaskToIdo</u>''

Verknüpft eine Aufgabe mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId ||Integer ||| ID der Aufgabe
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createNote</u>''

Erstellt eine neue Notiz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Notiz
|-
| content ||String ||| Inhalt der Notiz
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| ownerUserState ||Integer ||| Status des Erstellers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkNoteToIdo</u>''

Verknüpft eine Notiz mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| noteId ||Integer ||| ID der Notiz
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice task

2026-05-13T08:57:00Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>createTask</u>''

Erstellt eine Aufgabe in der infra-struktur.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title || string ||| Titel der Aufgabe
|-
| content || string ||| Inhalt der Aufgabe
|-
| forerunTime || integer ||| Vorlaufzeit in Tagen
|-
| fixedMaturityTimestamp || time() ||| Timestamp der des Datums der Aufgabe
|-
| alarmTimestamp || time() ||| Timestamp des Alarms
|-
| ownerUserId || integer ||| UserID der Erstellers
|-
| responsibleUserId || integer ||| UserID des Bearbeiters
|-
| responsibleUserState || integer ||| Status der Aufgabe (1=rot, 2=gelb, 3=grün)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Legt eine Aufgabe in der infra-struktur an
|}

''<u>linkTaskToIdo</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId || integer ||| ID der Aufgabe
|-
| instanceId || integer ||| ID der IDO-Instanz aus der verknüpft wird
|-
| idoId || integer ||| ID des Datensatzes der verknüpft wird
|-
| token || string ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Verknüpft eine Aufgabe
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice email

2026-05-13T08:56:49Z

Jan:

* '''WSDL Datei'''

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

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

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse schmelzer@netzkultur.de zu schicken

<?php

$instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
$username = "webservice";
$password = "123456789";
$userID = 4;

$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));

$attachments = array();
$toArray = array(
'1' => 'schmelzer@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$attachments[] = array('AttachmentFilename' => $fileName,
'AttachmentFilesize' => filesize($filePath),
'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))

$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);

$Client->__soapCall('sendMail', array ($mailTemplate, $token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>archiveMail</u>''

Wechselt den Archivierungsstatus einer Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}

''<u>createDraft</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array aus Mailvorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}

''<u>getEmptyMailTemplateJson</u>''

Holt eine leere Mailvorlage (das mailData Array)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}

''<u>getMailGroupsForUser</u>''

Gibt die Mailgruppen des angegebenen Users aus.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}

''<u>getNewDirectEmailCount</u>''

Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}

''<u>getNewGlobalizedEmailCount</u>''

Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}

''<u>getPostboxesForUser</u>''

Zeigt die Postfächer eines gewählten Users an.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}

''<u>getStandardTemplateForMailAccountAndUser</u>''

Gibt die ID der Standardvorlage eines Users für ein Postfach.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| templateID || integer ||| ID der Standardvorlage
|}

''<u>getWebmailTemplate</u>''

Holt die Ausgewählte Vorlage in ein Array.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}

''<u>openComposeWindow</u>''

Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}

''<u>sendBulkMail</u>''

Versendet eine Massenmail

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Massenmail
|}

''<u>sendMail</u>''

Versendet eine Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Mail.
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice email

2026-05-13T08:53:12Z

Jan:

* '''WSDL Datei'''

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

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

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse paul.pfiffig@netzkultur.de zu schicken

<?php

$instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
$username = "webservice";
$password = "123456789";
$userID = 4;

$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));

$attachments = array();
$toArray = array(
'1' => 'paul.pfiffig@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$attachments[] = array('AttachmentFilename' => $fileName,
'AttachmentFilesize' => filesize($filePath),
'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))

$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);

$Client->__soapCall('sendMail', array ($mailTemplate, $token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>archiveMail</u>''

Wechselt den Archivierungsstatus einer Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}

''<u>createDraft</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array aus Mailvorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}

''<u>getEmptyMailTemplateJson</u>''

Holt eine leere Mailvorlage (das mailData Array)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}

''<u>getMailGroupsForUser</u>''

Gibt die Mailgruppen des angegebenen Users aus.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}

''<u>getNewDirectEmailCount</u>''

Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}

''<u>getNewGlobalizedEmailCount</u>''

Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}

''<u>getPostboxesForUser</u>''

Zeigt die Postfächer eines gewählten Users an.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}

''<u>getStandardTemplateForMailAccountAndUser</u>''

Gibt die ID der Standardvorlage eines Users für ein Postfach.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| templateID || integer ||| ID der Standardvorlage
|}

''<u>getWebmailTemplate</u>''

Holt die Ausgewählte Vorlage in ein Array.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}

''<u>openComposeWindow</u>''

Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}

''<u>sendBulkMail</u>''

Versendet eine Massenmail

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Massenmail
|}

''<u>sendMail</u>''

Versendet eine Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Mail.
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice user

2026-05-13T08:53:00Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getUserIDByLoginname</u>''

Liefert die UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| LoginName||String ||| Loginname des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserIDByKuerzel</u>''

Liefert das Kürzel UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserKuerzel||String ||| Kuerzel des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserList</u>''

Liefert eine Liste aller im System registrierten Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserList|| Array||| Alle UserIDs im System
|}

''<u>getUsername</u>''

Liefert den Benutzernamen zur angegebenen UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID|| Integer||| UserID des Benutzers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserName|| String||| Angeforderter Benutzername
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice msg

2026-05-13T08:52:53Z

Jan:

Webservice idolinkings

2026-05-13T08:52:47Z

Jan:

Webservice dms

2026-05-13T08:52:37Z

Jan:

* '''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'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>insertNewDocument</u>''

Speichert ein neues Dokument in der Datenbank

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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 <nowiki>|</nowiki> null ||| Passwort für das Dokument
|-
| Date|| Integer <nowiki>|</nowiki> null||| Datum als Timestamp
|-
| Status|| Integer <nowiki>|</nowiki> 0 ||| Status des Dokuments
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setArchiveStatus</u>''

Archiviert ein Dokument
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des zu archivierenden Dokuments
|-
| DocumentID|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Ergebnis des Aufrufs
|}

''<u>setGlobalisation</u>''

globalisiert ein Dokument

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| GlobalID|| Integer||| ID der Globalisierung
|}

''<u>addVersion</u>''

Fügt einem Dokument eine weitere 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>setStatusForAllAllowedUsers</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Status|| Integer||| Status des Dokuments (0,1,2)
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Funktion
|}

''<u>getBoxes</u>''

Liefert ein array mit allen verfügbaren DMS Ablagen

''<u>setIDO</u>''

Erstellt eine Verknüpfung zwischen Dokument und Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| IdoID|| Integer||| ID des Datensatz
|-
| InstanceID|| Integer||| ID der Instanz
|-
| 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
|}

''<u>setCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>changeDocumentTitle</u>''

Ändert den Titel eines Dokuments

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| DocumentTitle|| String||| Neuer Titel
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Status der Aktion
|}

''<u>getBoxes</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Title
|}

''<u>getMaxAllowedFilesize</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MaxDocumentSize|| Integer||| Max. Dateigröße in Kilobyte
|}

''<u>getPostboxesForUserID</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Users
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Boxes|| Array||| Array mit BoxID und Titel
|}

''<u>getDocumentTitle</u>''

Liefert den Titel eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| DocumentTitle|| String||| Titel des Dokuments
|}

''<u>getAuthorID</u>''

Liefert den Autor eines Dokuments zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AuthorID|| Integer||| UserID des Autors
|}

''<u>getDocumentStatus</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| UserID||Integer||| ID des Benutzers
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Integer||| Status des Dokuments (1/2/3)
|}

''<u>getCategoriesForIDO</u>''

Liefert sämtliche einem Datensatz zugehörigen Kategorien

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IdoID||Integer||| ID des Datensatzes
|-
| InstanceID||Integer||| ID der Instanz
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Categories|| Array||| Verfügbare Kategorien
|}

''<u>getCategoryForDocumentAndIDO</u>''

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

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| DocumentID||Integer||| ID des Dokuments
|-
| InstanceID||Integer||| ID der Instanz
|-
| IdoID||Integer||| ID des Datensatzes
|-
| Token||String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| CategoryID|| Integer||| ID der Kategorie
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice contacts

2026-05-13T08:52:27Z

Jan:

* '''WSDL Datei'''

Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getContacts</u>''

Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IDOID|| Integer||| Datensatz ID
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Contacts|| Array||| Array Aufbau: Array->ContactID->FieldID->FieldValue
|}

''<u>getContactFields</u>''

Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Configuration|| Array||| Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration
|}

''<u>getContactCount</u>''

Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der Ansprechpartner
|}

''<u>searchContactByValue</u>''

Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| SearchString|| String||| Suchbegriff
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch
|}

''<u>getNextContactID</u>''

Liefert die nächste freie AnsprechpartnerID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des nächsten Ansprechartners
|}

''<u>setContactValue</u>''

Setzt den Wert eines speziellen Ansprechpartnerfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| ContactID|| Integer||| Ansprechpartner ID
|-
| FieldID|| Integer||| Feld ID
|-
| Value|| String||| Neuer Inhalt des Feldes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true/false
|}

''<u>addContact</u>''

Erzeugt einen neuen leeren Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des neuen Ansprechpartners
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice contacts

2026-05-13T08:52:20Z

Jan:

* '''WSDL Datei'''

Die zur Nutzung des Ansprechpartner Webservice notwendige WSDL Datei befindet sich unter:

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

<br/><br/>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getContacts</u>''

Liefert ein Array mit allen zu einem Datensatz hinterlegten Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| IDOID|| Integer||| Datensatz ID
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Contacts|| Array||| Array Aufbau: Array->ContactID->FieldID->FieldValue
|}

''<u>getContactFields</u>''

Liefert die Konfiguration der Ansprechpartnerfelder einer IDO Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Configuration|| Array||| Array Aufbau: Array->FieldID->FieldName in Reihenfolge der Konfiguration
|}

''<u>getContactCount</u>''

Liefert die Anzahl der Ansprechpartner eines Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der Ansprechpartner
|}

''<u>searchContactByValue</u>''

Liefert die Datensätze auf welche das Suchkriterium zutrifft zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| SearchString|| String||| Suchbegriff
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array Aufbau: Array->InstanceID->IDOID->ContactID->FieldID = Searchmatch
|}

''<u>getNextContactID</u>''

Liefert die nächste freie AnsprechpartnerID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des nächsten Ansprechartners
|}

''<u>setContactValue</u>''

Setzt den Wert eines speziellen Ansprechpartnerfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| ContactID|| Integer||| Ansprechpartner ID
|-
| FieldID|| Integer||| Feld ID
|-
| Value|| String||| Neuer Inhalt des Feldes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| true/false
|}

''<u>addContact</u>''

Erzeugt einen neuen leeren Ansprechpartnern

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| InstanzID
|-
| IDOID|| Integer||| Datensatz ID
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ContactID|| Integer||| ID des neuen Ansprechpartners
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice calendar

2026-05-13T08:52:14Z

Jan:

* '''WSDL Datei'''

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

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

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>GetAppointmentsForUserStartByRevisionID</u>''

Liefert sämtliche Termine eines definierten Benutzers beginnend mit der angegebenen Revisionsnummer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| RevisionID|| Integer||| Start-Revisionsnummer
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentsForUserByDate</u>''

Liefert sämtliche Termine eines definieten Benutzers an einem
bestimmten Tag zurück.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| BenutzerID
|-
| Date|| String||| Datum im Format jjjj-mm-dd
|-
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden
|-
| JustAppointmentID|| Boolean||| Sollen ganze Termine oder nur TerminIDs zurückgegeben werden
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''DeleteAppointment'''</div> || |||
|-
| Termine|| Array||| Array aus Terminen oder TerminIDs
|}

''<u>GetAppointmentByID</u>''

Liefert einen Termin anhand seiner ID zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Appointment|| Array||| Termin
|}

''<u>GetAppointmentMemberUserIDs</u>''

Liefert eine Liste der UserIDs der am Termin beteiligten Personen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserIDs|| Array||| Liste der teilnehmenden Benutzer
|}

''<u>GetAppointmentMemberCount</u>''

Liefert die Anzahl der an einem Termin teilnehmenden Personen zurück
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Count|| Integer||| Anzahl der teilnehmenden Benut
|}

''<u>GetDeletedAppointmentsByStartRevision</u>''

Liefert eine Liste an TerminIDs gelöschter Termine ab einer bestimmten Revision zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID||Integer||| ID des Benutzers
|-
| RevisionID|| Integer||| Revisionsnummer
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| AppointmentIDs|| Array||| Liste gelöschter Termine
|}

''<u>getIDOForAppointment</u>''

Liefert die IDO IDs zu einem Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Result|| Array||| Array mit der Instanz_ID in der ersten Dimension und das Value der zweiten Dimension sind die IDO IDs
|}

''<u>SaveAppointment</u>''

Speichert einen neuen Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentTitle||String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>UpdateAppointment</u>''

Einen vorhandenen Termin bearbeiten
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| AppointmentTitle|| String||| Titel des Termins
|-
| AppointmentDescription|| String||| Text des Termins
|-
| AppointmentType|| Integer||| TermintypID
|-
| AppointmentTimestamp|| Integer||| Timestamp des Termins
|-
| AppointmentDuration|| Integer||| Dauer des Termins in Minuten
|-
| AppointmentAccess|| String||| Private or public
|-
| AppointmentGenerator|| Integer||| UserID des Erstellers
|-
| AppointmentConfirm|| Boolean||| Terminbestätigung verlangt?
|-
| AppointmentTimeindependence|| Boolean||| Zeitunabhängiger Termin?
|-
| AppointmentAlarm|| Integer||| Alarm in Min. vor dem Termin
|-
| AppointmentFullday|| Boolean||| Ganztägiiger Termin
|-
| AppointmentMember|| Array||| Terminteilnehmer Array
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>AddAppointmentMember</u>''

Einem vorhanden Termin einen weiteren Teilnehmer zubuchen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| UserID|| Integer||| BenutzerID
|-
| Alarm|| Boolean||| Soll Benutzer alarmiert werden
|-
| Active|| Boolean||| aktiv oder informativ
|-
| WritePermission|| Boolean||| Schreibrecht
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich?
|}

''<u>DeleteAppointment</u>''

Einem vorhanden Termin entfernen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich gelöscht?
|}

''<u>setIDO</u>''

Einem vorhanden Termin mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| AppointmentID||Integer||| ID des Termins
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice activities

2026-05-13T08:52:07Z

Jan:

* '''WSDL Datei'''

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

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

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?activities",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Es wird im Datensatz eine Planaktivität angelegt
$PA = $client->__soapCall('addActivity',array(1,2,0123456789,8,"Titel","Beschreibung",1,1,22,10,2,$token));
?>

* '''Example für Demo Instanz'''

<?php
$benutzer="admin";
$passwort="infra-struktur";

//Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
$client_activities = new SoapClient("https://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?activities",array('exceptions'=>false));

//Authetifizieren am webservice
$token = $client_activities->__soapCall("authenticate",array("https://demo.infra-struktur.eu",$benutzer,$passwort));

// Planaktivität anlegen in der Demoversion, Benutzer "holling"
//$client_activities->__soapCall('addActivity',array($instanzid,$DatensatzID,$timestamp,$kommartid,$titel,$beschreibung,$bearbeiterid,$verfasserid,$dauersekunden,$alarmsekunden,$status1bis3,$token));
$client_activities->__soapCall('addActivity',array(9,1,1389718401,1,"Testeintrag über Webservice","hier steht es",2,2,120,0,1,$token));
?>

* '''Funktionsübersicht'''

''<u>AddActivity</u>''

Fügt einem Datensatz eine neue Aktivität hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| ActivityStartTime|| Integer||| Timestamp der Startzeit
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|-
| ActivityTitle|| String ||| Titel der Aktivität
|-
| ActivityContent|| String ||| Text der Aktivität
|-
| ContactPersonID|| Integer||| UserID der Kontaktperson
|-
| AuthorID|| Integer||| UserID des Verfassers
|-
| ActivityDuration|| Integer||| Dauer der Aktivität in Minuten
|-
| AlarmBeforeStarttime|| Integer||| Alarm in Minuten vor StartTime
|-
| ActivityStatus|| Integer||| Status der Aktivität, Statusmöglichkeiten:
* 1 – Rot
* 2 – Gelb
* 3 – Grün
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| EntryID|| Integer||| ID der Aktivität
|}

''<u>GetActivityTypeIDByName</u>''

Liefert die TypenID der jeweiligen Aktivität zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID||Integer||| ID der IDO Instanz
|-
| ActivityTypeName|| String||| Name des Aktivitätentyps
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| ActivityTypeID|| Integer||| ID des Aktivitätentyps
|}

''<u>AddActivityToIDO</u>''

Fügt eine zuvor gesetzte Aktivität an einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| ActivityID||Integer||| ID der Aktivität
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| IDOID|| Integer||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolian||| Status der Aktion
|}

''<u>getActivityTypes</u>''

Gibt eine Liste aller verfügbaren Aktivitätentypen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| InstanceID|| Integer||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array||| Aktivitätentypen
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice ido

2026-05-13T08:51:39Z

Jan:

* '''WSDL Datei'''

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

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

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

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getInstances</u>''

Liefert sämtliche verfügbare IDO Instanzen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoInstances || Array ||| Array mit den verfügbaren IDO-Instanzen (InstanceID,Instanzname)
|}

''<u>getTextfieldsByInstanceID</u>''

Liefert sämtliche Textfelder zur 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoTextFields || Array ||| Array mit den verfügbaren Textfeldern (FeldID,Feldname)
|}

''<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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoSelectFields || Array ||| Array mit den verfügbaren Selectfeldern (FeldID,Feldname)
|}

''<u>getRadiofieldsByInstanceID</u>''

Liefert sämtliche Radiofelder 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoRadiofields || Array ||| Array mit den verfügbaren Radiofeldern (FeldID,Feldname)
|}

''<u>getCheckboxesByInstanceID</u>''

Liefert sämtliche Checkboxen 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoCheckboxes || Array ||| Array mit den verfügbaren Checkboxen (FeldID,Feldname)
|}

''<u>CountConfigurenCheckboxesByInstanceID</u>''

Gibt die Anzahl der verfügbaren Checkboxen zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countCheckboxes || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredSelectfieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Selectfelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>CountConfiguredRadiofieldsByInstanceID</u>''

Gibt die Anzahl der verfügbaren Radiofelder zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| countSelectfields || Integer ||| Anzahl der verfügbaren Felder
|}

''<u>getPossibleCheckboxValues</u>''

Liefert die Auswahlmöglichkeiten einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID ||Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkboxValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleSelectfieldValues</u>''

Liefert die Auswahlmöglichkeiten eines Selectfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID der Selectbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| selectfieldsValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getPossibleRadiofieldValues</u>''

Liefert die Auswahlmöglichkeiten einer Radiobox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| feldID || Integer ||| ID des Radiofelds
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| radiofieldValues || Array ||| Array mit den verfügbaren Values (ValueID,ValueName)
|}

''<u>getIDOInstanceSpecialFieldConfiguration</u>''

Liefert den Konfigurationsstatus der angefragten Zusatzfeldverwaltung

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| true/false || Boolean ||| Konfigurationsstatus
|}

''<u>getConfiguredContactsTextFields</u>''

Liefert die konfigurierten Felder des Ansprechpartnerreiters

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| contactFields || Array ||| Array mit den verfügbaren Feldern (FeldID,Feldname)
|}

''<u>GenerateFieldTypeArray</u>''

Liefert ein mehrdimensionales Array mit allen Feldtypen der Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldTypeArray || Array ||| Zweidimensionales Array im Format array[Feldtyp][FeldID] mit dem Value Feldname
|}

''<u>getFieldType</u>''

Liefert den Typ eines bestimmten Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldName || String ||| Name des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| feldtyp || String ||| Typ des Feldes
|}

''<u>getFullIDOStructure</u>''

Liefert die vollständige Struktur einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoMappingFieldsByInstanceIdAndIdoId</u>''

Liefert die Mapping-Felder eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>openRemoteIDO</u>''

Öffnet einen IDO-Datensatz remote

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userID ||Integer ||| UserID des Benutzers
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getDataByInstanceIDOIdAndFieldID</u>''

Liefert den Wert des angegebenen Feldes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| fieldValue || String ||| Wert des Feldes
|}

''<u>getCheckedValuesForInstanceAndCheckBoxID</u>''

Liefert ein Array der angehakten IDs der Einträge der abgefragten Checkbox mit dem jeweiligen Status als Boolean zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getPossibleValuesForInstanceAndCheckboxID</u>''

Liefert alle verfügbaren Einträge einer Checkbox zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| checkboxID || Integer ||| ID der Checkbox
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| checkBoxValues || Array ||| Array dessen Key die ValueID und das Value der Name ist
|}

''<u>getArchiveContent</u>''

Liefert den Inhalt des Archivfelds eines bestimmten Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| archiveContent || String ||| Inhalt des Archivfelds
|}

''<u>getMessageContent</u>''

Liefert den Inhalt des Hinweisfelds eines bestimmten Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| messageContent || String ||| Inhalt des Hinweisfelds
|}

''<u>getNextContact</u>''

Liefert das Datum der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContact || String ||| Datum des nächsten Kontakts
|}

''<u>getNextContactTime</u>''

Liefert die Uhrzeit der Wiedervorlage / nächsten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| nextContactTime || String ||| Uhrzeit des nächsten Kontakts
|}

''<u>getLastContact</u>''

Liefert das Datum des letzten Kontakts zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || String |||
|}

''<u>IsTerminOnNextContact</u>''

Liefert zurück ob der nächste Kontakt ein Termin ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| isTermin || Boolean ||| Termin oder nicht
|}

''<u>getContactPerson</u>''

Liefert die ausgewählte Kontaktperson des Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| contactPerson || Integer ||| UserID der Kontaktperson
|}

''<u>getAllEntries</u>''

Liefert alle Einträge einer IDO-Instanz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullContactsByIdoId</u>''

Liefert alle Ansprechpartner eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getFullIdoInstance</u>''

Liefert alle Datensätze einer IDO-Instanz (mit Paginierung und Zeitfilter)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| offset || anyType ||| Startposition (für Paginierung)
|-
| limit || anyType ||| Maximale Anzahl zurückgegebener Datensätze
|-
| lastModificationTimestamp || anyType ||| Nur Datensätze zurückgeben, die nach diesem Zeitstempel geändert wurden
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoContextValue</u>''

Liefert den Kontextwert eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| userId ||Integer ||| UserID des Benutzers
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoListByGivenIDs</u>''

Liefert eine Liste von Datensätzen anhand einer Liste von IDs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoIdList || anyType ||| Array mit den abzufragenden Datensatz-IDs
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setValueForDataset</u>''

Setzt den Wert eines bestimmten Feldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTextFieldValue</u>''

Setzt den Wert eines Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Feldes
|-
| fieldValue || String ||| Wert der Option
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setArchiveContent</u>''

Setzt den Wert des Archivfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setMessageContent</u>''

Setzt den Wert des Hinweisfelds

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldValue || 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactPerson</u>''

Setzt die Kontaktperson eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| employeeID || Integer ||| UserID der Kontaktperson
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactDate</u>''

Setzt den Wert des Feldes nächster/letzter Kontakt

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setContactTime</u>''

Setzt die Uhrzeit des nächsten Kontakts

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| time || String ||| Uhrzeit (HH:MM:SS)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setTermin</u>''

Setzt den nächsten Kontakt als Termin

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| switchStatus || Boolean ||| Termin oder nicht
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCombofield</u>''

Setzt den Wert eines Combofeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| valueID || Integer ||| ID des Values
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setCheckboxValues</u>''

Setzt den Wert einer Checkbox

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | 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
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>setValueOfMappedField</u>''

Setzt den Wert eines Feldes anhand seines Mapping-Keys

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId || Integer ||| ID des Datensatzes
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Wert des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| status || Boolean ||| Status der Abfrage
|}

''<u>addCombovalue</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForComboField</u>''

Fügt einen neuen Wert zu einem Combofeld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Combofeldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addValueForDemoField</u>''

Fügt einen neuen Wert zu einem Demo-Feld hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| value || String ||| Neuer Wert
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>refreshTheIdoUserInterface</u>''

Aktualisiert die IDO-Benutzeroberfläche

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID || Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>CreateNewDataset</u>''

Erstellt einen neuen, leeren Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| contactPersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| ID des neuen Datensatz
|}

''<u>createNewDatasetWithID</u>''

Erstellt einen neuen Datensatz mit einer vordefinierten ID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| definedIDOID || Integer ||| Vordefinierte ID des neuen Datensatzes
|-
| contactpersonUserID || Integer ||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>deleteIDO</u>''

Löscht einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>restoreIDO</u>''

Stellt einen gelöschten Datensatz wieder her

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIDOCount</u>''

Gibt die Anzahl aller Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.17)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer ||| Anzahl Datensätze
|}

''<u>getDatasetIDList</u>''

Gibt ein Array mit den IDs aller aktiven Datensätze einer IDO-Instanz zurück (ab Version 2.9.7.36)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Array ||| DatensatzID-Array
|}

''<u>isIDOLock</u>''

Prüft ob ein Datensatz gesperrt ist

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Boolean |||
|}

''<u>setIDOLock</u>''

Sperrt einen Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| userID ||Integer ||| UserID des sperrenden Benutzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>releaseIDOLock</u>''

Gibt die Sperre eines Datensatzes frei

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanz und dem Match auf den Wert des angegebenen Textfeldes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| idoID || Integer ||| Datensatz ID
|}

''<u>getIDOIDByInstanceIdMappingKeyAndFieldValue</u>''

Liefert die ID eines Datensatzes anhand eines Mapping-Keys und eines Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| mappingKey || String ||| Mapping-Key des Feldes
|-
| fieldValue || String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer |||
|}

''<u>GetIDOsByCantactperson</u>''

Liefert alle Datensätze einer Instanz, die einer bestimmten Kontaktperson zugeordnet sind

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| contactpersonID ||Integer ||| ID der Kontaktperson
|-
| instanceID || Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines exakten Textfeldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (exakter Treffer)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByValue</u>''

Sucht Datensätze anhand eines Textfeldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Textfeldes
|-
| textfieldValue || String ||| Suchbegriff (Teilstring-Suche)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines exakten numerischen Feldwertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Wert)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIDAndFieldIDByNumberValue</u>''

Sucht Datensätze anhand eines numerischen Feldwertes (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| fieldID || Integer ||| ID des Feldes
|-
| textfieldValue || String ||| Suchbegriff (numerischer Teilstring)
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (exakte Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchLikeIDOByInstanceIdAndMultipleTextfieldIdsWithValues</u>''

Sucht Datensätze anhand mehrerer Textfelder und deren Werte (LIKE-Suche)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldIdWithValues || anyType ||| Array mit Feld-IDs und zugehörigen Suchwerten
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCheckboxIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Checkbox-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID der Checkbox
|-
| valueId || String ||| ID des Checkbox-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>searchIDOByInstanceIDAndCombofieldIDByValueID</u>''

Sucht Datensätze anhand eines gesetzten Combofeld-Wertes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| fieldId || Integer ||| ID des Combofeldes
|-
| valueId || String ||| ID des Combofeld-Wertes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getContactCount</u>''

Gibt die Anzahl der Ansprechpartner eines Datensatzes zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer |||
|}

''<u>getContacts</u>''

Liefert alle Ansprechpartner eines Datensatzes

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getContactFields</u>''

Liefert die verfügbaren Felder des Ansprechpartner-Reiters

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getContactDataByInstanceIDOIDAndFieldID</u>''

Liefert den Wert eines bestimmten Feldes eines Ansprechpartners

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| fieldID ||Integer ||| ID des Feldes
|-
| contactID ||Integer ||| ID des Ansprechpartners
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>getNextContactID</u>''

Liefert die ID des nächsten Ansprechpartners

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Integer |||
|}

''<u>searchContactByValue</u>''

Sucht Ansprechpartner anhand eines Suchbegriffs

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| searchString ||String ||| Suchbegriff
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>addContact</u>''

Fügt einen neuen Ansprechpartner zu einem Datensatz hinzu

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>setContactValue</u>''

Setzt den Wert eines Feldes eines Ansprechpartners

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceID ||Integer ||| ID der IDO Instanz
|-
| idoID ||Integer ||| ID des Datensatzes
|-
| contactID ||Integer ||| ID des Ansprechpartners
|-
| fieldID ||Integer ||| ID des Feldes
|-
| value ||String ||| Wert des Feldes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createTask</u>''

Erstellt eine neue Aufgabe

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Aufgabe
|-
| content ||String ||| Inhalt / Beschreibung der Aufgabe
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| forerunTime ||Integer ||| Vorwarnzeit in Sekunden
|-
| alarmTimestamp ||Integer ||| Alarmzeitpunkt als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| responsibleUserId ||Integer ||| UserID des Verantwortlichen
|-
| responsibleUserState ||Integer ||| Status des Verantwortlichen
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkTaskToIdo</u>''

Verknüpft eine Aufgabe mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId ||Integer ||| ID der Aufgabe
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>createNote</u>''

Erstellt eine neue Notiz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title ||String ||| Titel der Notiz
|-
| content ||String ||| Inhalt der Notiz
|-
| fixedMaturityTimestamp ||Integer ||| Fälligkeitsdatum als Unix-Timestamp
|-
| ownerUserId ||Integer ||| UserID des Erstellers
|-
| ownerUserState ||Integer ||| Status des Erstellers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

''<u>linkNoteToIdo</u>''

Verknüpft eine Notiz mit einem IDO-Datensatz

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| noteId ||Integer ||| ID der Notiz
|-
| instanceId ||Integer ||| ID der IDO Instanz
|-
| idoId ||Integer ||| ID des Datensatzes
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || |||
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice task

2026-05-13T08:51:13Z

Jan:

* '''WSDL Datei'''

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

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

Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.

* '''Example'''

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>createTask</u>''

Erstellt eine Aufgabe in der infra-struktur.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| title || string ||| Titel der Aufgabe
|-
| content || string ||| Inhalt der Aufgabe
|-
| forerunTime || integer ||| Vorlaufzeit in Tagen
|-
| fixedMaturityTimestamp || time() ||| Timestamp der des Datums der Aufgabe
|-
| alarmTimestamp || time() ||| Timestamp des Alarms
|-
| ownerUserId || integer ||| UserID der Erstellers
|-
| responsibleUserId || integer ||| UserID des Bearbeiters
|-
| responsibleUserState || integer ||| Status der Aufgabe (1=rot, 2=gelb, 3=grün)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Legt eine Aufgabe in der infra-struktur an
|}

''<u>linkTaskToIdo</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| taskId || integer ||| ID der Aufgabe
|-
| instanceId || integer ||| ID der IDO-Instanz aus der verknüpft wird
|-
| idoId || integer ||| ID des Datensatzes der verknüpft wird
|-
| token || string ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Verknüpft eine Aufgabe
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice email

2026-05-13T08:51:07Z

Jan:

* '''WSDL Datei'''

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

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

Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.

* '''Example'''

Dieses in php geschriebene Beispiel beinhaltet die benötigten Strukturen um eine Mail an die Adresse paul.pfiffig@netzkultur.de zu schicken

<?php

$instanceUrl = "https://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email";
$username = "webservice";
$password = "123456789";
$userID = 4;

$Client = new SoapClient($instanceUrl."?email", array('exceptions'=>false));
$token = $Client->__soapCall("authenticate",array($instanceUrl, $username, $password));

$attachments = array();
$toArray = array(
'1' => 'paul.pfiffig@netzkultur.de',
);
$bccArray = array();
$ccArray = array();
$attachments[] = array('AttachmentFilename' => $fileName,
'AttachmentFilesize' => filesize($filePath),
'AttachmentFilesourceBase64Encoded' => base64_encode(file_get_contents($filePath)))

$mailTemplate = array(
'MailReceiversTO' => $toArray,
'MailReceiversCC' => $ccArray,
'MailReceiversBCC' => $bccArray,
'MailSubject' => "Hier kommt der Betreff hin.",
'MailText' => "Hier kommt der Inhalt hin.",
'MailSendingAccountID' => 119, //AbsenderpostfachID als integer
'MailSendingTimestamp' => 0,
'MailType' => 'text/html',
'UserID' => $userID,
'ImportMode' => false,
'DocumentID' => 0,
'Attachments' => $attachments
);

$Client->__soapCall('sendMail', array ($mailTemplate, $token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>archiveMail</u>''

Wechselt den Archivierungsstatus einer Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MailID || integer ||| Datenbank ID der Mail
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
|}

''<u>createDraft</u>''

Erstellt einen Entwurf in der infra-struktur

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array aus Mailvorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Erstellt einen Entwurf in der infra-struktur
|}

''<u>getEmptyMailTemplateJson</u>''

Holt eine leere Mailvorlage (das mailData Array)

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
|}

''<u>getMailGroupsForUser</u>''

Gibt die Mailgruppen des angegebenen Users aus.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| mailGroups || Array ||| Array mit GruppenID und Gruppenname
|}

''<u>getNewDirectEmailCount</u>''

Gibt die Anzahl an Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newMailCount || Array ||| Array mit MailIDs der neuen Mails
|}

''<u>getNewGlobalizedEmailCount</u>''

Gibt die Anzahl an delegierten Mails an, die nach einer gewählten Mail angekommen sind.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| newGlobCount || Array ||| Array mit MailIDs der neuen, globalisierten Mails
|}

''<u>getPostboxesForUser</u>''

Zeigt die Postfächer eines gewählten Users an.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
|}

''<u>getStandardTemplateForMailAccountAndUser</u>''

Gibt die ID der Standardvorlage eines Users für ein Postfach.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailAccountID || integer ||| Datenbank ID des Mailpostfaches
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| templateID || integer ||| ID der Standardvorlage
|}

''<u>getWebmailTemplate</u>''

Holt die Ausgewählte Vorlage in ein Array.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| templateID || integer ||| Datenbank ID der Standardvorlage
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| standardTemplate || Array ||| Array, im mailData-Format mit den Daten der gewählten Vorlage
|}

''<u>openComposeWindow</u>''

Öffnet das "Verfassen"-Fenster mit einer gewählten Vorlage.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| templateID || integer ||| Datenbank ID der Vorlage
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Öffnet das Verfassenfenster
|}

''<u>sendBulkMail</u>''

Versendet eine Massenmail

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailArray|| Array ||| Array aus mailData-Arrays
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Massenmail
|}

''<u>sendMail</u>''

Versendet eine Mail.

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| mailData || Array ||| Array mit Maildata
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| || Aktion ||| Versendet eine Mail.
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice user

2026-05-13T08:51:01Z

Jan:

* '''WSDL Datei'''

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

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

Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.

* '''Example'''

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getUserIDByLoginname</u>''

Liefert die UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| LoginName||String ||| Loginname des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserIDByKuerzel</u>''

Liefert das Kürzel UserID an hand des Loginnamens

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserKuerzel||String ||| Kuerzel des Users
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserID|| Integer||| UserID des Benutzers
|}

''<u>getUserList</u>''

Liefert eine Liste aller im System registrierten Benutzer

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserList|| Array||| Alle UserIDs im System
|}

''<u>getUsername</u>''

Liefert den Benutzernamen zur angegebenen UserID

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| UserID|| Integer||| UserID des Benutzers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| UserName|| String||| Angeforderter Benutzername
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Webservice msg

2026-05-13T08:50:36Z

Jan:

* '''WSDL Datei'''

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

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

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?message",array('exceptions'=>false));

//Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
$token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.eu","benutzername","passwort"));

//Der User mit der ID1 schickt eine Message an den User mit der ID2
$MessageID = $client->__soapCall("createNewMessage",array(1,"Das ist ein Test",array(2),null,$token));
?>

* '''Funktionsübersicht'''

''<u>Authenticate</u>''

Authentifiziert einen Benutzer am Webservice

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| instanceName ||String ||| Vollständiger Pfad der Instanz
|-
| userName || String ||| infra-struktur Benutzername
|-
| password || String ||| infra-struktur Passwort
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| token || String ||| Authentifizierungstoken für weitere Anfragen am Webservice
|}

''<u>getMessageReadStatus</u>''

Liefert den gelesen-Status der Message zurück

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||String ||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Empfängers
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Status|| Boolean||| Gelesen oder nicht
|}

''<u>setMessageReadStatus</u>''

Markiert eine Message als gelesen

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| ReceiverID|| Integer||| UserID des Benutzers
|-
| ReadStatus|| Boolean||| Boolean
|-
| Token|| String ||| Authentifizierungstoken
|}

''<u>createNewMessage</u>''

Erstellt und versendet eine Message

{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| SenderID||Integer||| UserID des Absenders
|-
| MessageText|| String||| Text der Message
|-
| ReceiverIDArray|| Array||| UserIDs der Empfänger
|-
| MessageSendTime|| Integer||| Timestamp des Sendezeitpunkts (default: aktuelle Zeit)
|-
| Token|| String ||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| MessageID|| Integer||| ID der gesendeten Message
|}

''<u>setIDO (ab Version 2.9.7.37)</u>''

Eine vorhande Nachricht mit einem Datensatz verknüpfen
{| class="wikitable" border=1
! width="100px" | Parameter
! width="100px" | Datentyp
! width="400px" | Beschreibung
|-
| MessageID||Integer||| ID der Message
|-
| InstanceID||Integer||| ID der IDO-Instanz
|-
| IDOID||Integer||| ID des Datensatzes
|-
| Token|| String||| Authentifizierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| Erfolg|| Boolean||| Eintrag erfolgreich erzeugt?
|}

== Hauptkapitel ==
* [[Webservice Dokumentation]]

== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_ido]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]