Get Group Membership

Last updated
Save as PDF

getGroupMembership

Given the company ID (optional) and a global group member this web service returns a list of groups of which it is a member.

GlobalGroup[] getGroupMembership(string companyId, GlobalGroupMember member) 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.
member A GlobalGroupMember containing the SCAC (if applicable), the ID of the member and the member type. All groups that include this global group member as a member will be returned in a list.

Returns a null string on exceptions; otherwise, returns an array of GlobalGroup objects.

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 member.
007 Invalid member type.

Sample Request

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

<soapenv:Body>

<getGroupMembership>

<companyId>TESTCOMP</companyId>

<member>

<id>TRUCK1</id>

<type>0</type>

</member>

</getGroupMembership>

</soapenv:Body>

Sample Response

If the member is found in any global group, this response is returned:

<soapenv:Body>

<getGroupMembershipResponse>

<getGroupMembershipReturn>

<GlobalGroup>

<id>East Dry</id>

<description>Dry vans in the Eastern region</description>

<limitHistory>true</limitHistory>

<visibleToUnlimitedUsers>false</visibleToUnlimitedUsers>

</GlobalGroup>

<GlobalGroup>

<id>West Dry</id>

<description>Dry vans in the Western region</description>

<limitHistory>true</limitHistory>

<visibleToUnlimitedUsers>false</visibleToUnlimitedUsers>

</GlobalGroup>

</getGroupMembershipReturn>

</getGroupMembershipResponse>

</soapenv:Body>

If the member is not found in any global group, an empty response is returned. If an error occurred, an exception would have been thrown:

<soapenv:Body>

<getGroupMembershipResponse/>

</soapenv:Body>