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

Webservice msg

2011-07-22T06:36:06Z

Hauke:

* '''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"));

//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 ido

2011-07-22T06:22:33Z

Hauke:

* '''WSDL Datei'''

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

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?ido

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"));

//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>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>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>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> || |||
|-
| IdoRadiofields || 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>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>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>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
|-
| SelectfieldID|| 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
|-
| RadiofieldID|| 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>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>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>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
|-
| Value|| 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
|-
| Value|| 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>setContactPerson</u>''

{| 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>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
|-
| Value|| 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>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 der 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>getIdoIDByInstanceIDAndFieldIDByFieldValue</u>''

Liefert die ID eines Datensatzes anhand der gegebenen ID der IDO Instanzund 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>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
|-
| ContactPerson|| Integer||| UserID des Besitzers
|-
| token || String ||| Validierungstoken
|-
|   || |||
|-
| <div align=center>'''Rückgabewert'''</div> || |||
|-
| IDOID|| Integer||| ID des neuen Datensatz
|}

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

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

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

Webservice calendar

2011-07-22T06:20:36Z

Hauke:

* '''WSDL Datei'''

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

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?calendar

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

2010-06-25T08:16:50Z

Hauke: Die Seite wurde neu angelegt: „* '''WSDL Datei''' Die zur Nutzung der infra-struktur DMS-Tagging Webservices notwendige WSDL-Datei finden Sie unter: http://instanzname.infra-struktur.de/webse...“

* '''WSDL Datei'''

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

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?dmstagging

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

Webservice Dokumentation

2010-06-25T07:52:54Z

Hauke:

Hier finden Sie die Dokumentation der Webservices der infra-struktur, also die SOAP Schnittstelle, um mit der infra-struktur Datenbank zu kommunizieren. Als Einführung beachten Sie den [http://blog.infra-struktur.de/2008/01/11/soa-und-webservices/ Blogartikel]. Alles zum Thema SOAP findet man unter: [http://de3.php.net/manual/de/book.soap.php].

Die benötigten WSDL Dateien sind bei den Onlineversionen bereits für HTTP und HTTPS integriert, für Lokalinstallationen müssen die WSDL Dateien selber erzeugt und eingespielt werden. Der WSDL-Creator findet sich unter: [http://www.infra-struktur.de/wsdl/] (Benutzer: wsdl / Passwort: infra-struktur)

[[Datei:Wsdl-creator.png]]

* infra-struktur Version: nach einem Releasewechsel ist es evtl. nötig, neue WSDL Dateien zu erzeugen (nur Lokalinstallation)
* URL: bitte immer HTTP oder HTTPS mit angeben, bei Lokalinstallationen "localhost" und/oder die IP Adresse des Servers
* Daten senden: gibt eine ZIP Datei mit den benötigten WSDL Dateien zurück

==[[webservice_calendar]]==
==[[webservice_contacts]]==
==[[webservice_dms]]==
==[[webservice_ido]]==
==[[webservice_msg]]==
==[[webservice_user]]==
==[[webservice_dmstagging]]==

Webservice calendar

2009-06-03T12:30:51Z

Hauke:

* '''WSDL Datei'''

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

http://instanzname.infra-struktur.de/webservice/wsdl/wsdl.php?calendar

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

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

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