memberships
Applies to: Skype for Business 2015
The memberships resource.
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. |
None
This resource can have the following relationships.
Link | Description |
---|---|
self | The link to the current resource. |
presenceSubscriptionMembership | Represents the presenceSubscription membership of a single contact. |
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 |
Operation description coming soon...
None
The response from a GET request contains the properties and links shown in the Properties and Links sections at the top of this page.
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 presence subscription memberships. |
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. |
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription/memberships HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/json
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: 473
{
"rel" : "presenceSubscriptionMemberships",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscriptionMemberships"
}
},
"_embedded" : {
"presenceSubscriptionMembership" : [
{
"rel" : "presenceSubscriptionMembership",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscriptionMemberships/ads-bes2asd,john@contoso.com"
},
"contact" : {
"href" : "/ucwa/v1/applications/192/people/282"
},
"presenceSubscription" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription"
}
}
}
]
}
}
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription/memberships HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Accept: application/xml
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: 648
<?xml version="1.0" encoding="utf-8"?>
<resource rel="presenceSubscriptionMemberships" href="/ucwa/v1/applications/192/presenceSubscriptionMemberships" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<property name="rel">presenceSubscriptionMemberships</property>
<resource rel="presenceSubscriptionMembership" href="/ucwa/v1/applications/192/presenceSubscriptionMemberships/ads-bes2asd,john@contoso.com">
<link rel="contact" href="/ucwa/v1/applications/192/people/282" />
<link rel="presenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription" />
<property name="rel">presenceSubscriptionMembership</property>
</resource>
</resource>
Operation description coming soon...
Name | Description | Required? |
---|---|---|
contactUris | The URIs of the users whose presence is to be subscribed to.Array of String | Yes |
Item | Description |
---|---|
presenceSubscriptionMemberships | A collection of presenceSubscriptionMembership resources. |
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 presence subscription memberships. |
Forbidden | 403 | LimitExceeded | The subscription limit was exceeded. |
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. |
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription/memberships HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/json
Accept: application/json
Content-Length: 77
{
"contactUris" : [
"\"sip : user2@microsoft.com\"",
"\"sip : user3@microsoft.com\""
]
}
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: 473
{
"rel" : "presenceSubscriptionMemberships",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscriptionMemberships"
}
},
"_embedded" : {
"presenceSubscriptionMembership" : [
{
"rel" : "presenceSubscriptionMembership",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/presenceSubscriptionMemberships/ads-bes2asd,john@contoso.com"
},
"contact" : {
"href" : "/ucwa/v1/applications/192/people/282"
},
"presenceSubscription" : {
"href" : "/ucwa/v1/applications/192/presenceSubscription"
}
}
}
]
}
}
Post https://fe1.contoso.com:443/ucwa/v1/applications/192/presenceSubscription/memberships HTTP/1.1
Authorization: Bearer cwt=PHNhbWw6QXNzZXJ0aW9uIHhtbG5...uZm8
Host: fe1.contoso.com
Content-Type: application/xml
Accept: application/xml
Content-Length: 231
<?xml version="1.0" encoding="utf-8"?>
<input xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<propertyList name="contactUris">
<item>"sip:user2@microsoft.com"</item>
<item>"sip:user3@microsoft.com"</item>
</propertyList>
</input>
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: 648
<?xml version="1.0" encoding="utf-8"?>
<resource rel="presenceSubscriptionMemberships" href="/ucwa/v1/applications/192/presenceSubscriptionMemberships" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<property name="rel">presenceSubscriptionMemberships</property>
<resource rel="presenceSubscriptionMembership" href="/ucwa/v1/applications/192/presenceSubscriptionMemberships/ads-bes2asd,john@contoso.com">
<link rel="contact" href="/ucwa/v1/applications/192/people/282" />
<link rel="presenceSubscription" href="/ucwa/v1/applications/192/presenceSubscription" />
<property name="rel">presenceSubscriptionMembership</property>
</resource>
</resource>