Webservice calendar: Unterschied zwischen den Versionen
Aus infra-struktur AdminWiki 2.10
Zur Navigation springenZur Suche springen
Ino (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Jan (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| (11 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt) | |||
| Zeile 3: | Zeile 3: | ||
Die zur Nutzung der infra-struktur Kalender Webservices notwendige WSDL-Datei finden Sie unter: | Die zur Nutzung der infra-struktur Kalender Webservices notwendige WSDL-Datei finden Sie unter: | ||
http:// | http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar | ||
* '''Funktionsübersicht''' | * '''Funktionsübersicht''' | ||
| Zeile 74: | Zeile 69: | ||
| UserID||Integer||| BenutzerID | | UserID||Integer||| BenutzerID | ||
|- | |- | ||
| | | Date|| String||| Datum im Format jjjj-mm-dd | ||
|- | |- | ||
| JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden | | JustActive|| Boolean||| Sollen nur aktive Termine ausgegeben werden | ||
| Zeile 171: | Zeile 166: | ||
|- | |- | ||
| AppointmentIDs|| Array||| Liste gelöschter Termine | | 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 | |||
|} | |} | ||
| Zeile 286: | Zeile 302: | ||
|- | |- | ||
| Erfolg|| Boolean||| Eintrag erfolgreich? | | 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? | |||
|} | |||
''<u>SaveAppointmentWithReturnID</u>'' | |||
Speichert einen neuen Termin und gibt dessen ID zurück | |||
{| 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 ||anyType ||| Alarm in Min. vor dem Termin | |||
|- | |||
| AppointmentFullday ||anyType ||| Ganztägiger Termin | |||
|- | |||
| AppointmentMember ||anyType ||| Terminteilnehmer Array | |||
|- | |||
| Token || String ||| Authentifizierungstoken | |||
|- | |||
| || ||| | |||
|- | |||
| <div align=center>'''Rückgabewert'''</div> || ||| | |||
|- | |||
| || ||| | |||
|} | |||
''<u>getAppointmentTypeList</u>'' | |||
Liefert eine Liste der verfügbaren Termintypen | |||
{| class="wikitable" border=1 | |||
! width="100px" | Parameter | |||
! width="100px" | Datentyp | |||
! width="400px" | Beschreibung | |||
|- | |||
| UserID ||anyType ||| ID des Benutzers | |||
|- | |||
| Token || String ||| Authentifizierungstoken | |||
|- | |||
| || ||| | |||
|- | |||
| <div align=center>'''Rückgabewert'''</div> || ||| | |||
|- | |||
| || ||| | |||
|} | |||
''<u>getAppointmentIDsByInstanceIDAndIDOID</u>'' | |||
Liefert alle Termin-IDs die mit einem Datensatz verknüpft sind | |||
{| 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 ||| Authentifizierungstoken | |||
|- | |||
| || ||| | |||
|- | |||
| <div align=center>'''Rückgabewert'''</div> || ||| | |||
|- | |||
| || ||| | |||
|} | |||
''<u>removeIDO</u>'' | |||
Entfernt die Verknüpfung eines Termins mit einem Datensatz | |||
{| 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> || ||| | |||
|- | |||
| || ||| | |||
|} | |||
''<u>SetRevision</u>'' | |||
Setzt die Revision eines Termins auf den aktuellen Stand | |||
{| 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> || ||| | |||
|- | |||
| || ||| | |||
|} | |||
''<u>SetRevisionForAppointment</u>'' | |||
Setzt eine bestimmte Revision für einen Termin | |||
{| class="wikitable" border=1 | |||
! width="100px" | Parameter | |||
! width="100px" | Datentyp | |||
! width="400px" | Beschreibung | |||
|- | |||
| AppointmentID ||Integer ||| ID des Termins | |||
|- | |||
| Revision ||Integer ||| Revisionsnummer | |||
|- | |||
| Token || String ||| Authentifizierungstoken | |||
|- | |||
| || ||| | |||
|- | |||
| <div align=center>'''Rückgabewert'''</div> || ||| | |||
|- | |||
| || ||| | |||
|} | |} | ||
| Zeile 293: | Zeile 509: | ||
== Verwandte Themen == | == Verwandte Themen == | ||
* [[Webservice_activities]] | |||
* [[Webservice_calendar]] | * [[Webservice_calendar]] | ||
* [[Webservice_contacts]] | * [[Webservice_contacts]] | ||
* [[Webservice_dms]] | * [[Webservice_dms]] | ||
* [[Webservice_dmstagging]] | |||
* [[Webservice_ido]] | * [[Webservice_ido]] | ||
* [[Webservice_idolinkings]] | |||
* [[Webservice_msg]] | * [[Webservice_msg]] | ||
* [[Webservice_user]] | * [[Webservice_user]] | ||
* [[Webservice_email]] | |||
* [[Webservice_task]] | |||
Aktuelle Version vom 13. Mai 2026, 11:56 Uhr
- WSDL Datei
Die zur Nutzung der infra-struktur Kalender Webservices notwendige WSDL-Datei finden Sie unter:
http://demo.infra-struktur.eu/webservice/wsdl/wsdl.php?calendar
- 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? |
SaveAppointmentWithReturnID
Speichert einen neuen Termin und gibt dessen ID zurück
| 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 | anyType | Alarm in Min. vor dem Termin |
| AppointmentFullday | anyType | Ganztägiger Termin |
| AppointmentMember | anyType | Terminteilnehmer Array |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
getAppointmentTypeList
Liefert eine Liste der verfügbaren Termintypen
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| UserID | anyType | ID des Benutzers |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
getAppointmentIDsByInstanceIDAndIDOID
Liefert alle Termin-IDs die mit einem Datensatz verknüpft sind
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| instanceId | Integer | ID der IDO Instanz |
| idoId | Integer | ID des Datensatzes |
| token | String | Authentifizierungstoken |
Rückgabewert |
||
removeIDO
Entfernt die Verknüpfung eines Termins mit einem Datensatz
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| InstanceID | Integer | ID der IDO Instanz |
| IDOID | Integer | ID des Datensatzes |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
SetRevision
Setzt die Revision eines Termins auf den aktuellen Stand
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
SetRevisionForAppointment
Setzt eine bestimmte Revision für einen Termin
| Parameter | Datentyp | Beschreibung |
|---|---|---|
| AppointmentID | Integer | ID des Termins |
| Revision | Integer | Revisionsnummer |
| Token | String | Authentifizierungstoken |
Rückgabewert |
||
