Sun Java System Calendar Server 6.3 WCAP Developer's Guide

Calendar Server WCAP Command Overview

The following is a list of commands supported in WCAP. For a detailed description of each command, see Chapter 3, Calendar Server WCAP Command Reference

Table 1–1 WCAP Command Overview


WCAP Command	Description
`check_id.wcap`	Administrator only: Check if user’s session ID is valid.
`createcalendar.wcap`	Create a new calendar.
`deletecalendar.wcap`	Delete an existing calendar.
`deletecomponents_by_range.wcap`	Delete both events and todos in a calendar(s) over a specific time period.
`deleteevents_by_id.wcap`	Delete events given a specific `calid` and `uid` or recurrence-ID pair.
`deleteevents_by_range.wcap`	Delete events in a calendar(s) over a specific time period.
`deletetodos_by_id.wcap`	Delete todos given a specific `calid` and `uid` or recurrence-ID pair.
`deletetodos_by_range.wcap`	Deletes todos in a calendar(s) over a specific time period.
`export.wcap`	Exports a calendar to a file.
`fetchattachment.wcap`	Fetch attachments for an event or todo.
`fetchcomponents_by_alarmrange.wcap`	Queries for components that have alarms to trigger over a specific time period.
`fetchcomponents_by_attendee_error.wcap`	Queries for components that had errors while sending group scheduling messages.
`fetchcomponents_by_lastmod.wcap`	Queries for components that have changed, during the specified time range.
`fetch_deletedcomponents.wcap`	Queries the `deletelog` database for deleted components.
`fetchcomponents_by_range.wcap`	Queries for components over a specific time period, with filtering attributes.
`fetchevents_by_id.wcap`	Queries for one or more events by a unique identifier (UID, Recurrence ID, modifier).
`fetchtodos_by_id.wcap`	Queries for one or more todos by a unique identifier (UID, Recurrence ID, modifier).
`get_all_timezones.wcap`	Returns all the time zones the server supports.
`get_calprops.wcap`	Returns calendar properties.
`get_freebusy.wcap`	Returns calendar free-busy time.
`get_guids.wcap`	Returns a set of random UID's.
`gettime.wcap`	Returns the server times for the requested `calid`s.
`get_userprefs.wcap`	Returns user preferences and some server settings.
`import.wcap`	Imports a calendar from a file to a user’s calendar.
`list.wcap`	Lists all calendars owned by a user.
`list_subscribed.wcap`	Lists all calendars subscribed to by a user.
`login.wcap`	Authenticates a user and redirects to first HTML view.
`logout.wcap`	Terminates the current user’s session and return to login screen.
`ping.wcap`	Administrator only: Pings the calendar server.
`search_calprops.wcap`	Searches for a calendar with the specified parameter values.
`set_calprops.wcap`	Sets calendar properties.
`set_userprefs.wcap`	Sets user preferences.
`storeevents.wcap`	Stores events that are specified in application or URL encoded manner. For storing an even by passing properties in a URL.
`storetodos.wcap`	Stores todos that are specified in the application or URL encoded manner.
`subscribe_calendars.wcap`	Adds calendars to a users subscription list.
`unsubscribe_calendars.wcap`	Removes calendars from a user’s subscription list.
`verifyevents_by_ids.wcap`	Fetches events and returns the `uid` or `rid` of events not in the database.
`verifytodos_by_ids.wcap`	Fetches todos and returns the `uid` or `rid` of todos not in the database.
`version.wcap`	Returns the WCAP version that the server supports.

Session Identifiers

For many WCAP commands, you must specify the session identifier (id) that is returned by the login command. The session identifier ensures that data is accessible only to authenticated users with the required level of privilege or ownership.

When logging into the system, a user provides authentication of identity. The default authentication mechanism uses plain-text passwords and user names. Calendar Server generates the session identifier only when authentication is successful. The identifier then serves as proof of authentication in subsequent calendaring operations.

For more information about how to configure authentication, see the Calendar Server Administration Guide: Sun Java System Calendar Server 6.3 Administration Guide.

Hosted (Virtual) Domain Mode

In earlier versions of Calendar Server, using domains was optional. Now all installations are configured with at least one domain and are considered to be in hosted domain mode. Therefore, all WCAP commands you issue must have fully qualified user ID's (uid) and calendar ID's (calid) to properly identify the domain, for example jdoe@example.com.