storetodos.wcap

alarmAudio

ISO 8601 Date Time string 

The time at which to sound an audio alarm. 

N 

N/A 

alarmDescription

string 

The message send out with the alarm 

N 

“This is the alarm description” 

alarmEmails

semicolon-separated list of email addresses 

Recipients of alarm notifications for the todo. 

N 

N/A 

alarmFlashing

ISO 8601 Date Time string 

The time at which to run a flashing alarm. 

N 

N/A 

alarmPopup

ISO 8601 Date Time string 

ISO 8601 Duration string 

The time at which to pop up a dialog alarm. 

N 

N/A 

alarmStart

ISO 8601 Date Time string 

ISO 8601 Duration string 

The time at which to send an alarm notification of the todo. 

N 

N/A 

appid

string 

A runtime parameter that is not stored in the database. The parameter specifies which application is making the request. ENS uses this parameter to determine which X-Tokens to return. Does not affect WCAP command output. 

For more information on the ENS X-Tokens, see the Sun Java Communications Suite 5 Event Notification Service Guide.

N 

N/A 

attendees

semicolon-separated list of strings 

A todo’s iCalendar RFC 2445 attendee properties. For a list of the properties understood by Calendar Server, see Calendar Server WCAP Attendee: CUTYPE Parameter

N 

N/A 

calid

string 

Calendar identifier (or email address of calid) in which to store the todo.

Y 

N/A 

categories

semicolon-separated list of strings 

The todo categories. 

N 

N/A 

charset

string 

The character set for the calendar. 

N 

N/A 

completed

ISO 8601 Date Time string 

Completion date of the todo. A value of 0 means the todo is not yet completed.

N 

0

compressed

integer (0,1)

This parameter has been deprecated in this release and might be removed in future releases. 

For compressed=0, returns less data. Specifically, it does not return the following parameters:rrules, rdates, xrule, and exdates.

For compressed=1, all recurrence data is returned.

N 

0

contacts

semicolon-separated list of strings 

Contacts for the todo. 

N 

N/A 

deleteattach

semicolon-separated list of strings 

Attachment ids of the attachments to be deleted. 

N 

N/A 

desc

string 

Purpose of the todo. A string of any length. 

If not passed, desc is set to the summary value.

To include spaces in the string, use the code %20.

N 

Value in summary parameter.

dtstart

ISO 8601 Date Time string 

Start time and date of the todo. 

Not required to modify todos. 

Required to create todos. 

N 

Y 

N/A 

due

ISO 8601 Date Time string 

End time and date of the todo. 

N 

N/A 

duration

ISO 8601 duration string 

Todo duration. 

N 

N/A 

excludedtstart

integer (0, 1)

Whether or not to include the dtstart date in a recurring series if it does not fall within the rrules dates.

0 = include the dtstart date

1 = exclude the dtstart date

N 

0

exdates

semicolon-separated list of ISO 8601 Date Time strings 

Exclusionary recurrence dates of the todo. To successfully create todos, the rrules parameter must also be specified.

N 

N/A 

exrules

semicolon-separated list strings 

Todo exclusionary recurrence rules. A semicolon-separated list of recurrence-rule strings. 

Each rule value must be enclosed in quotes. See Recurring Components in Calendar Server WCAP

N 

N/A 

fetch

integer (0,1)

A boolean indicating whether or not to fetch and return newly stored todos. 

1 = Fetch and return newly stored todos.

0 = Do not fetch todos.

N 

0

fmt-out

string 

The format for the returned data. 

The three format types: 

text/calendartext/xml

N 

text/calendar

geo

two semicolon-separated floats 

Semicolon-separated string of two float numbers representing the todo’s geographical location (latitude and longitude). 

For example, 37.31;-123.2.

N 

0;0

icsClass

string 

Todo class. One of the following values: 

PUBLIC — Others can see time and text only

PRIVATE — Others can see time and date only

CONFIDENTIAL — Others can see nothing. (Set transparent = 1 to make it invisible.)

N 

PUBLIC

icsUrl

string 

Todo URL. 

N 

""

id

unique identifier string 

The session identifier. 

Y 

N/A 

isAllDay

integer (0,1)

A boolean indicating whether or not it is an all day todo. 

1 = An all day todo.

0 = Not an all day todo.

N 

0

language

string 

Language of event. (For example, en, fr, de)

N 

N/A 

location

string 

Event location. 

N 

""

method

integer (1,2,4,8)

ITIP method for group scheduling. 

1 = PUBLISH (organizer only uses this)2 = REQUEST (organizer only uses this)4 = REPLY (attendees only use this)8 = CANCEL (organizer only uses this)

