Not logged in : Login |
ODS Bookmark allows to publish its contents to WebDAV, CalDAV, or a writable URL. This method allows to create new publications which are then updated according to the settings.The published file contains the bookmark's events and/or tasks in iCal format.
inst_id
The id of the Bookmark app instance. See ODS App Instance Ids for details.
name
A user-readable name for the new publication.
updateType
Can be one of:
1 - The publication is updated manually via bookmark.publication.sync()2 - The publication is updated automatically whenever an entry changes.3 - The publication is updated based on the schedule set via updatePeriod and updateFreq.
updatePeriod
Can be one of "daily" and "hourly". Only used for the scheduled updating.
updateFreq
Specifies the frequency of the scheduled updates. Depending on the value of updatePeriod the publication is updated every N days or hours.
destinationType
Can be one of the following:
"webdav" - In this case the destination is a WebDAV path."caldav" - In this case the destination is a CalDAV path."url" - In this case the destination is a URL.
destination
The location where the events and tasks should be published (depends on the value of destinationType)
userName
An optional userName which might be required to access the destination.
userPassword
The password for the given userName.
tagsInclude
Optional comma-separated list of tags to include in the export. If given only events and tasks tagged thusly will be exported.
tagsExclude
Optional comma-separated list of tags to exclude from the export. If given events and tasks tagged thusly are excluded from the export.
FIXME: the UI provides "mails to attendees" configuration.An error code stating the success of the command execution as detailed in ODS Error Result Codes.
bookmark.publication.sync
Example:
$ curl -i "http://kingsley.idehen.net/ods/api/bookmark.publication.new?inst_id=11&name=demo_pub&destination=DAV/home/demo/Public/Demo_PUB_Bookmark.ics&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh9ba13"
HTTP/1.1 200 OK
Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB
Connection: Keep-Alive
Date: Tue, 24 May 2011 21:42:38 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 58
3333
Attributes | Values |
---|---|
type | |
Description |
An error code stating the success of the command execution as detailed in ODS Error Result Codes. $ curl -i "http://kingsley.idehen.net/ods/api/bookmark.publication.new?inst_id=11&name=demo_pub&destination=DAV/home/demo/Public/Demo_PUB_Bookmark.ics&userName=demo&userPassword=demo&user_name=demo&password_hash=921q783d9e4cbdf5cvs343dafdfvrf6a4fh9ba13" HTTP/1.1 200 OK Server: Virtuoso/06.02.3129 (Linux) x86_64-generic-linux-glibc25-64 VDB Connection: Keep-Alive Date: Tue, 24 May 2011 21:42:38 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 58 <result> <code>3333</code> <message>Success</message> </result> |
name |
|
url | |
contentType |
|
httpMethod |
|
isWebServiceOf | |
oplwebservices:endPointURL | |
hasParameter | |
schema:shortDescription |
|
is target of |