Add Global Group Members
addGlobalGroupMembers
This web service is used to add members to a group. It accepts an array of up to 1000 members to be added to the global group in a single request. Any members that could not be added will be returned.
GlobalGroupMember[] addGlobalGroupMembers(string companyId, string groupId, GlobalGroupMember[] membersToAdd) 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.
- membersToAdd A GlobalGroupMember[] containing the SCAC (if applicable) and the ID of the member(s) to be added and the member type.
Any members that could not be added will be returned in an array of GlobalGroupMember[] objects; otherwise a null string is returned.
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
An empty response conveys success. If an error occurred, an exception would have been thrown. Any members not added are returned.
Successful Response:
|
|
Failed Response:
A member can be rejected for the following reasons:
- Unknown member id.
- Invalid member type.
- Illogical hierachy; a parent cannot become a child of itself.
- The global group can contain either child groups or entities; not both.
In the following example, TRUCK1 was returned because it is an unknown member id or it caused an illogical hierachy. TRUCK3 was returned because the member type is invalid.
|
|