The MemberGroup noun defines types related to a member group. A member group is a group of persons or organizations. A member group can be used for different purposes. The purpose is specified using the usage. Currently the only usage that is supported is GeneralPurpose.
| BOD | Action Code / Access Profile | Action Expression | Service Provided | Sample XML Message | Client Library / Expression Builder |
|---|---|---|---|---|---|
| GetMemberGroup | IBM_Summary | /MemberGroup[MemberGroupIdentifier[(UniqueID=)]] | Find by multiple unique IDs. |
Request
Response |
findByUniqueIDs |
| IBM_Summary, IBM_Admin_Descriptions, IBM_Admin_Details | /MemberGroup[MemberGroupIdentifier[ExternalIdentifier[Name='$name$' and @ownerID='$ownerID$']]] | Find by name and owner ID. |
Request
Response |
findByNameAndOwnerID | |
| IBM_Summary, IBM_Admin_Descriptions, IBM_Admin_Details | /MemberGroup[Usage='$usage$'] | Find by usage. |
Request
Response |
findByUsage | |
| IBM_Summary, IBM_Admin_Descriptions, IBM_Admin_Details | /MemberGroup[MemberGroupIdentifier[UniqueID='$memberGroupID$'] and IncludedPerson[UniqueID='$personID$']] | Find by unique ID of group and unique ID of included person. |
Request
Response |
findByUniqueIDAndIncludedPersonUniqueID | |
| IBM_Summary, IBM_Admin_Descriptions, IBM_Admin_Details | /MemberGroup[search(MemberGroupIdentifier/ExternalIdentifier/Name='$name$') and Usage='$usage$'] | Find by external name and usage. Name can be "contains", "starts with" or "exact match". All are case-insensitive. |
Request
Response |
findByNameAndUsage | |
| IBM_Admin_Descriptions | /MemberGroup[MemberGroupIdentifier[(UniqueID=)]] | Find by multiple unique IDs. |
Request
Response |
findByUniqueIDs | |
| IBM_Admin_Details | /MemberGroup[MemberGroupIdentifier[(UniqueID=)]] | Find by multiple unique IDs. |
Request
Response |
findByUniqueIDs | |
| ProcessMemberGroup | Add | /MemberGroup[] | Creates a new member group. |
Request
Response |
MemberFacadeClient.processMemberGroup(ProcessMemberGroupType) |
| Activate | /MemberGroup[] | Activate a member group. |
Request
Response |
MemberFacadeClient.processMemberGroup(ProcessMemberGroupType) | |
| Delete | /MemberGroup[] | Deletes an existing member group. |
Request
Response |
MemberFacadeClient.processMemberGroup(ProcessMemberGroupType) | |
| DeleteAllMembers | /MemberGroup[] | Deletes all members in an existing member group. |
Request
Response |
MemberFacadeClient.processMemberGroup(ProcessMemberGroupType) | |
| ChangeMemberGroup | Add | /MemberGroup[]/MemberGroupDescription[] | Creates a member group description. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) |
| Add | /MemberGroup[]/ConditionElement[] | Creates a member group condition element. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Add | /MemberGroup[]/IncludedPerson[] | Add a person as included member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Add | /MemberGroup[]/IncludedOrganization[] | Add an organization as included member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Add | /MemberGroup[]/ExcludedPerson[] | Add a person as excluded member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Add | /MemberGroup[]/ExcludedOrganization[] | Add an organization as excluded member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Change | /MemberGroup[] | Changes the base MemberGroup information. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Change | /MemberGroup[]/MemberGroupDescription[] | Change a member group description. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Change | /MemberGroup[]/ConditionElement[] | Change a member group condition element. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/MemberGroupDescription[] | Deletes a member group description. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/ConditionElement[] | Delete a member group condition element. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/IncludedPerson[] | Delete a person as included member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/IncludedOrganization[] | Delete an organization as included member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/ExcludedPerson[] | Delete a person as excluded member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) | |
| Delete | /MemberGroup[]/ExcludedOrganization[] | Delete an organization as excluded member to the member group. |
Request
Response |
MemberFacadeClient.changeMemberGroup(ChangeMemberGroupType) |
Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.
| Access Profile | Data Returned |
|---|---|
| IBM_Summary |
|
| IBM_Admin_Descriptions |
|
| IBM_Admin_Details |
|