Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

Represents a recurring event.

The MeetingSeries contains recurrence information, the default values of the meeting attributes, and the list of meeting instances.

Members

Name Type Required Description

attachedMarkers

marker[]

Set of marker elements associated with the entity.

attachedReminders

reminder[]

List of reminders attached to the entity

attachedSubscriptions

subscription[]

List of subscriptions attached to the entity

attachments

anyType[]

Attachments of the meeting.

collabId

beeId

CollabId of the snapshot

createdOn

dateTime

Entity's creation date

creator

actor

The actor that created this entity

deleted

boolean

Deletion flag. If this property is set to true the entity is deleted.

duration

duration

Default duration of the meeting instances.

invitationOnly

boolean

True if the meeting is not the organizer's copy. When a meeting is created by the organizer, copied if the meeting are delivered to the participants' default calendars.

The organizer's copy of the meeting has the element InvitationOnly set to false, the other participant's have InvitationOnly set to true.

If InvitationOnly is set to true, then only the following elements may be updated:

  1. InviteeTransparency
  2. InviteeParticipationStatus
  3. InviteePrimaryClientReminderTrigger
  4. InviteePriority
  5. InviteeProperties
The meeting's elements that are global to all the participants can only be updated in the organizer's copy of the meeting.

invitee

participant

Invitee that owns this copy of the meeting.

inviteeEffectiveTransparency

transparency

Transparency of this meeting. This attribute determine the impact of this meeting on the freebusy of the invitee.

inviteeParticipantStatus

occurrenceParticipantStatus

Participation status if the Invitee. When invited to a meeting this attribute is initialy set to NEEDS_ACTION. The invitee must update this attribute to inform the organizer if his attendence status.

inviteePriority

priority

Priority of the meeting for invitee.

inviteeProperties

collabProperties

Properties private to this copy of the meeting.

locationName

string

Name of the location of the meeting.

meetings

meeting[]

List of meeting instances associociated with this MeetingSeries.

modifiedBy

actor

The actor that last modified the entity

modifiedOn

dateTime

The date when entity was last modified

name

string

Name of the entity.

onlineConference

conference

Online conference associated with the meeting.

onlineConferenceJoinURL

string

URI that may be used to join the Online Conference associated with the meeting.

organizer

participant

Organizer of the meeting.

parent

entity

The parent for this entity.

participants

meetingParticipant[]

Participants of the meeting.

properties

collabProperties

The properties of the artifact that are shared among all the actors

recurrenceRule

string

Recurrence rule of the series. Must follow the RECUR value type format as defined in RFC25545.

recurrenceStart

dateTime

For recurring meeting, this attribute must be set to the start time of the first instance of the RecurrenceRule.

recurrenceStartDateOnly

boolean

True if the "RecurrenceStart" attribute refers to a date only value (time of day can be ignored). Set to true for HOLIDAY and DAY_EVENT.

sensitivity

sensitivity

Sensitivity of the meeting.

snapshotId

string

Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

status

occurrenceStatus

Status of the meeting.

textDescription

string

Description of the meeting in plain text format.

type

occurrenceType

Type of the meeting.

xhtmlFragmentDescription

string

Description of the meeting in XHTML fragment representation. This string is an xHTML fragment that must respect the following guidelines:

The value is composed of only XHTML fragments (with a limited set of elements/styles) in richtext attributes. The header:

And footer:

must be omitted from the attribute value. We can imply that

  1. the character encoding is always UCS-2, i.e. we use Java strings for richtext attributes;
  2. the schema is always our subset of XHTML;
  3. styles allowed are a subset of CSS2; d) we don't need the "head" section (no "title", "meta"s, "link"s, etc.);
  4. we leave body element to have a place to put formatting common for the entire fragment (e.g. "font" or "background-color").

Hierarchy

Inherits From

Applied Markers

Examples

