Webservice msg: Unterschied zwischen den Versionen
Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Ino (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Ino (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 85: | Zeile 85: | ||
|- | |- | ||
| Token|| String ||| Authentifizierungstoken | | 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 | |||
|} | |} | ||
Version vom 13. Mai 2009, 13:27 Uhr
- WSDL Datei
Die zur Nutzung der infra-struktur Message Webservices notwendige WSDL-Datei finden Sie unter:
http://instanzname.infra-struktur.de/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.de/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.de","benutzername","passwort"));
//....
?>
- 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 |