Edit

leaders

  • Article

Applies to: Skype for Business 2015

Represents a view of the participants in the leader role in an onlineMeeting.

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.

Properties

None

This resource can have the following relationships.

Link Description
self The link to the current resource.
participant Represents a remote participant in a conversation.

Azure Active Directory scopes for online applications

The user must have at least one of these scopes for operations on the resource to be allowed.

Scope Permission Description
Conversations.Receive Receive conversation invites Allows the app to receive instant messages, audio, video, and desktop sharing invitations on-behalf of the signed-in user

Events

Added

Resource Priority Sender Reason
participant High conversation Indicates that a participant was added to the list of leader participants.

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=1"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
          },
          "in" : {
            "rel" : "leaders",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/leaders"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Updated

Resource Priority Sender Reason
participant High conversation Delivered when the participant resource in leaders is updated.

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=1"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
          },
          "in" : {
            "rel" : "leaders",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/leaders"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Deleted

Resource Priority Sender Reason
participant High conversation Indicates that a participant was removed from the list of leader participants.

For example, the participant was demoted to attendee or left the onlineMeeting.Please note that if the participant leaves the onlineMeeting, a deleted event will be fired by this participant to indicate the application can release any cached information regarding this participant.

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=1"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "conversation",
      "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137",
      "events" : [
        {
          "link" : {
            "rel" : "participant",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/participants/196"
          },
          "in" : {
            "rel" : "leaders",
            "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/leaders"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

GET

Returns a representation of a view of the participants whose role is leader in an onlineMeeting.

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 Invalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict 409 AlreadyExists The already exists error.
Conflict 409 TooManyGroups The too many groups error.
Conflict 409 None Un-supported Service/Resource/API error.
Gone 410 CannotRedirect Cannot redirect since there is no back up pool configured.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/leaders HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json

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.

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 214
{
  "rel" : "leaders",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/192/communication/conversations/137/leaders"
    },
    "participant" : [
      {
        "href" : "/ucwa/v1/applications/192/communication/conversations/137/participants/192"
      }
    ]
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/communication/conversations/137/leaders HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml

XML Response

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 347
<?xml version="1.0" encoding="utf-8"?>
<resource rel="leaders" href="/ucwa/v1/applications/192/communication/conversations/137/leaders" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="participant" href="/ucwa/v1/applications/192/communication/conversations/137/participants/759" />
  <property name="rel">leaders</property>
</resource>