Below are examples in JSON and XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:meetingSeries xsi:type="obh:meetingSeries" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:attachedMarkers>your_marker_0</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_1</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_2</obh:attachedMarkers>
        <obh:attachedReminders>your_reminder_0</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_1</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_2</obh:attachedReminders>
        <obh:attachedSubscriptions>your_subscription_0</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_1</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_2</obh:attachedSubscriptions>
        <obh:attachments>your_anyType_0</obh:attachments>
        <obh:attachments>your_anyType_1</obh:attachments>
        <obh:attachments>your_anyType_2</obh:attachments>
        <obh:collabId>your_beeId_0</obh:collabId>
        <obh:createdOn>your_dateTime_0</obh:createdOn>
        <obh:creator>your_actor_0</obh:creator>
        <obh:deleted>your_boolean_0</obh:deleted>
        <obh:duration>your_duration_0</obh:duration>
        <obh:invitationOnly>your_boolean_0</obh:invitationOnly>
        <obh:invitee>your_participant_0</obh:invitee>
        <obh:inviteeEffectiveTransparency>your_transparency_0</obh:inviteeEffectiveTransparency>
        <obh:inviteeParticipantStatus>your_occurrenceParticipantStatus_0</obh:inviteeParticipantStatus>
        <obh:inviteePriority>your_priority_0</obh:inviteePriority>
        <obh:inviteeProperties>your_collabProperties_0</obh:inviteeProperties>
        <obh:locationName>your_string_0</obh:locationName>
        <obh:meetings>your_meeting_0</obh:meetings>
        <obh:meetings>your_meeting_1</obh:meetings>
        <obh:meetings>your_meeting_2</obh:meetings>
        <obh:modifiedBy>your_actor_0</obh:modifiedBy>
        <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
        <obh:name>your_string_0</obh:name>
        <obh:onlineConference>your_conference_0</obh:onlineConference>
        <obh:onlineConferenceJoinURL>your_string_0</obh:onlineConferenceJoinURL>
        <obh:organizer>your_participant_0</obh:organizer>
        <obh:parent>your_entity_0</obh:parent>
        <obh:participants>your_meetingParticipant_0</obh:participants>
        <obh:participants>your_meetingParticipant_1</obh:participants>
        <obh:participants>your_meetingParticipant_2</obh:participants>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:recurrenceRule>your_string_0</obh:recurrenceRule>
        <obh:recurrenceStart>your_dateTime_0</obh:recurrenceStart>
        <obh:recurrenceStartDateOnly>your_boolean_0</obh:recurrenceStartDateOnly>
        <obh:sensitivity>your_sensitivity_0</obh:sensitivity>
        <obh:snapshotId>your_string_0</obh:snapshotId>
        <obh:status>your_occurrenceStatus_0</obh:status>
        <obh:textDescription>your_string_0</obh:textDescription>
        <obh:type>your_occurrenceType_0</obh:type>
        <obh:xhtmlFragmentDescription>your_string_0</obh:xhtmlFragmentDescription>
</obh:meetingSeries>

JSON Example

(show inherited members)

