Webservice calendar
- 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
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 |
GetAppointmentsForUserStartByRevisionID
Liefert sämtliche Termine eines definierten Benutzers beginnend mit der angegebenen Revisionsnummer
| Parameter | Datentyp | 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 |
Rückgabewert |
||
| Termine | Array | Array aus Terminen oder TerminIDs |
GetAppointmentsForUserByDate
Liefert sämtliche Termine eines definieten Benutzers an einem bestimmten Tag zurück.
| Parameter | Datentyp | 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 |
DeleteAppointment |
||
| Termine | Array | Array aus Terminen oder TerminIDs |
GetAppointmentByID
Liefert einen Termin anhand seiner ID zurück
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Appointment | Array | Termin |
GetAppointmentMemberUserIDs
Liefert eine Liste der UserIDs der am Termin beteiligten Personen
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| UserIDs | Array | Liste der teilnehmenden Benutzer |
GetAppointmentMemberCount
Liefert die Anzahl der an einem Termin teilnehmenden Personen zurück
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Count | Integer | Anzahl der teilnehmenden Benut |
GetDeletedAppointmentsByStartRevision
Liefert eine Liste an TerminIDs gelöschter Termine ab einer bestimmten Revision zurück
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | Integer | ID des Benutzers |
| RevisionID | Integer | Revisionsnummer |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| AppointmentIDs | Array | Liste gelöschter Termine |
getIDOForAppointment
Liefert die IDO IDs zu einem Termin
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Result | Array | Array mit der Instanz_ID in der ersten Dimension und das Value der zweiten Dimension sind die IDO IDs |
SaveAppointment
Speichert einen neuen Termin
| Parameter | Datentyp | 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 |
Rückgabewert |
||
| Erfolg | Boolean | Eintrag erfolgreich? |
UpdateAppointment
Einen vorhandenen Termin bearbeiten
| Parameter | Datentyp | 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 |
Rückgabewert |
||
| Erfolg | Boolean | Eintrag erfolgreich? |
AddAppointmentMember
Einem vorhanden Termin einen weiteren Teilnehmer zubuchen
| Parameter | Datentyp | 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 |
Rückgabewert |
||
| Erfolg | Boolean | Eintrag erfolgreich? |
DeleteAppointment
Einem vorhanden Termin entfernen
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Erfolg | Boolean | Eintrag erfolgreich gelöscht? |
setIDO
Einem vorhanden Termin mit einem Datensatz verknüpfen
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| InstanceID | Integer | ID der IDO-Instanz |
| IDOID | Integer | ID des Datensatzes |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
| Erfolg | Boolean | Eintrag erfolgreich erzeugt? |
