Delete Global Group
deleteGlobalGroup
Deletes a global group definition.
All group memberships are automatically removed when the group is deleted; therefore, it is not necessary to remove all group members prior to deleting the group.
void deleteGlobalGroup(string companyId, string groupId) 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, containing the unique identifier of the global group to delete.
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 The specified group is maintained by the system and therefore cannot be deleted.
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.
|
|