Webservice msg: Unterschied zwischen den Versionen

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


http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?message
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
Diese in PHP geschrieben Beispielapplikation dient als leichter Einstieg in die infra-struktur Webservices
Zeile 13: Zeile 9:
   <?php
   <?php
   //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
   //Einen neuen SoapClient erstellen und Verbindung mit der infra-struktur WSDL Datei aufnehmen
   $client = new SoapClient("http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido",array('exceptions'=>false));
   $client = new SoapClient("http://instanzname.infra-struktur.eu/webservice/wsdl/wsdl.php?message",array('exceptions'=>false));
    
    
   //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
   //Authentifizierung am Webservice mit den infra-struktur Benutzerdaten
   $token = $client->__soapCall("authenticate",array("http://instanzname.infra-struktur.de","benutzername","passwort"));
   $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));
   ?>
   ?>


Zeile 67: Zeile 64:
| Status|| Boolean||| Gelesen oder nicht
| 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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <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
|-
| &nbsp; || |||
|-
| <div align=center>'''Rückgabewert'''</div> ||        |||
|-
|      ||  |||
|}
== Hauptkapitel ==
* [[Webservice Dokumentation]]
== Verwandte Themen ==
* [[Webservice_activities]]
* [[Webservice_calendar]]
* [[Webservice_contacts]]
* [[Webservice_dms]]
* [[Webservice_dmstagging]]
* [[Webservice_ido]]
* [[Webservice_idolinkings]]
* [[Webservice_msg]]
* [[Webservice_user]]
* [[Webservice_email]]
* [[Webservice_task]]

Aktuelle Version vom 13. Mai 2026, 11:57 Uhr

  • 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

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


getMessageReadStatus

Liefert den gelesen-Status der Message zurück

Parameter Datentyp Beschreibung
MessageID String ID der Message
ReceiverID Integer UserID des Empfängers
Token String Authentifizierungstoken
 
Rückgabewert
Status Boolean Gelesen oder nicht


setMessageReadStatus

Markiert eine Message als gelesen

Parameter Datentyp Beschreibung
MessageID Integer ID der Message
ReceiverID Integer UserID des Benutzers
ReadStatus Boolean Boolean
Token String Authentifizierungstoken


createNewMessage

Erstellt und versendet eine Message

Parameter Datentyp 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
 
Rückgabewert
MessageID Integer ID der gesendeten Message

setIDO (ab Version 2.9.7.37)

Eine vorhande Nachricht mit einem Datensatz verknüpfen

Parameter Datentyp Beschreibung
MessageID Integer ID der Message
InstanceID Integer ID der IDO-Instanz
IDOID Integer ID des Datensatzes
Token String Authentifizierungstoken
 
Rückgabewert
Erfolg Boolean Eintrag erfolgreich erzeugt?

createAnswerMessage

Erstellt eine Antwort auf eine bestehende Message

Parameter Datentyp 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
 
Rückgabewert


getMessage

Liefert eine Message anhand ihrer ID

Parameter Datentyp Beschreibung
messageId Integer ID der Message
token String Authentifizierungstoken
 
Rückgabewert


getMessageHistory

Liefert den Nachrichtenverlauf einer Message

Parameter Datentyp Beschreibung
messageId Integer ID der Message
token String Authentifizierungstoken
 
Rückgabewert


getUnreadMessages

Liefert ungelesene Messages eines Benutzers

Parameter Datentyp Beschreibung
UserID Integer UserID des Benutzers
Count Integer Maximale Anzahl zurückzugebender Messages
Token String Authentifizierungstoken
 
Rückgabewert


getReadMessages

Liefert gelesene Messages eines Benutzers

Parameter Datentyp Beschreibung
UserID Integer UserID des Benutzers
Count Integer Maximale Anzahl zurückzugebender Messages
Token String Authentifizierungstoken
 
Rückgabewert


readMessage

Markiert eine Message als gelesen

Parameter Datentyp Beschreibung
MessageID Integer ID der Message
Token String Authentifizierungstoken
 
Rückgabewert


getGreenMessageIdsForUser

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

Parameter Datentyp Beschreibung
userId Integer UserID des Benutzers
page Integer Seitennummer (Paginierung)
size Integer Anzahl Einträge pro Seite
token String Authentifizierungstoken
 
Rückgabewert


getYellowMessageIdsForUser

Liefert die IDs der gelben Messages eines Benutzers (paginiert)

Parameter Datentyp Beschreibung
userId Integer UserID des Benutzers
page Integer Seitennummer (Paginierung)
size Integer Anzahl Einträge pro Seite
token String Authentifizierungstoken
 
Rückgabewert


getRedMessageIdsForUser

Liefert die IDs der roten Messages eines Benutzers (paginiert)

Parameter Datentyp Beschreibung
userId Integer UserID des Benutzers
page Integer Seitennummer (Paginierung)
size Integer Anzahl Einträge pro Seite
token String Authentifizierungstoken
 
Rückgabewert


getIdoLinkingsForMessage

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

Parameter Datentyp Beschreibung
messageId Integer ID der Message
token String Authentifizierungstoken
 
Rückgabewert


setMessageSenderState

Setzt den Status einer Message für den Absender

Parameter Datentyp Beschreibung
messageId Integer ID der Message
state Integer Neuer Status
token String Authentifizierungstoken
 
Rückgabewert


setMessageReceiverState

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

Parameter Datentyp Beschreibung
messageId Integer ID der Message
receiverId Integer UserID des Empfängers
state Integer Neuer Status
token String Authentifizierungstoken
 
Rückgabewert


Hauptkapitel

Verwandte Themen

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