Webservice calendar: 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 64: | Zeile 64: | ||
''<u>GetAppointmentsForUserByDate</u>'' | ''<u>GetAppointmentsForUserByDate</u>'' | ||
Liefert sämtliche Termine eines | Liefert sämtliche Termine eines definieten Benutzers an einem | ||
bestimmten Tag zurück. | |||
{| class="wikitable" border=1 | {| class="wikitable" border=1 | ||
| Zeile 83: | Zeile 84: | ||
| || ||| | | || ||| | ||
|- | |- | ||
| <div align=center>''' | | <div align=center>'''DeleteAppointment'''</div> || ||| | ||
|- | |- | ||
| Termine|| Array||| Array aus Terminen oder TerminIDs | | Termine|| Array||| Array aus Terminen oder TerminIDs | ||
| Zeile 91: | Zeile 92: | ||
''<u>GetAppointmentByID</u>'' | ''<u>GetAppointmentByID</u>'' | ||
Liefert | Liefert einen Termin anhand seiner ID zurück | ||
{| class="wikitable" border=1 | {| class="wikitable" border=1 | ||
| Zeile 112: | Zeile 113: | ||
''<u>GetAppointmentMemberUserIDs</u>'' | ''<u>GetAppointmentMemberUserIDs</u>'' | ||
Liefert | Liefert eine Liste der UserIDs der am Termin beteiligten Personen | ||
{| class="wikitable" border=1 | {| class="wikitable" border=1 | ||
! width="100px" | Parameter | ! width="100px" | Parameter | ||
| Zeile 133: | Zeile 133: | ||
''<u>GetAppointmentMemberCount</u>'' | ''<u>GetAppointmentMemberCount</u>'' | ||
Liefert | Liefert die Anzahl der an einem Termin teilnehmenden Personen zurück | ||
{| class="wikitable" border=1 | {| class="wikitable" border=1 | ||
! width="100px" | Parameter | ! width="100px" | Parameter | ||
| Zeile 154: | Zeile 153: | ||
''<u>GetDeletedAppointmentsByStartRevision</u>'' | ''<u>GetDeletedAppointmentsByStartRevision</u>'' | ||
Liefert | Liefert eine Liste an TerminIDs gelöschter Termine ab einer bestimmten Revision zurück | ||
{| class="wikitable" border=1 | {| class="wikitable" border=1 | ||
| Zeile 172: | Zeile 171: | ||
|- | |- | ||
| AppointmentIDs|| Array||| Liste gelöschter Termine | | 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? | |||
|} | |} | ||
Version vom 8. Mai 2009, 11:13 Uhr
- 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 |
| 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 |
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 |
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? |
