ms:rtc:saas:onlineMeeting

JSON

Represents a read-only version of the ms:rtc:saas:onlineMeeting associated with this ms:rtc:saas:conversation.

Web link

For more on web links, see Web Links.

Name	Description
rel	The resource that this link points to. In JSON, this is the outer container.
href	The location of this resource on the server, and the target of an HTTP operation.

Resource description

The resource captures information about the meeting including the join URL, the attendees list, and the description.

Properties

Name	Description
accessLevel	The access level that controls admission to the online meeting.
attendees	The list of online meeting attendees.
automaticLeaderAssignment	The policy that determines which participants are automatically promoted to leaders. An online meeting organizer can schedule a meeting so that users are automatically promoted to the leader role when they join the meeting. For example, if the meeting is scheduled with automatic promotion policy set to AutomaticLeaderAssignment.SameEnterprise, then any participants from the organizer's company are automatically promoted to leaders when they join the meeting. Conference leaders can still promote specific users to the leader role, including anonymous users.
conferenceId	The conference ID for the online meeting. Attendees who dial into the online meeting by using a PSTN phone use the conference ID.
description	The long description of the online meeting's purpose.
disclaimerBody	The online meeting's disclaimer text.
disclaimerTitle	The online meeting's disclaimer title.
expirationTime	The absolute Coordinated Universal Time (UTC) date and time after which the online meeting can be deleted. The day and time must be between one year before, and ten years after, the current date and time on the server.
hostingNetwork	The online meeting's hosting network.
joinUrl	The URL that is used when the online meeting is joined from the web.
largeMeeting	Whether large meeting mode is enabled or disabled for this online meeting.
leaders	The list of online meeting leaders. The organizer will automatically be added to the leaders list.
onlineMeetingId	The online meeting ID that identifies this meeting among the other online meetings that are scheduled by the organizer. The online meeting ID is unique within the organizer's list of scheduled online meetings.
onlineMeetingUri	The online meeting URI. The online meeting URI is used by participants to join this online meeting.
organizerName	The display name of the contact who scheduled the online meeting.
organizerUri	The URI of the online meeting organizer: the person who scheduled the meeting. Organizers can enumerate or change only the conferences that they organize.
subject	The subject of the online meeting.

Links

This resource can have the following relationships.

Link	Description
self	The link to the current resource.
ms:rtc:saas:conversation	Represents the local participant's perspective on a multi-modal, multi-party communication.
ms:rtc:saas:terminateOnlineMeeting	Terminates the currently attended meeting.

Events

added
updated

Resource	Priority	Sender	Reason
ms:rtc:saas:onlineMeeting	High	ms:rtc:saas:conversation	Indicates that the corresponding onlineMeeting has been added to a conversation.

Resource

Priority

Sender

Reason

ms:rtc:saas:onlineMeeting

High

ms:rtc:saas:conversation

Indicates that the corresponding onlineMeeting has been added to a conversation.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=22"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=22"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:onlineMeeting",
            "href" : "communication/conversations/948/onlineMeeting"
          },
          "in" : {
            "rel" : "ms:rtc:saas:conversation",
            "href" : "communication/conversations/948"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:onlineMeeting	High	ms:rtc:saas:conversation	Indicates that the corresponding onlineMeeting has been update in a conversation.

Sample of returned event data.

This sample is given only as an illustration of event syntax. The semantic content is not guaranteed to correspond to a valid scenario.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=35"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=35"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:onlineMeeting",
            "href" : "communication/conversations/948/onlineMeeting"
          },
          "in" : {
            "rel" : "ms:rtc:saas:conversation",
            "href" : "communication/conversations/948"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Operations

Returns a read-only version of the ms:rtc:saas:onlineMeeting associated with this ms:rtc:saas:conversation.

Request body

None

Response body

The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.

Synchronous errors

The errors below (if any) are specific to this resource. Generic errors that can apply to any resource are covered in Generic synchronous errors.

Error	Code	Subcode
ServiceFailure	500	InvalidExchangeServerVersion
Conflict	409	AlreadyExists
Conflict	409	TooManyGroups
Conflict	409	None
Gone	410	CannotRedirect

Examples

Request

JSON Response

This sample is given only as an illustration of response syntax. The semantic content is not guaranteed to correspond to a valid scenario.