Get Global Group Members

Last updated
Save as PDF

getGlobalGroupMembers

Given the company ID (optional), the global group ID, and the number of members to return, this web service returns a list of members. The list may be filtered by member type and anchored so that it begins at a given place.

GlobalGroupMember[] getGlobalGroupMembers(string companyId, string groupId, string memberTypeFilter, GlobalGroupMember anchor, string operation, int numOfMembers) 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.
memberTypeFilter A string, length 1, allows for the retrieval of a single member type. Possible values are:
0 = vehicle
2 = user
3 = driver
4 = global group
anchor A GlobalGroupMember containing the SCAC (if applicable), the ID of the member, and the member type to anchor the list. The members retrieved in the specified group will start at the anchor.
operation A string containing a value to indicate the direction starting at the anchor (if included) to retrieve the members. Possible values are:
= (equal to)
< (less than; encoded as < )
> (greater than; encoded as > )
<= (less than or equal to; encoded as <= )
>= (greater than or equal to; encoded as >= )
numOfMembers The number of members to return in the list. The value must be between 1 and 1000.

Returns a null string on exceptions; otherwise, returns an array of GlobalGroupMember 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 group id.
007 Invalid member type filter.
008 Invalid operation.
009 Invalid number of members.

Sample Request

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

<soapenv:Body>

<getGlobalGroupMembers>

<companyId>TESTCOMP</companyId>

<groupId>West Dry</groupId>

<memberTypeFilter>0</memberTypeFilter>

<anchor>

<id>TRUCK</id>

<type>0</type>

</anchor>

<operation>></operation>

<numOfMembers>75</numOfMembers>

</getGlobalGroupMembers>

</soapenv:Body>

Sample Response

This response is returned if members exist for the global group.

<soapenv:Body>

<getGlobalGroupMembersResponse>

<getGlobalGroupMembersReturn>

<GlobalGroupMember>

<id>TRUCK2</id>

<type>0</type>

</GlobalGroupMember>

<GlobalGroupMember>

<id>TRUCK3</id>

<type>0</type>

</GlobalGroupMember>

<GlobalGroupMember>

<id>TRUCK4</id>

<type>0</type>

</GlobalGroupMember>

</getGlobalGroupMembersReturn>

</getGlobalGroupMembersResponse>

</soapenv:Body>

If the global group has no members, no response is returned. If an error occurred, an exception would have been thrown:

<soapenv:Body>

<getGlobalGroupMembersResponse/>

</soapenv:Body>