ms:rtc:saas:application
- JSON
Represents your real-time communication application.
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
This resource represents an application on one of the user's devices. This resource is used as entry point to start to communicate and collaborate. The application gives all supported capabilities and embeds the resources associated with the following relationships: me, people, ms:rtc:saas:communication, onlineMeetings.The application resource will expire if the application remains idle (i.e. no HTTP requests are received for a period of time from the application) for a certain amount of time. The expiration time varies depending upon whether the application makes use of the event channel (by issuing pending GETs on events) or not.
Properties
None
Links
This resource can have the following relationships.
| Link | Description |
|---|---|
| self | The link to the current resource. |
| ms:rtc:saas:anonApplicationTokens | Resource to create anonymous application tokens. |
| ms:rtc:saas:communication | Represents the dashboard for communication capabilities. |
Operations
Returns a representation of an application.
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.
Terminates the running application. This operation will tear down all active communications and subscriptions, ultimately signing the application out.
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.