Not logged in : Login |
ODS AddressBook can subscribe to external addressbooks and integrate the contacts into its own. This function allows to set up such a subscription to a vCard file.
subscription_id
The id of the AddressBook subscription as returned by addressbook.subscription.new().
name
A user-readable name for the new subscription.
updateType
Can be one of:
1 - The subscription is updated manually via addressbook.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."carddav" - In this case the source is a CardDAV 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.
tagsInclude
Optional comma-separated list of tags to include in the export. If given only contacts tagged thusly will be exported.
tagsExclude
Optional comma-separated list of tags to exclude from the export. If given contacts tagged thusly are excluded from the export.
An error code stating the success of the command execution as detailed in ODS Error Result Codes.
addressbook.subscription.new
Example:
$ curl -i "http://kingsley.idehen.net/ods/api/addressbook.subscription.edit?subscription_id=2222&name=testsubscr24&source=DAV/home/demo/Public/Demo_PUB_AddressBook.ics&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 22:01:52 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 58
21
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/addressbook.subscription.edit?subscription_id=2222&name=testsubscr24&source=DAV/home/demo/Public/Demo_PUB_AddressBook.ics&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 22:01:52 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 58 <result> <code>21</code> <message>Success</message> </result> |
name |
|
url | |
contentType |
|
httpMethod |
|
isWebServiceOf | |
oplwebservices:endPointURL | |
hasParameter | |
schema:shortDescription |
|
is target of |