DocumentationDynamic Media Image Production System API

getGroupMembership

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin

Returns the members of a group.

Syntax

Authorized User Types

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parameters

Input (getGroupMembershipParam)

Name
Type
Required
Description
userHandle
xsd:string
No
The handle to the user.
companyHandle
xsd:string
No
The handle to the company.

Output (getGroupMembershipReturn)

Name
Type
Required
Description
groupArray
types:GroupArray
Yes
Array of groups.

Examples

This code sample returns all the members of a group. Because the company and user handles are optional, the operation can return all members of all groups.

Request

<ns1:getGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getGroupMembershipParam>

Response

<getGroupMembershipReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <groupArray>
      <items>
         <groupHandle>225</groupHandle><companyHandle>47</companyHandle><name>MyGroup</name><isSystemDefined>false</isSystemDefined></items></groupArray></getGroupMembershipReturn>
4e9b9d8c-5839-4215-aa35-01b652869681