Create Global Group

Last updated
Save as PDF

createGlobalGroup

Creates a new global group definition. A maximum of 2000 groups may be created.

void createGlobalGroup(string companyId, 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.
group A GlobalGroup containing the details for creating the group.

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 Invalid group Id.
007 Duplicate group Id.
008 Invalid group description.
009 Maximum number of global groups exceeded.

Note: 'Invalid' exceptions include:

values that are too long
values with invalid characters

Sample Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soapenv:Body>

<createGlobalGroup>

<companyId>TESTCOMP</companyId>

<group>

<id>Lower Mgmt</id>

<description>This group contains only lower management people.</description>

<limitHistory>true</limitHistory>

<visibleToUnlimitedUsers>false</visibleToUnlimitedUsers>

</group>

</createGlobalGroup>

</soapenv:Body>

Sample Response

No response conveys success. If an error occurred, an exception would have been thrown.

<soapenv:Body>

<createGlobalGroupResponse/>

</soapenv:Body>