Sandbox

Revision as of 09:10, 19 November 2009 by Tierlieb (talk | contribs)
Detailed appointment data
ID Name Type Value
201 start_date Date or Time Inclusive start of the event as Date for tasks and whole day appointments and Time for normal appointments. For sequencies, this date must be part of the sequence, i. e. sequences always start at this date.
202 end_date Date or Time Exclusive end of the event as Date for tasks and whole day appointments and as Time for normal appointments.
206 recurrence_id Number Object ID of the entire appointment sequence. Present on series and change exception appointments. Equals to object identifier on series appointment and is different to object identifier on change exceptions.
207 recurrence_position Number 1-based position of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
208 recurrence_date_position Date Date of an individual appointment in a sequence. Present if and only if recurrence_type > 0.
209 recurrence_type Number Specifies the type of the recurrence for a task sequence:
0 none (single event)
1 daily
2 weekly
3 monthly
4 yearly
210 change_exceptions Array An array of Dates, representing all change exceptions of a sequence.
211 delete_exceptions Array An array of Dates, representing all delete exceptions of a sequence.
212 days Number Specifies which days of the week are part of a sequence. The value is a bitfield with bit 0 indicating sunday, bit 1 indicating monday and so on. May be present if recurrence_type > 1. If allowed but not present, the value defaults to 127 (all 7 days).
213 day_in_month Number Specifies which day of a month is part of the sequence. Counting starts with 1. If the field "days" is also present, only days selected by that field are counted. If the number is bigger than the number of available days, the last available day is selected. Present if and only if recurrence_type > 2.
214 month Number Month of the year in yearly sequencies. 0 represents January, 1 represents February and so on. Present if and only if recurrence_type = 4.
215 interval Number Specifies an integer multiplier to the interval specified by recurrence_type. Present if and only if recurrence_type > 0. Must be 1 if recurrence_type = 4.
216 until Date Inclusive end date of a sequence. May be present only if recurrence_type > 0. The sequence has no end date if recurrence_type > 0 and this field is not present. Note: since this is a Date, the entire day after the midnight specified by the value is included.
222 occurrences Number Specifies how often a recurrence should appear. May be present only if recurrence_type > 0.
401 full_time Boolean True if the appointment is a whole day appointment, false otherwise.
402 shown_as Number Describes, how this appointment appears in availability queries:
1 reserved
2 temporary
3 absent
4 free
ignore_conflicts Boolean Ignore soft conflicts for the new or modified appointment. This flag is valid for the current change only, i. e. it is not stored in the database and is never sent by the server to the client.