Remove Global Group Members
removeGlobalGroupMembers
Allows one to many members to be removed from a specified group. If {all} is entered as the value in membersToRemove, then all members for the group will be removed. Unknown members are ignored, no exception will be thrown.
void removeGlobalGroupMembers(string companyId, string groupId, GlobalGroupMember[] membersToRemove) throws WSException
- companyId (optional) A string, maximum length 10, specifying the unique company identifier.
NOTE: If no companyId is specified, the company of the authorized user making the call will be used. - groupId A string, maximum length 25, specifying the name of the global group.
- membersToRemove A GlobalGroupMember[] containing the SCAC (if applicable) and ID of the member(s) to be removed and the member type. If {all} is specified as the Id of the first GlobalGroupMember in the membersToRemove array, then all members (all types included) of the group will be removed.
Authorization Requirements
The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.
Required Application Licenses
- Remote Integration
Required User Permissions
- Can set up global groups
Customer integrators are authorized to their own company's data only.
Exceptions
002 Required field not specified.
003 Company not authorized for integration.
004 User not authorized.
005 Invalid company id.
006 Unknown group id.
007 One or more of the specified member types are maintained by the system and therefore cannot be changed.
Sample Request
Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.
|
|
Sample Response
No response conveys success. If an error occurred, an exception would have been thrown.
|
|