GroupHolder

Description

The GroupHolder type contains the GroupInfo response and any errors for group records that were not successfully returned. The GroupHolder type parameters are listed below.

Parameters

Name	Type	Description
group	GroupInfo	The GroupInfo type holds the complete information that describes a group.
status	Status	Holds status information for any messages or failures that are encountered.

Usage

The GroupHolder type holds detailed information for a group including the access type and status (whether it is marked as deleted or not). If any errors occur during the call, they are returned in the status element in the order in which they were processed.

XML

The following XML snippet shows GroupHolder in the return element of the GetGroups response. Note that an error message is returned in this example (inside the message element). In this example, three groups were requested using the GetGroups call; however, the second group (CR Submitters) was not properly identified. Therefore, an error was returned for the second group, though the service continued to run and returned the third group (IDM Manager).

<ae:GetGroupsResponse>
   <ae:return>
      <ae:group>
         <ae:id xsi:type="ae:GroupIdentifier">
            <ae:displayName>IDM Team</ae:displayName>
            <ae:id>2</ae:id>
            <ae:uuid>634aed4a-bc98-49d3-86f0-6095c2f7b9b6</ae:uuid>
         </ae:id>
         <ae:accessType>ACCESS-USER</ae:accessType>
         <ae:memo/>
         <ae:isDeleted>false</ae:isDeleted>
      </ae:group>
   </ae:return>
   <ae:return>
      <ae:status>
         <ae:status>IS-ERROR</ae:status>
         <ae:message>The specified group id or name 'CR Submitter'
         → does not exist.</ae:message>
      </ae:status>
   </ae:return>
   <ae:return>
      <ae:group>
         <ae:id xsi:type="ae:GroupIdentifier">
            <ae:displayName>IDM Manager</ae:displayName>
            <ae:id>3</ae:id>
            <ae:uuid>b2654094-0ec6-460d-856b-9b72709d183b</ae:uuid>
         </ae:id>
         <ae:accessType>ACCESS-USER</ae:accessType>
         <ae:memo/>
         <ae:isDeleted>false</ae:isDeleted>
      </ae:group>
   </ae:return>
</ae:GetGroupsResponse>