UserIdentityGroups REST API endpoint

Disclaimer: This endpoint documentation is generated from the latest Sitevision version. It might differ from the actual Sitevision environment where your website resides.

Use the RestApi utility of the Public API for server-side access of this endpoint.

UserIdentityGroups

Get collaboration groups for a user identity.

Applicable to: sv:userIdentity.

GET

Returns an array of objects containing sv:collaborationGroup for a sv:userIdentity.

Requires the feature "social collaboration" and that social collaboration is enabled on the sv:site.

The result will only contain collaboration groups that the caller is authorized to READ.

Name	Type	Default	Values	Description	Since
states	`array`	ACTIVE	ACTIVE, INACTIVE	Return groups with specific state.
types	`array`	OPEN, CLOSED, MEMBER_MODERATED	OPEN, CLOSED, MEMBER_MODERATED	Return groups with specific types.
relations	`array`	MEMBER	MEMBER, FOLLOWER, ADMIN	Return groups with specified relation.
skip	`number`	0	Any positive value	Skips leading number of groups.
limit	`number`	20	Any positive value	Limits the number of groups to return.
order	`string`	DEFAULT	DEFAULT, DEFAULT_REVERSED, ALPHABETICAL, ALPHABETICAL_REVERSED, UPDATED, UPDATED_REVERSED	Order of returned groups.	4.5.3

Example URL

400.3b12ee3f13dab89ecc4182/useridentitygroups

Example input

{
   "types": [
      "OPEN",
      "CLOSED"
   ],
   "states": [
      "ACTIVE",
      "INACTIVE"
   ],
   "relations": [
      "MEMBER",
      "FOLLOWER"
   ]
}

Example response

[
   {
      "id": "401.89b68f3142e102986d1b",
      "displayName": "Ettans grupp (aktiviteter)",
      "groupDescription": "För dem som planerar",
      "groupType": "OPEN",
      "groupState": "ACTIVE",
      "BuddyIconSize_SMALL": "/sitevision/core/group_32.png",
      "BuddyIconSize_LARGE": "/sitevision/core/group_48.png",
      "BuddyIconSize_X_LARGE": "/sitevision/core/group_64.png",
      "isAdmin": false,
      "isMember": true,
      "isFollower": false,
      "groupPage": "704.89b68f3142e102986d12",
      "URI": "/704.89b68f3142e102986d12.html",
      "memberCount": 55,
      // below are returned if selected user identity equals current user identity
      "isMuteNotifications": true,
      "isMuted": false,
      "newGroupEntryCount": 0
   },
   {
      "id": "401.771b17b1152d6039873c0",
      "displayName": "Kontaktgrupp",
      "groupDescription": "Här finns vi som följer varandra personligen också",
      "groupType": "CLOSED",
      "groupState": "ACTIVE",
      "BuddyIconSize_SMALL": "/sitevision/core/group_32.png",
      "BuddyIconSize_LARGE": "/sitevision/core/group_48.png",
      "BuddyIconSize_X_LARGE": "/sitevision/core/group_64.png",
      "isAdmin": false,
      "isMember": true,
      "isFollower": false,
      "groupPage": "704.771b17b1152d6039873b7",
      "URI": "/704.771b17b1152d6039873b7.html",
      "memberCount": 23, // value might be cached up to 1 hour
      "lastUpdate": 1455876637472,
      // below are returned if selected user identity equals current user identity
      "isMuteNotifications": false,
      "isMuted": false,
      "newGroupEntryCount": 0
   }
]

Did you find the content on this page useful?

UserIdentityGroups REST API endpoint