Y 

1 (PUBLISH)

mod

integer 

A modifier indicating which recurrences to retrieve. One of the following values: 

1 = THISINSTANCE

2 = Deprecated, see note.

3 = Deprecated, see note.

4 = THISANDALL

Values 2 and 3 were deprecated. Using these values results in undetermined behavior.

N 

Y 

N/A 

notify

integer 

0,1 

This parameter has been deprecated. It remains to provide backward compatibility. The Group Scheduling Engine (GSE) handles sending of email notifications. 

A boolean indicating whether or not to notify attendees of a changed todo. 

1 = Notify attendees of the change.

0 = Do not notify attendees.

N 

0

orgCalid

string 

Calendar identifier of organizer. 

One of the following parameters must be specified: orgCalid, orgEmail, or orgUID.

N 

N/A 

orgCN

string 

Common name of the organizer. 

N 

N/A 

orgEmail

email address 

The email address contact for the todo. (Usually the organizer’s email.) 

One of the following parameters must be specified: orgCalid, orgEmail, or orgUID.

N 

N/A 

orgUID

userid

The userid of the organizer.

One of the following parameters must be specified: orgCalid, orgEmail, or orgUID.

N 

N/A 

percent

integer (0-100)

Percentage completion of the todo. 

N 

0

priority

integer (0-9)

Event priority. Follows RFC 2445. 

0 = undefined

1= highest

9= lowest

N 

5

rchange

integer (0,1)

A boolean indicating whether or not to replace the rrule:

1 = Replace the rule.0 = Do not replace it.

N 

0

rdates

semicolon-separated list of ISO 8601 Date Time Z strings 

Recurrence dates of the todo. To successfully create todos, the rrules parameter must also be specified.

N 

N/A 

relatedTos

semicolon-separated list of quoted strings 

Other todos to which this todo is related. 

N 

N/A 

replace

integer (0,1)

A boolean. For parameters with semicolon-separated values: 

1 = update (replace the old values with the new passed-in values)

0 = append (add the new passed-in values to the old ones)

N 

0

resources

semicolon-separated list of strings 

The resources associated with the todo. 

N 

N/A 

rid

ISO 8601 Date Time string 

Recurrence identifier of the todo. 

Not required for new todos. 

If this parameter is not specified the whole series is modified. 

N 

N/A 

rrules

semicolon-separated list of strings 

Todo recurrence rules. A semicolon-separated list of recurrence-rule strings. 

Each rule value must be enclosed in quotes. See Recurring Components in Calendar Server WCAP

N 

N/A 

sendattach

integer (0,1)

0 = Sends information about the attachments in an iTIP message.

1 = Sends the attachment itself.

N 

0

seq

integer 

Sequence number of the todo. 

N 

0

status

integer 

A code for the status of the todo. One of the following values: 

0 CONFIRMED 1 CANCELLED 2 TENTATIVE 3 NEEDS_ACTION 4 COMPLETED 5 IN_PROCESS 6 DRAFT 7 FINAL

Note: Setting status=4 sets the status as COMPLETED, but does not set the COMPLETED_TIME_STAMP and PERCENT properties. All three parameters must be set if a task is completed.

N 

N/A 

storetype

integer 

Designates whether an explicit “create” or “modify” is attempted on a todo. An error results if an attempt is made to create a todo that already exists, or to modify a todo that does not exist. The error returned is STORETODOS_FAILED (15)

The following values are valid: 

0 WCAP_STORE_TYPE_NONE

1 WCAP_STORE_TYPE_CREATE

2 WCAP_STORE_TYPE_MODIFY

If the attribute is not passed or has a value of 0, no error conditions are reported.

N 

0

summary

string 

Todo summary. A string of any length. 

Required for new todos. Not required for modifying todos. 

To include spaces in the string, use the code %20.

Y/N 

Default summary available for new todos

transparent

integer (0, 1)

1 = private todos transparent. Exclude private todos from free-busy calculations.

0 = opaque. Include private todos in free-busy calculations.

N 

0 (opaque)

tzid

time zone ID string, 

The time zone used to convert time parameter values to Zulu time for storage. 

If this parameter is not present, and the string does not end in Z, then the calendar server time-zone ID is used. 

N 

Calendar server time zone ID

tzidout

time zone ID string 

Time zone returned data should be translated to. Only valid when the fetch parameter is set to 1 (fetch=1).

N 

Returns data in Zulu time 

uid

string 

Unique identifier of the todo to be stored. 

System generated for new todos. Required to modify todos. 

N/Y 

Default uid for new todos