title | description |
---|---|
myGroupMemberships |
A collection of groupMembership resources, each of which uniquely links a contact to a group. |
Applies to: Skype for Business 2015
A collection of groupMembership resources, each of which uniquely links a contact to a group.
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 collection is read-only: it can be used only to view existing groupMembership resources. Contacts can bemoved into new groups using the Skype for Business client.
None
This resource can have the following relationships.
Link | Description |
---|---|
self | The link to the current resource. |
myGroupMembership | Represents the group 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 |
---|---|---|
Contacts.ReadWrite | Read/write Skype user contacts and groups | Allows the app to read and write Skype user contacts and groups |
Operation description coming soon...
Name | Description | Required? |
---|---|---|
groupId | The group id of the group for which memberships are requested.The maximum length is 256 characters. | No |
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 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. |
Only server-supplied query parameters, if any, are shown in the request sample.
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/myGroupMemberships 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: 516
{
"rel" : "myGroupMemberships",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/myGroupMemberships"
}
},
"_embedded" : {
"myGroupMembership" : [
{
"rel" : "myGroupMembership",
"_links" : {
"self" : {
"href" : "/ucwa/v1/applications/192/myGroupMemberships/myGroupMembership"
},
"contact" : {
"href" : "/ucwa/v1/applications/192/people/282"
},
"defaultGroup" : {
"href" : "/ucwa/v1/applications/192/groups/defaultGroup"
},
"group" : {
"href" : "/ucwa/v1/applications/192/groups/group"
},
"pinnedGroup" : {
"href" : "/ucwa/v1/applications/192/groups/pinnedGroup"
}
}
}
]
}
}
Get https://fe1.contoso.com:443/ucwa/v1/applications/192/myGroupMemberships 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: 694
<?xml version="1.0" encoding="utf-8"?>
<resource rel="myGroupMemberships" href="/ucwa/v1/applications/192/myGroupMemberships" xmlns="http://schemas.microsoft.com/rtc/2012/03/ucwa">
<property name="rel">myGroupMemberships</property>
<resource rel="myGroupMembership" href="/ucwa/v1/applications/192/myGroupMemberships/myGroupMembership">
<link rel="contact" href="/ucwa/v1/applications/192/people/282" />
<link rel="defaultGroup" href="/ucwa/v1/applications/192/groups/defaultGroup" />
<link rel="group" href="/ucwa/v1/applications/192/groups/group" />
<link rel="pinnedGroup" href="/ucwa/v1/applications/192/groups/pinnedGroup" />
<property name="rel">myGroupMembership</property>
</resource>
</resource>