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

people

John Austin|Last Updated: 1/27/2018
|
2 Contributors

Applies to: Skype for Business 2015

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

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.

Resource description

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

This resource can have the following relationships.

LinkDescription
selfThe link to the current resource.
myContactsAndGroupsSubscriptionRepresents the subscription to a user's contacts and groups.
myContactsA collection of contact resources that belong to the logged-on user.
myGroupMembershipsA collection of groupMembership resources, each of which uniquely links a contact to a group.
myGroupsA collection of groups in the contact list of the logged-on user.
myPrivacyRelationshipsRepresents the various privacy relationships that the user maintains with his or her contacts.
presenceSubscriptionMembershipsA collection of presenceSubscriptionMembership resources.
presenceSubscriptionsRepresents the user's set of presenceSubscription resources.
searchProvides a way to search for contacts.
subscribedContactsA collection of contacts for which the logged-on user has created active presence subscriptions.

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
Contacts.ReadWriteRead/write Skype user contacts and groupsAllows the app to read and write Skype user contacts and groups

Operations

GET

Returns a representation of the hub for the people with whom the logged-on user can communicate, using Skype for Business.

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 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/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/192/people"
    },
    "myContactsAndGroupsSubscription" : {
      "href" : "/ucwa/v1/applications/192/people/myContactsAndGroupsSubscription"
    },
    "myContacts" : {
      "href" : "/ucwa/v1/applications/192/contacts"
    },
    "myGroupMemberships" : {
      "href" : "/ucwa/v1/applications/192/myGroupMemberships"
    },
    "myGroups" : {
      "href" : "/ucwa/v1/applications/192/groups"
    },
    "myPrivacyRelationships" : {
      "href" : "/ucwa/v1/applications/192/myPrivacyRelationships"
    },
    "presenceSubscriptionMemberships" : {
      "href" : "/ucwa/v1/applications/192/presenceSubscriptionMemberships"
    },
    "presenceSubscriptions" : {
      "href" : "/ucwa/v1/applications/192/presenceSubscriptions"
    },
    "search" : {
      "href" : "/ucwa/v1/applications/192/search"
    },
    "subscribedContacts" : {
      "href" : "/ucwa/v1/applications/192/subscribedContacts"
    }
  }
}

XML Request

Get https://fe1.contoso.com:443/ucwa/v1/applications/192/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/192/people" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
  <link rel="myContactsAndGroupsSubscription" href="/ucwa/v1/applications/192/people/myContactsAndGroupsSubscription" />
  <link rel="myContacts" href="/ucwa/v1/applications/192/contacts" />
  <link rel="myGroupMemberships" href="/ucwa/v1/applications/192/myGroupMemberships" />
  <link rel="myGroups" href="/ucwa/v1/applications/192/groups" />
  <link rel="myPrivacyRelationships" href="/ucwa/v1/applications/192/myPrivacyRelationships" />
  <link rel="presenceSubscriptionMemberships" href="/ucwa/v1/applications/192/presenceSubscriptionMemberships" />
  <link rel="presenceSubscriptions" href="/ucwa/v1/applications/192/presenceSubscriptions" />
  <link rel="search" href="/ucwa/v1/applications/192/search" />
  <link rel="subscribedContacts" href="/ucwa/v1/applications/192/subscribedContacts" />
  <property name="rel">people</property>
</resource>
© 2018 Microsoft