Edit Global Group
editGlobalGroup
Allows a global group definition to be edited or renamed.
void editGlobalGroup(string companyId, string groupId, GlobalGroup group) 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 of maximum length 25 containing the unique identifier of the global group to edit.
- group A GlobalGroup containing the changed details for the group being edited (including rename). All attributes of the GlobalGroup must be specified, as the group will be changed to match the GlobalGroup that is provided.
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 The specified group could not be found.
007 The new group id already exists.
008 The new group id is invalid.
009 Invalid group description.
010 The specified group is maintained by the system and therefore cannot be updated.
Note: 'Invalid...' exceptions include values that are blank (when required), too long or include invalid characters.
Sample Request
Note: All attributes must be specified in the GlobalGroup object. Specifying blank in the group description will update the group description with blanks.
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.
|
|