Not logged in : Login |
ODS Bookmark can subscribe to external bookmarks and integrate the events and tasks into its own. This function allows to set up such a subscription to an iCal file.
inst_id
The id of the Bookmark app instance. See ODS App Instance Ids for details.
name
A user-readable name for the new subscription.
updateType
Can be one of:
1 - The subscription is updated manually via bookmark.subscription.sync()2 - The subscription 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 subscription is updated every N days or hours.
sourceType
Can be one of the following:
"webdav" - In this case the source is a WebDAV path."caldav" - In this case the source is a CalDAV path."url" - In this case the source is a URL.
source
The location from where the events and tasks should be fetched (depends on the value of sourceType)
userName
An optional userName which might be required to access the source.
userPassword
The password for the given userName.
folderPath
tags
An optional comma-separated list of tags to assign to the imported events and tasks.
An error code stating the success of the command execution as detailed in ODS Error Result Codes. If successful the error code matches the numerical id of the newly created subscription.
Example:
$ curl -i "http://kingsley.idehen.net/ods/api/bookmark.subscription.new?inst_id=11&name=testsubscr23&source=DAV/home/demo/Public/Demo_PUB_Bookmark.ics&destinationType=WebDAV&userName=demo&userPassword=demo&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: Tue, 24 May 2011 21:59:21 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 58
6666
Attributes | Values |
---|---|
type | |
Description |
An error code stating the success of the command execution as detailed in ODS Error Result Codes. If successful the error code matches the numerical id of the newly created subscription. $ curl -i "http://kingsley.idehen.net/ods/api/bookmark.subscription.new?inst_id=11&name=testsubscr23&source=DAV/home/demo/Public/Demo_PUB_Bookmark.ics&destinationType=WebDAV&userName=demo&userPassword=demo&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: Tue, 24 May 2011 21:59:21 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 58 <result> <code>6666</code> <message>Success</message> </result> |
name |
|
url | |
contentType |
|
httpMethod |
|
isWebServiceOf | |
oplwebservices:endPointURL | |
hasParameter | |
schema:shortDescription |
|
is target of |