Export (0) Print
Expand All
me
to
Expand Minimize

people (UCWA)

Last modified: June 17, 2013

Applies to: Lync Server 2013

In this article
Web link
Resource description
Operations

A hub for the people with whom the logged-on user can communicate, using Lync.

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.

This resource provides access to resources that enable the logged-on user to find, organize, communicate with, and subscribe to the presence of other people.

Properties

None

Links

This resource can have the following relationships.

Link

Description

self

The link to the current resource.

myContactsAndGroupsSubscription (UCWA)

Represents the subscription to a user's contacts and groups.

myContacts (UCWA)

A collection of contact (UCWA) resources that belong to the logged-on user.

myGroupMemberships (UCWA)

A collection of groupMembership resources, each of which uniquely links a contact to a group.

myGroups (UCWA)

A collection of groups in the contact list of the logged-on user.

myPrivacyRelationships (UCWA)

Represents the various privacy relationships that the user maintains with his or her contacts.

presenceSubscriptionMemberships (UCWA)

A collection of presenceSubscriptionMembership (UCWA) resources.

presenceSubscriptions (UCWA)

A collection of presenceSubscription (UCWA) resources.

search (UCWA)

Provides a way to search for contacts.

subscribedContacts (UCWA)

A collection of contacts for which the logged-on user has created active presence subscriptions.

GET

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 the contact list.

Examples

JSON Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/people 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: 780
{
  "rel" : "people",
  "_links" : {
    "self" : {
      "href" : "/ucwa/v1/applications/543/people"
    },
    "myContactsAndGroupsSubscription" : {
      "href" : "/ucwa/v1/applications/543/people/myContactsAndGroupsSubscription"
    },
    "myContacts" : {
      "href" : "/ucwa/v1/applications/543/contacts"
    },
    "myGroupMemberships" : {
      "href" : "/ucwa/v1/applications/543/myGroupMemberships"
    },
    "myGroups" : {
      "href" : "/ucwa/v1/applications/543/groups"
    },
    "myPrivacyRelationships" : {
      "href" : "/ucwa/v1/applications/543/myPrivacyRelationships"
    },
    "presenceSubscriptionMemberships" : {
      "href" : "/ucwa/v1/applications/543/presenceSubscriptionMemberships"
    },
    "presenceSubscriptions" : {
      "href" : "/ucwa/v1/applications/543/presenceSubscriptions"
    },
    "search" : {
      "href" : "/ucwa/v1/applications/543/search"
    },
    "subscribedContacts" : {
      "href" : "/ucwa/v1/applications/543/subscribedContacts"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/543/people 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: 978
<?xml version="1.0" encoding="utf-8"?>
<resource rel="people" href="/ucwa/v1/applications/543/people" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="myContactsAndGroupsSubscription" href="/ucwa/v1/applications/543/people/myContactsAndGroupsSubscription" />
  <link rel="myContacts" href="/ucwa/v1/applications/543/contacts" />
  <link rel="myGroupMemberships" href="/ucwa/v1/applications/543/myGroupMemberships" />
  <link rel="myGroups" href="/ucwa/v1/applications/543/groups" />
  <link rel="myPrivacyRelationships" href="/ucwa/v1/applications/543/myPrivacyRelationships" />
  <link rel="presenceSubscriptionMemberships" href="/ucwa/v1/applications/543/presenceSubscriptionMemberships" />
  <link rel="presenceSubscriptions" href="/ucwa/v1/applications/543/presenceSubscriptions" />
  <link rel="search" href="/ucwa/v1/applications/543/search" />
  <link rel="subscribedContacts" href="/ucwa/v1/applications/543/subscribedContacts" />
  <property name="rel">people</property>
</resource>

Show:
© 2014 Microsoft