Not logged in : Login
(Sponging disallowed)

About: EntryPoint - addressbook_publication_edit     Goto   Sponge   NotDistinct   Permalink

An Entity of Type : schema:EntryPoint, within Data Space : kingsley.idehen.net associated with source document(s)
QRcode icon
http://kingsley.idehen.net/describe/?url=http%3A%2F%2Fkingsley.idehen.net%2FDAV%2FVAD%2FAddressBook%2Fwww%2FAPI_addressbook.ttl%23action_addressbook.publication.edit

ODS AddressBook allows to publish its contents to WebDAV, CardDAV, or a writable URL. This method allows to create new publications which are then updated according to the settings.The published file contains the addressbook's contacts in vCard format. publication_id The id of the AddressBook publication as returned by addressbook.publication.new(). name A user-readable name for the publication. FIXME: why is this not optional? updateType Can be one of: 1 - The publication is updated manually via addressbook.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."carddav" - In this case the destination is a CardDAV 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 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.publication.new Example: $ curl -i "http://kingsley.idehen.net/ods/api/addressbook.publication.edit?publication_id=3333&name=testpub3&destination=DAV/home/demo/Public/Demo_PUB_AddressBook.ics&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:56:16 GMT Accept-Ranges: bytes Content-Type: text/xml; charset="UTF-8" Content-Length: 58 3333 Success

AttributesValues
type
Description
  • ODS AddressBook allows to publish its contents to WebDAV, CardDAV, or a writable URL. This method allows to create new publications which are then updated according to the settings.

    The published file contains the addressbook's contacts in vCard format.

  • publication_id

    The id of the AddressBook publication as returned by addressbook.publication.new().

  • name

    A user-readable name for the publication. FIXME: why is this not optional?

  • updateType

    Can be one of:

    1 - The publication is updated manually via addressbook.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.

    "carddav" - In this case the destination is a CardDAV 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 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.publication.new

Example:
 $ curl -i "http://kingsley.idehen.net/ods/api/addressbook.publication.edit?publication_id=3333&name=testpub3&destination=DAV/home/demo/Public/Demo_PUB_AddressBook.ics&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:56:16 GMT
 Accept-Ranges: bytes
 Content-Type: text/xml; charset="UTF-8"
 Content-Length: 58

 <result>
   <code>3333</code>
   <message>Success</message>
 </result>
 

name
  • EntryPoint - addressbook_publication_edit
url
contentType
  • text/xml
httpMethod
  • GET
isWebServiceOf
oplwebservices:endPointURL
hasParameter
schema:shortDescription
  • Modify a addressbook publication.

is target of
Faceted Search & Find service v1.17_git139 as of Feb 29 2024


Alternative Linked Data Documents: PivotViewer | iSPARQL | ODE     Content Formats:   [cxml] [csv]     RDF   [text] [turtle] [ld+json] [rdf+json] [rdf+xml]     ODATA   [atom+xml] [odata+json]     Microdata   [microdata+json] [html]    About   
This material is Open Knowledge   W3C Semantic Web Technology [RDF Data] Valid XHTML + RDFa
OpenLink Virtuoso version 08.03.3330 as of Mar 11 2024, on Linux (x86_64-generic-linux-glibc25), Single-Server Edition (7 GB total memory, 5 GB memory in use)
Data on this page belongs to its respective rights holders.
Virtuoso Faceted Browser Copyright © 2009-2024 OpenLink Software