{
    "beeType":"meetingSeries",
        "attachedMarkers":[
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
        ],
        "attachedReminders":[
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
        ],
        "attachedSubscriptions":[
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
        ],
        "attachments":[
            "your_{http://www.oracle.com/beehive}attachments_as_anyType0",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType1",
            "your_{http://www.oracle.com/beehive}attachments_as_anyType2"
        ],
        "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
        "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
        "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
        "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
        "duration":"your_{http://www.oracle.com/beehive}duration_as_duration0",
        "invitationOnly":your_{http://www.oracle.com/beehive}invitationOnly_as_boolean0,
        "invitee":{ your_{http://www.oracle.com/beehive}invitee_as_participant0 },
        "inviteeEffectiveTransparency":{ your_{http://www.oracle.com/beehive}inviteeEffectiveTransparency_as_transparency0 },
        "inviteeParticipantStatus":{ your_{http://www.oracle.com/beehive}inviteeParticipantStatus_as_occurrenceParticipantStatus0 },
        "inviteePriority":{ your_{http://www.oracle.com/beehive}inviteePriority_as_priority0 },
        "inviteeProperties":{ your_{http://www.oracle.com/beehive}inviteeProperties_as_collabProperties0 },
        "locationName":"your_{http://www.oracle.com/beehive}locationName_as_string0",
        "meetings":[
            { your_{http://www.oracle.com/beehive}meetings_as_meeting0 },
            { your_{http://www.oracle.com/beehive}meetings_as_meeting1 },
            { your_{http://www.oracle.com/beehive}meetings_as_meeting2 }
        ],
        "modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
        "modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "onlineConference":{ your_{http://www.oracle.com/beehive}onlineConference_as_conference0 },
        "onlineConferenceJoinURL":"your_{http://www.oracle.com/beehive}onlineConferenceJoinURL_as_string0",
        "organizer":{ your_{http://www.oracle.com/beehive}organizer_as_participant0 },
        "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
        "participants":[
            { your_{http://www.oracle.com/beehive}participants_as_meetingParticipant0 },
            { your_{http://www.oracle.com/beehive}participants_as_meetingParticipant1 },
            { your_{http://www.oracle.com/beehive}participants_as_meetingParticipant2 }
        ],
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "recurrenceRule":"your_{http://www.oracle.com/beehive}recurrenceRule_as_string0",
        "recurrenceStart":"your_{http://www.oracle.com/beehive}recurrenceStart_as_dateTime0",
        "recurrenceStartDateOnly":your_{http://www.oracle.com/beehive}recurrenceStartDateOnly_as_boolean0,
        "sensitivity":{ your_{http://www.oracle.com/beehive}sensitivity_as_sensitivity0 },
        "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
        "status":{ your_{http://www.oracle.com/beehive}status_as_occurrenceStatus0 },
        "textDescription":"your_{http://www.oracle.com/beehive}textDescription_as_string0",
        "type":{ your_{http://www.oracle.com/beehive}type_as_occurrenceType0 },
        "xhtmlFragmentDescription":"your_{http://www.oracle.com/beehive}xhtmlFragmentDescription_as_string0"
}

XML Schema


<xs:complexType name="meetingSeries">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attachments" type="xs:anyType"/>
                <xs:element minOccurs="0" name="duration" type="xs:duration"/>
                <xs:element name="invitationOnly" type="xs:boolean"/>
                <xs:element minOccurs="0" name="invitee" type="tns:participant"/>
                <xs:element minOccurs="0"
                    name="inviteeEffectiveTransparency" type="tns:transparency"/>
                <xs:element minOccurs="0"
                    name="inviteeParticipantStatus" type="tns:occurrenceParticipantStatus"/>
                <xs:element minOccurs="0" name="inviteePriority" type="tns:priority"/>
                <xs:element minOccurs="0" name="inviteeProperties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="locationName" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="meetings" type="tns:meeting"/>
                <xs:element minOccurs="0" name="onlineConference" type="tns:conference"/>
                <xs:element minOccurs="0" name="onlineConferenceJoinURL" type="xs:string"/>
                <xs:element minOccurs="0" name="organizer" type="tns:participant"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="participants" type="tns:meetingParticipant"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="recurrenceRule" type="xs:string"/>
                <xs:element minOccurs="0" name="recurrenceStart" type="xs:dateTime"/>
                <xs:element name="recurrenceStartDateOnly" type="xs:boolean"/>
                <xs:element minOccurs="0" ref="tns:sensitivity"/>
                <xs:element minOccurs="0" name="status" type="tns:occurrenceStatus"/>
                <xs:element minOccurs="0" name="textDescription" type="xs:string"/>
                <xs:element minOccurs="0" name="type" type="tns:occurrenceType"/>
                <xs:element minOccurs="0"
                    name="xhtmlFragmentDescription" type="xs:string"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to meetingSeries

Referenced By Resources

Usage Resource Method
Response MeetingSeries Create
Response MeetingSeries Read
Response MeetingSeries Read Batch
Request MeetingSeries Read Batch
Response MeetingSeries Update

Referenced By Representaions