ms:rtc:saas:adhocMeeting
- JSON
Represents a scheduled meeting on the user's calendar.
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
These meetings can be created and managed via the API. 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. |
| 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. |
| joinUrl | The URL that is used when the online meeting is joined from the web. |
| 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. |
| 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:discover | Represents the entry point for discovering the services. |
Operations
Returns a representation of a scheduled meeting on the user's calendar.
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 | Description |
|---|---|---|---|
| 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.
Removes a scheduled meeting from the user's calendar.
Request body
None
Response body
None
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 | Description |
|---|---|---|---|
| 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.
Updates a scheduled meeting on the user's calendar.
Request body
Click here to see the input values.
| Name | Description | Required? |
|---|---|---|
| accessLevel |
The policy that indicates which users are permitted to join the online
meeting without being placed in the online meeting lobby.
Set this property to control access to the online meeting. An application should query the organizer's eligible access levels before setting this property. | No |
| attendees | A list of the participants who have the attendee role. | No |
| automaticLeaderAssignment |
The policy that indicates which participants should be automatically promoted to leader when they join the online meeting.
Leader assignments are applied when users join the online meeting. Such users are automatically promoted to the leader role. An application should query the automatic leader assignment options to see which are available to the organizer before setting this property. The request will fail if the application attempts to schedule an online meeting using a value that is not permitted. | No |
| context | Gets or sets the Context. | No |
| description | The long description of the online meeting. | No |
| expirationTime |
The absolute date and time after which the online meeting can be deleted.
The day and time must fall between one year before and ten years after the current date and time on the server. If no value is supplied, the expiry time is set to 8 hours. | No |
| key |
Gets or sets the key.
This is an optional paramter. When an application specifies this input in the adhoc meeting creation request, the following is the behavior 1) UCAP will return the same adhocMeetingUri no matter how many times the request is called for the same key - Note: - If the other properties of the input are different and only the key is the same - the other properties will be ignored - The application should do a PUT on the adhocMeeting resource to modify the other properties 2) UCAP will NOT return the following tokens if this is specified in the meeting creation request - joinAdhocMeeting token - applications token The maximum length is 32 characters. | No |
| leaders |
A list of the participants who have the leader role.
Organizers do not need to be added to the leaders list because they are automatically added to this list. | No |
| meetingType |
The meeting type - Short or Long.
Setting this property to Long will honor ExpirationTime in the request while creating a meeting. It will default to Short and will create a meeting with ExpirationTime of 8 hours. | No |
| subject | The subject of the online meeting. | Yes |
Response body
| Item | Description |
|---|---|
| ms:rtc:saas:adhocMeeting | Represents a scheduled meeting on the user's calendar. |
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 | Description |
|---|---|---|---|
| ServiceFailure | 500 | InvalidExchangeServerVersion | |
| 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.