ms:rtc:saas:participant

JSON

Represents a remote participant in a 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.
title	The display name or normalized phone number of the participant, if available.

Resource description

A participant resource is the transient representation of a contact that captures attributes such as role and capabilities (e.g. promoting to leader or admitting from lobby). A participant's lifetime is controlled by the server and starts when the participant is present upon joining an ms:rtc:saas:onlineMeeting or added later on to a ms:rtc:saas:conversation. This resource is removed when the participant leaves the ms:rtc:saas:conversation.

Properties

Name	Description
anonymous	Whether the participant is anonymous.
name	The participant's display name.
organizer	Whether the participant is an organizer. An organizer can never be locked out of her own meeting.
role	The participant's role (Role), such as Attendee or Leader.
sourceNetwork	The participant's source network (SourceNetwork), such as SameEnterprise or PublicCloud (for example, a Skype contact).
uri	The participant's URI.

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:eject	Ejects the corresponding ms:rtc:saas:participant from the ms:rtc:saas:onlineMeeting.
ms:rtc:saas:participantMessaging	Used to determine a participant using the instant messaging modality in a conversation.
ms:rtc:saas:reject	Denies the corresponding ms:rtc:saas:participant access to the ms:rtc:saas:onlineMeeting.

Events

added
updated
deleted

Resource	Priority	Sender	Reason
ms:rtc:saas:participant	High	ms:rtc:saas:conversation	Indicates that the ms:rtc:saas:participant has joined the ms:rtc:saas:conversation. The application can choose to retrieve the updated information. information. If an application caches conversation data, the application should rely on this event to decide whether to update the conversation cache. The application will receive this event when the participant is first added to the conversation. Other added events for the same participant indicate that the participant has been admitted to the conference, promoted, demoted, or is typing a message.

Resource

Priority

Sender

Reason

ms:rtc:saas:participant

High

ms:rtc:saas:conversation

Indicates that the ms:rtc:saas:participant has joined the ms:rtc:saas:conversation. The application can choose to retrieve the updated information. information.

If an application caches conversation data, the application should rely on this event to decide whether to update the conversation cache. The application will receive this event when the participant is first added to the conversation. Other added events for the same participant indicate that the participant has been admitted to the conference, promoted, demoted, or is typing a message.

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=99"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=99"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participant",
            "href" : "communication/conversations/948/participants/631"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:participant	High	ms:rtc:saas:conversation	Indicates that the ms:rtc:saas:participant has been updated. The application can choose to retrieve the updated information.

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=2"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=2"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participant",
            "href" : "communication/conversations/948/participants/631"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:participant	High	ms:rtc:saas:conversation	Indicates that the ms:rtc:saas:participant has left a ms:rtc:saas:conversation.

Sample of returned event data.

{
  "_links" : {
    "self" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=56"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=56"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:participant",
            "href" : "communication/conversations/948/participants/631"
          },
          "type" : "deleted"
        }
      ]
    }
  ]
}

Operations

Returns a representation of the participant resource.

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.