Show Menu
TOPICS×

getGroups

Returns company groups.
Syntax

Authorized User Types

  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin

Parameters

Input (getGroupsParam)
Name
Type
Required
Description
* companyHandle *
xsd:string
Yes
The handle to the company.
Output (getGroupsReturn)
Name
Type
Required
Description
* groupArray *
types:GroupArray
Yes
Array of groups.

Examples

This code returns an array that contains all the groups that belong to a specific company and specific information about each group.
Request
<ns1:getGroupsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getGroupsParam>

<getGroupsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <groupArray>
      <items>
         <groupHandle>225</groupHandle>
         <companyHandle>47</companyHandle>
         <name>MyGroup</name>
         <isSystemDefined>false</isSystemDefined>
      </items>
   </groupArray>
</getGroupsReturn>