Get Global Group

Last updated
Save as PDF

getGlobalGroup

Given the company ID (optional) and a global group ID this web service returns the details of the global group.

GlobalGroup getGlobalGroup(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, specifying the name of the global group.

Returns a null string on exceptions; otherwise, returns a GlobalGroup object.

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

- none

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.

Note: 'Invalid...' exceptions include values that are too long or includes invalid characters.

Sample Request

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

<soapenv:Body>

<getGlobalGroup>

<companyId>TESTCOMP</companyId>

<groupId>Lower Mgmt</groupId>

</getGlobalGroup>

</soapenv:Body>

Sample Response

If the global group is found the details are returned in a GlobalGroup object. If an error occurred, an exception would have been thrown.

<soapenv:Body>

<getGlobalGroupResponse>

<getGlobalGroupReturn>

<GlobalGroup>

<id>Lower Mgmt</id>

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

<limitHistory>true</limitHistory>

<visibleToUnlimitedUsers>false</visibleToUnlimitedUsers>

</GlobalGroup>

</getGlobalGroupReturn>

</getGlobalGroupResponse>

</soapenv:Body>