ms:rtc:saas:localParticipant

JSON

Represents the user as a local ms:rtc:saas:participant in a specific 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

participant is the transient representation of the user that captures her attributes such as role, capabilities (e.g. promoting to leader or admitting from lobby) A localParticipant's lifetime is controlled by the server and starts when the user joins a ms:rtc:saas:conversation. It gets removed when she 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.

Events

added
updated
deleted

Resource	Priority	Sender	Reason
ms:rtc:saas:localParticipant	High	ms:rtc:saas:conversation	Indicates that the user has joined a ms:rtc:saas:conversation. The application should use this as a hint to update its conversation cache. This event is raised when the user is first added. Other added events for the same participant indicate that the user may have been admitted to the conference, promoted, demoted, or is typing a message.

Resource

Priority

Sender

Reason

ms:rtc:saas:localParticipant

High

ms:rtc:saas:conversation

Indicates that the user has joined a ms:rtc:saas:conversation.

The application should use this as a hint to update its conversation cache. This event is raised when the user is first added. Other added events for the same participant indicate that the user may have 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=39"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=39"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:localParticipant",
            "href" : "communication/conversations/948/onlineMeeting/167"
          },
          "type" : "added"
        }
      ]
    }
  ]
}

Resource	Priority	Sender	Reason
ms:rtc:saas:localParticipant	High	ms:rtc:saas:conversation	Indicates that the user has been 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=64"
    },
    "next" : {
      "href" : "http://sample:80/ucwa/v1/applications/appId/events?ack=64"
    }
  },
  "sender" : [
    {
      "rel" : "ms:rtc:saas:conversation",
      "href" : "communication/conversations/948",
      "events" : [
        {
          "link" : {
            "rel" : "ms:rtc:saas:localParticipant",
            "href" : "communication/conversations/948/onlineMeeting/167"
          },
          "type" : "updated"
        }
      ]
    }
  ]
}

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

Sample of returned event data.

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

Operations

Returns a representation of the user as a local ms:rtc:saas:participant in a specific 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.