presenceSubscription
Applies to: Skype for Business 2015
Represents the subscription to a user-defined set of contacts.
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 allows the application to keep track of members of the subscription. Updates include presence, location, or note changes for a specific contact.Additionally, an update on the event channel will inform the application that the subscription is about to expire. The application can then elect to refresh the subscription.Unlike group, presenceSubscription is not persistent and is typically relevant only for a short duration.
Properties
| Name | Description |
|---|---|
| id | The ID for this presence subscription. The ID is unique for this application. |
Links
This resource can have the following relationships.
| Link | Description |
|---|---|
| self | The link to the current resource. |
| addToPresenceSubscription | Represents the capability to add contacts to a presenceSubscription. |
| memberships | The memberships resource. |
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 |
|---|---|---|
| User.ReadWrite | Read/write Skype user information | Allows the app to read and update presence, photo, location, note, call forwarding settings of the signed-in user |
Events
Added
| Resource | Priority | Sender | Reason |
|---|---|---|---|
| presenceSubscription | Medium | people | Delivered when the presence subscription resource is added. |
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" : "people", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/people", "events" : [ { "link" : { "rel" : "presenceSubscription", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription" }, "type" : "added" } ] } ] }
Updated
| Resource | Priority | Sender | Reason |
|---|---|---|---|
| presenceSubscription | Medium | people | Delivered when the presence subscription resource 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" : "people", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/people", "events" : [ { "link" : { "rel" : "presenceSubscription", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription" }, "type" : "updated" } ] } ] }
Deleted
| Resource | Priority | Sender | Reason |
|---|---|---|---|
| presenceSubscription | Medium | people | Delivered when the presence subscription resource is deleted. |
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" : "people", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/people", "events" : [ { "link" : { "rel" : "presenceSubscription", "href" : "https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription" }, "type" : "deleted" } ] } ] }
Operations
GET
Returns a representation of the subscription to a user-defined set of contacts.
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 |
|---|---|---|---|
| Forbidden | 403 | None | The user does not have sufficient privileges to access or modify a presence subscription that was created by the system. |
| Forbidden | 403 | None | The user does not have sufficient privileges to access the contact list. |
| Forbidden | 403 | None | The user does not have sufficient privileges to access pending contacts |
| 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/presenceSubscription 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: 311
{
"rel" : "presenceSubscription",
"id" : "3",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription"
},
"addToPresenceSubscription" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription/addToPresenceSubscription"
},
"memberships" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription/memberships"
}
}
}
XML Request
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription 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: 490
<?xml version="1.0" encoding="utf-8"?>
<resource rel="presenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<link rel="addToPresenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription/addToPresenceSubscription" />
<link rel="memberships" href="/ucwa/v1/applications/192/presenceSubscription/memberships" />
<property name="rel">presenceSubscription</property>
<property name="id">3</property>
</resource>
POST
Extends an existing subscription to a user-defined set of contacts.
Query parameters
| Name | Description | Required? |
|---|---|---|
| duration | The desired length of the subscription in minutes.If this is a new subscription, the length will be used.If it is an existing subscription, the length will be added to the remaining duration. If this sum is greater than 30 minutes, 30 minutes will be used.The maximum value is 30 and the minimum value is 10 | Yes |
Request body
| Name | Description | Required? |
|---|---|---|
| duration | The desired length of the subscription in minutes.If this is a new subscription, the length will be used.If it is an existing subscription, the length will be added to the remaining duration. If this sum is greater than 30 minutes, 30 minutes will be used.The maximum value is 30 and the minimum value is 10 | Yes |
Response body
| Item | Description |
|---|---|
| presenceSubscription | Represents the subscription to a user-defined set of contacts. |
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 |
|---|---|---|---|
| Forbidden | 403 | None | The user does not have sufficient privileges to access or modify a presence subscription that was created by the system. |
| Forbidden | 403 | None | The user does not have sufficient privileges to modify the contact list. |
| Conflict | 409 | None | Conflict occurs when the resource is not in the proper state to accept the request. |
| Forbidden | 403 | None | The user does not have sufficient privileges to access or set delegates |
| Forbidden | 403 | None | The user does not have sufficient privileges to access or expand Distribution Groups |
| ServiceFailure | 500 | CallbackChannelError | The remote event channel is not reachable |
| 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
Only server-supplied query parameters, if any, are shown in the request sample.
JSON Request
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription 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 201 Created
Content-Type: application/json
Content-Length: 311
{
"rel" : "presenceSubscription",
"id" : "3",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription"
},
"addToPresenceSubscription" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription/addToPresenceSubscription"
},
"memberships" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription/memberships"
}
}
}
XML Request
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription 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 201 Created
Content-Type: application/xml
Content-Length: 490
<?xml version="1.0" encoding="utf-8"?>
<resource rel="presenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<link rel="addToPresenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription/addToPresenceSubscription" />
<link rel="memberships" href="/ucwa/v1/applications/192/presenceSubscription/memberships" />
<property name="rel">presenceSubscription</property>
<property name="id">3</property>
</resource>
DELETE
Deletes an existing subscription to a user-defined set of contacts.
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 |
|---|---|---|---|
| Forbidden | 403 | None | The user does not have sufficient privileges to access or modify a presence subscription that was created by the system. |
| Gone | 410 | CannotRedirect | Cannot redirect since there is no back up pool configured. |
Examples
JSON Request
Delete https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
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 204 No Content
XML Request
Delete https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
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 204 No Content