Webservice task: Unterschied zwischen den Versionen

Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Zum nächsten Versionsunterschied →
Die Seite wurde neu angelegt: „* '''WSDL Datei''' Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter: http://instanzname.infra-struktu…“
 
Keine Bearbeitungszusammenfassung
Zeile 3: Zeile 3:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:
Die zur Nutzung der infra-struktur Benutzerverwaltung Webservices notwendige WSDL-Datei finden Sie unter:


http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?email
http://instanzname.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.
Beachten Sie, dass der Webserver für die Verwendung der Webservices Schreibrechte auf das Verzeichnis „WEBROOT/webservice/wsdl“ benötigt.
Zeile 35: Zeile 35:




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


Wechselt den Archivierungsstatus einer Mail.
Erstellt eine Aufgabe in der infra-struktur.


{| class="wikitable" border=1  
{| class="wikitable" border=1  
Zeile 44: Zeile 44:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| MailID || integer ||| Datenbank ID der Mail
| title || string ||| Titel der Aufgabe
|-
|-
| UserID || integer ||| ID des Mailabsenders
| content || string ||| Inhalt der Aufgabe
|-
|-
| Token|| String ||| Authentifizierungstoken
| forerunTime || integer ||| Vorlaufzeit in Tagen
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| Wert: 1 || integer ||| Hat den Archivierungsstatus einer Mail gewechselt
| fixedMaturityTimestamp || time() ||| Timestamp der des Datums der Aufgabe
|}
 
 
''<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
| alarmTimestamp || time() ||| Timestamp des Alarms
|-
|-
| Token|| String ||| Authentifizierungstoken
| ownerUserId || integer ||| UserID der Erstellers
|-
|-
| &nbsp; || |||
| responsibleUserId || integer ||| UserID des Bearbeiters
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||       |||
| responsibleUserState || integer ||| Status der Aufgabe (1=rot, 2=gelb, 3=grün)
|-
|  || 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
| Token|| String ||| Authentifizierungstoken
Zeile 94: Zeile 66:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| mailTemplate || Array ||| Array mit dem Aufbau der für das mailData Array gebraucht wird
| || Aktion ||| Legt eine Aufgabe in der infra-struktur an
|}
|}


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


Gibt die Mailgruppen des angegebenen Users aus.
''<u>linkTaskToIdo</u>''


{| class="wikitable" border=1
Erstellt einen Entwurf in der infra-struktur
! width="100px" | Parameter       
! width="100px" | Datentyp 
! width="400px" | Beschreibung
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <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  
{| class="wikitable" border=1  
Zeile 127: Zeile 79:
! width="400px" | Beschreibung
! width="400px" | Beschreibung
|-
|-
| UserID || integer ||| ID des Mailabsenders
| taskId || integer ||| ID der Aufgabe
|-
| lastMailID || integer ||| MailID der auszuwählenden Mail
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <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
| instanceId || integer ||| ID der IDO-Instanz aus der verknüpft wird
|-
|-
| &nbsp; || |||
| idoId || integer ||| ID des Datensatzes der verknüpft wird
|-
|-
| <div align=center>'''Rückgabewert'''</div> ||       |||
| token || string ||| Authentifizierungstoken
|-
| 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
|-
|-
| &nbsp; || |||
| &nbsp; || |||
Zeile 182: Zeile 91:
| <div align=center>'''Rückgabewert'''</div> ||        |||
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|-
| postboxes || Array ||| Array mit PostfachID und Name des Postfaches
| || Aktion ||| Verknüpft eine Aufgabe
|}
|}


''<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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| UserID || integer ||| ID des Mailabsenders
|-
| Token|| String ||| Authentifizierungstoken
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|  || Aktion ||| Versendet eine Mail.
|}




Version vom 21. Dezember 2018, 09:02 Uhr

  • WSDL Datei

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

http://instanzname.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

Authenticate

Authentifiziert einen Benutzer am Webservice

Parameter Datentyp Beschreibung
instanceName String Vollständiger Pfad der Instanz
userName String infra-struktur Benutzername
password String infra-struktur Passwort
 
Rückgabewert
token String Authentifizierungstoken für weitere Anfragen am Webservice


createTask

Erstellt eine Aufgabe in der infra-struktur.

Parameter Datentyp 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
 
Rückgabewert
Aktion Legt eine Aufgabe in der infra-struktur an


linkTaskToIdo

Erstellt einen Entwurf in der infra-struktur

Parameter Datentyp 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
 
Rückgabewert
Aktion Verknüpft eine Aufgabe


Hauptkapitel

Verwandte Themen

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