Webservice: Calendar

calendar operations [Commercial editions only]

Index Method Request(s) Response Description
1 save sid
event
 event creates or modifies a calendar event

Method #1: save

creates or modifies a calendar event

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     event
WSEvent Y the event to update/create
          id
Long Y unique identifier of the event, 0 in case of new event
          start
String Y when the event starts; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          end
String when the event terminates; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          title
String Y name of the event
          type
String
          subType
String
          parentId
Long related event
          location
String
          description
String description of the event
          organizer
String Y
          organizerId
Long Y
          frequency
Int Y frequency of this event: 0=not recurrent, 1=daily, 7=weekly, 30=monthly
          status
Int Y current status: 0=none, 1=working, 2=completed, 3=cancelled
          iCalendar
Boolean Y flag to send iCalendar notifications
          deadline
String deadline in case of frequency is > 0; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          automation
String optional automation code to execute at each reminder
          attendees
WSAttendee Y Y collection of all the attendees
               userId
Long Y identifier of the user, 0 if no user is referenced
               name
String display name of the attendee
               email
String Y email of the attendee
               notify
Boolean Y
               required
Boolean Y
          documents
Long Y ids of attached documents
          reminders
WSReminder Y the reminders
               value
Int Y time before the event start date when the recipients need to be notified. The unit is expressed in unit.
               unit
String Y time unit: minute, hour, day
               reminded
Boolean Y
               date
String the exact date when the event must be notified; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'

Response

Name Type Required Multiple Description
     event
WSEvent Y
          id
Long Y unique identifier of the event, 0 in case of new event
          start
String Y when the event starts; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          end
String when the event terminates; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          title
String Y name of the event
          type
String
          subType
String
          parentId
Long related event
          location
String
          description
String description of the event
          organizer
String Y
          organizerId
Long Y
          frequency
Int Y frequency of this event: 0=not recurrent, 1=daily, 7=weekly, 30=monthly
          status
Int Y current status: 0=none, 1=working, 2=completed, 3=cancelled
          iCalendar
Boolean Y flag to send iCalendar notifications
          deadline
String deadline in case of frequency is > 0; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          automation
String optional automation code to execute at each reminder
          attendees
WSAttendee Y Y collection of all the attendees
               userId
Long Y identifier of the user, 0 if no user is referenced
               name
String display name of the attendee
               email
String Y email of the attendee
               notify
Boolean Y
               required
Boolean Y
          documents
Long Y ids of attached documents
          reminders
WSReminder Y the reminders
               value
Int Y time before the event start date when the recipients need to be notified. The unit is expressed in unit.
               unit
String Y time unit: minute, hour, day
               reminded
Boolean Y
               date
String the exact date when the event must be notified; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'