Table of contents
me
to
TOC
Collapse the table of content
Expand the table of content

memberships

John Austin|Last Updated: 11/11/2016
|
2 Contributors

Applies to: Skype for Business 2015

        The memberships resource.

For more on web links, see Web links.

NameDescription
relThe resource that this link points to. In JSON, this is the outer container.
hrefThe location of this resource on the server, and the target of an HTTP operation.

Properties

None

This resource can have the following relationships.

LinkDescription
selfThe link to the current resource.
presenceSubscriptionMembershipRepresents the presenceSubscription membership of a single contact.

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.

ScopePermissionDescription
User.ReadWriteRead/write Skype user informationAllows the app to read and update presence, photo, location, note, call forwarding settings of the signed-in user

Operations

GET

Operation description coming soon...

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.

ErrorCodeSubcodeDescription
Forbidden403NoneThe user does not have sufficient privileges to access or modify presence subscription memberships.
Forbidden403NoneThe user does not have sufficient privileges to access the contact list.
Forbidden403NoneThe user does not have sufficient privileges to access pending contacts
ServiceFailure500InvalidExchangeServerVersionInvalid exchange server version.The exchange mailbox of the server might have moved to an unsupported version for the required feature.
Conflict409AlreadyExistsThe already exists error.
Conflict409TooManyGroupsThe too many groups error.
Conflict409NoneUn-supported Service/Resource/API error.
Gone410CannotRedirectCannot redirect since there is no back up pool configured.

Examples

JSON Request

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

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: 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"
          }
        }
      }
    ]
  }
}

XML Request

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

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: 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>

POST

Operation description coming soon...

Request body

NameDescriptionRequired?
contactUrisThe URIs of the users whose presence is to be subscribed to.Array of StringYes

Response body

ItemDescription
presenceSubscriptionMembershipsA collection of presenceSubscriptionMembership resources.

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.

ErrorCodeSubcodeDescription
Forbidden403NoneThe user does not have sufficient privileges to access or modify presence subscription memberships.
Forbidden403LimitExceededThe subscription limit was exceeded.
Forbidden403NoneThe user does not have sufficient privileges to modify the contact list.
Conflict409NoneConflict occurs when the resource is not in the proper state to accept the request.
Forbidden403NoneThe user does not have sufficient privileges to access or set delegates
Forbidden403NoneThe user does not have sufficient privileges to access or expand Distribution Groups
ServiceFailure500CallbackChannelErrorThe remote event channel is not reachable
Conflict409AlreadyExistsThe already exists error.
Conflict409TooManyGroupsThe too many groups error.
Conflict409NoneUn-supported Service/Resource/API error.
Gone410CannotRedirectCannot redirect since there is no back up pool configured.

Examples

JSON Request

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
{
  &quot;contactUris&quot; : [
    &quot;\&quot;sip : user2@microsoft.com\&quot;&quot;,
    &quot;\&quot;sip : user3@microsoft.com\&quot;&quot;
  ]
}

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: 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"
          }
        }
      }
    ]
  }
}

XML Request

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
&lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt;
&lt;input xmlns=&quot;http://schemas.microsoft.com/rtc/2012/03/ucwa&quot;&gt;
  &lt;propertyList name=&quot;contactUris&quot;&gt;
    &lt;item&gt;&quot;sip:user2@microsoft.com&quot;&lt;/item&gt;
    &lt;item&gt;&quot;sip:user3@microsoft.com&quot;&lt;/item&gt;
  &lt;/propertyList&gt;
&lt;/input&gt;

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: 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>
© 2017 Microsoft