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

Contents

Overview

Represents a snapshot of an OccurrenceParticipant object.

For each participant, we include their status, role and private properties.

Members

Name Type Required Description

address

string

Return an alternative address of the internal participant or the address of the external participant.

deliveryChannels

participantDeliveryChannel[]

Get the DeliveryChannels attribute of the OccurrenceParticipant. This represents how the participant is to be notified of their invitation. Note that this is seperate from the DeliveryChannels that User Subscription Service uses to send notifications, and is meant for participants that User Subscription does not service (i.e. external participants). Also note, that this attribute is always an empty set when the participant is returned in an invitation or invitation series.

deliveryResults

participantDeliveryResult[]

Get the ParticipantDeliveryResults.

directlyInvited

boolean

Get the DirectlyInvited attribute of the OccurrenceParticipant.

The DirectlyInvited attribute allows for the distinction of direct invitation and invitation via group membership or delegation.

joinInfo

string

Get the join information for the associated online conference. Currently we set the join info only for the OnlineConferenceOccurrenceParticipant. The join info is promoted directly to the OccurrenceParticipant because in the future it will be useful for other participants as well (e.g., meeting place id/psw, the code to unlock the door of a conference room, ...).

name

string

Return the name of the Participant

participant

anyType

(constrained to Addressable)

Return the Addressable of the participant.

participantStatus

occurrenceParticipantStatus

Get the status of the OccurrenceParticipant.

properties

collabProperties

Get the properties of the OccurrenceParticipant.

role

participantRole

Get the OccurrenceParticipant's role.

rsvp

boolean

Get the RSVP of the OccurrenceParticipant.

status

occurrenceParticipantStatus

Hierarchy

Inherits From

Inherited By

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:occurrenceParticipant xsi:type="obh:occurrenceParticipant" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:address>your_string_0</obh:address>
        <obh:deliveryChannels>your_participantDeliveryChannel_0</obh:deliveryChannels>
        <obh:deliveryChannels>your_participantDeliveryChannel_1</obh:deliveryChannels>
        <obh:deliveryChannels>your_participantDeliveryChannel_2</obh:deliveryChannels>
        <obh:deliveryResults>your_participantDeliveryResult_0</obh:deliveryResults>
        <obh:deliveryResults>your_participantDeliveryResult_1</obh:deliveryResults>
        <obh:deliveryResults>your_participantDeliveryResult_2</obh:deliveryResults>
        <obh:directlyInvited>your_boolean_0</obh:directlyInvited>
        <obh:joinInfo>your_string_0</obh:joinInfo>
        <obh:name>your_string_0</obh:name>
        <obh:participant>your_anyType_0</obh:participant>
        <obh:participantStatus>your_occurrenceParticipantStatus_0</obh:participantStatus>
        <obh:properties>your_collabProperties_0</obh:properties>
        <obh:role>your_participantRole_0</obh:role>
        <obh:rsvp>your_boolean_0</obh:rsvp>
        <obh:status>your_occurrenceParticipantStatus_0</obh:status>
</obh:occurrenceParticipant>

JSON Example

(show inherited members)

{
    "beeType":"occurrenceParticipant",
        "address":"your_{http://www.oracle.com/beehive}address_as_string0",
        "deliveryChannels":[
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel0 },
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel1 },
            { your_{http://www.oracle.com/beehive}deliveryChannels_as_participantDeliveryChannel2 }
        ],
        "deliveryResults":[
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult0 },
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult1 },
            { your_{http://www.oracle.com/beehive}deliveryResults_as_participantDeliveryResult2 }
        ],
        "directlyInvited":your_{http://www.oracle.com/beehive}directlyInvited_as_boolean0,
        "joinInfo":"your_{http://www.oracle.com/beehive}joinInfo_as_string0",
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "participant":"your_{http://www.oracle.com/beehive}participant_as_anyType0",
        "participantStatus":{ your_{http://www.oracle.com/beehive}participantStatus_as_occurrenceParticipantStatus0 },
        "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
        "role":{ your_{http://www.oracle.com/beehive}role_as_participantRole0 },
        "rsvp":your_{http://www.oracle.com/beehive}rsvp_as_boolean0,
        "status":{ your_{http://www.oracle.com/beehive}status_as_occurrenceParticipantStatus0 }
}

XML Schema


<xs:complexType name="occurrenceParticipant">
    <xs:complexContent>
        <xs:extension base="tns:baseParticipant">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="deliveryChannels" nillable="true" type="tns:participantDeliveryChannel"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="deliveryResults" nillable="true" type="tns:participantDeliveryResult"/>
                <xs:element name="directlyInvited" type="xs:boolean"/>
                <xs:element minOccurs="0" name="joinInfo" type="xs:string"/>
                <xs:element minOccurs="0" name="participantStatus" type="tns:occurrenceParticipantStatus"/>
                <xs:element minOccurs="0" name="properties" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="role" type="tns:participantRole"/>
                <xs:element name="rsvp" type="xs:boolean"/>
                <xs:element minOccurs="0" name="status" type="tns:occurrenceParticipantStatus"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to occurrenceParticipant

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions