• schema:EntryPoint

• EntryPoint - calendar_subscription_new

• ODS Calendar can subscribe to external calendars 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 Calendar 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 calendar.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.

• events

  If 1 events are included.

• tasks

  If 1 tasks are included.

 $ curl -i "http://ods-qa.openlinksw.com/ods/api/calendar.subscription.new?inst_id=148&name=testsubscr23&source=DAV/home/demo/Public/Demo_PUB_Calendar.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>21</code>
   <message>Success</message>
 </result>
 

• Create a new calendar subscription.

• https://ods-qa.openlinksw.com/ods/api/calendar.subscription.new 

• updatePeriod
• events
• inst_id
• name
• source
• sourceType
• tasks
• updateFreq
• updateType
• userName
• userPassword

• calendar_subscription_new