description
| -
event_id
The id of the Calendar event. This is returned by [calendar.event.new()].
-
uid
-
subject
The subject/title of the event.
-
description
The optional description of the event, typically longer than subject.
-
location
-
attendees
An optional comma-separated list of email addresses of people working on the event.
-
privacy
Set the new event to be public (1) or private (0) or controlled by ACL (2). See [ODS Access Control Lists (ACL)] for details.
-
tags
An optional comma-separated list of tags to assign to the new event.
-
event
The type of the event: An all-day event (1) or an intervall event (0) for which both eventStart and eventEnd should contain a time.
-
eventStart
The start of the event as a datetime value. This only requires a time if the type of the event is set to intervall (0). Otherwise only the date is required. See also Virtuoso TIMESTAMP; DATE & TIME.
-
eventEnd
The end time of the event. The same rules apply as for eventStart.
-
eRepeat
Sets the event repetition:
An empty value (the default) means no repetition D1 - repeats every Nth day where eRepeatParam1 indicates the interval (1 for every day, 3 for every 3rd day, etc.) D2 - repeats every weekday (Monday to Friday) W1 - repeats every Nth week (indicated by eRepeatParam1) on the week days indicated by eRepeatParam2. This is realized as a bitmask where each day in the week corresponds to one bit. So to specify for example Mon, Tue, and Sat a value of 2^0+2^1+2^5=35 needs to be specified as eRepeatParam2. M1 - repeats on every Nth day (indicated by eRepeatParam1) of the Mth month (indicated by eRepeatParam2) M2 - repeats the 1st, 2nd, 3rd, 4th, or last (indicated by 1-5 in eRepeatParam1) Mon, Tue, ..., Sun, day, weekday, or weekend (indicated by 1-10 in eRepeatParam2) of every Nth month (indicated by eRepeatParam3). Y1 - repeats every N years (indicated by eRepeatParam1) on the month and day indicated by eRepeatParam2 and eRepeatParam3 respectively. Y2 - repeats the 1st, 2nd, 3rd, 4th, or last (indicated by 1-5 in eRepeatParam1) Mon, Tue, ..., Sun, day, weekday, or weekend (indicated by 1-10 in eRepeatParam2) of the month indicated by eRepeatParam3 (Jan to Dec).
-
eRepeatParam1
Additional repetition parameter as detailed above.
-
eRepeatParam2
Additional repetition parameter as detailed above.
-
eRepeatParam3
Additional repetition parameter as detailed above.
-
eRepeatUntilKind
Kind of until repeat: 0 - Unlimited; 1 - Count of occurrences; 2 - Until repeat date.
-
eRepeatUntilValue
Integer for count of occurrences (by eRepeatUntilKind=1) or datetime when to end the repetition of the event (by eRepeatUntilKind=2).
-
eReminder
0 to disable the reminder or the time in seconds of how long before the event the reminder should be shown.
-
notes
Additional notes on the event. FIXME: what is the difference to description?
An error code stating the success of the command execution as detailed in [ODS Error Result Codes]. If the event was successfully modified the error code will match the id of the event.
[calendar.event.new]
Example:
$ curl -i "http://ods-qa.openlinksw.com/ods/api/calendar.event.edit?event_id=1111&subject=test_event2&description=test2&eventSt
art=2011.05.20&eventEnd=2011.06.20&event=1&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh"
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB
Connection: Keep-Alive
Date: Fri, 20 May 2011 05:44:36 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 60
<result>
<code>2517</code>
<message>Success</message>
</result>
|