GroupProvider Service

A provider to manage user groups with.

Namespace
http://airportal.service.cbtweb.cbt.com/
WSDL
airportal.wsdl
Path
/GroupProviderService

updateGroup Operation

Update or create a new group based on the permission provided.

Input Parameters
name type description
group group A group to update or create new.
Return Value
type description
group The new or updated group.

deleteGroup Operation

Remove a group from the database.

Input Parameters
name type description
groupId long The group id to delete from the database.

listAllGroups Operation

Get a list of all groups.

Return Value
type description
list of group A list containing all group objects.

listAllPermissionsInGroup Operation

Get a list of all permissions inside a group.

Input Parameters
name type description
groupId long The group id to view all permissions in.
Return Value
type description
list of permission A list of all permissions in this group.

listAllUsersInGroup Operation

Get a list of all users in the group.

Input Parameters
name type description
groupId long The group id to view all users in.
Return Value
type description
list of user A list of all users in this group.

addUserToGroup Operation

Add a user to a group

Input Parameters
name type description
userId long The unique ID of the user to add to the group.
groupId long The unique ID of the group to add the user to.
Return Value
type description
group The group that the user was added to.

addPermissionToGroup Operation

Add a permission to a group

Input Parameters
name type description
permId long The unique ID of the permission to add to the group.
groupId long The unique ID of the group to add the permission to.
Return Value
type description
group The group that the permission was added to.

removeUserFromGroup Operation

Remove a user from a group.

Input Parameters
name type description
userId long The unique ID of the user to remove from the group.
groupId long The unique ID of the group to remove the user from.
Return Value
type description
group  

removePermissionFromGroup Operation

Remove a permission from a group.

Input Parameters
name type description
permId long The unique ID of the permission to remove from the group.
groupId long The unique ID of the group to remove the permission from.
Return Value
type description
group  

getGroupById Operation

Get a group by Id.

Input Parameters
name type description
groupId long The unique ID of the group to retrieve.
Return Value
type description
group The group represented by the ID.

getGroupByName Operation

Get a group by name

Input Parameters
name type description
groupName string A unique name assigned to this group
Return Value
type description
group A specific group given by the name.

searchGroups Operation

Search the groups using a search list

Input Parameters
name type description
searchList searchList The query to find groups with
Return Value
type description
list of group A list of groups that meet the criteria in the search list.

countGroups Operation

Count groups using a search list.

Input Parameters
name type description
searchList searchList The search list to count groups with.
Return Value
type description
long The number of groups found.

isMemberOfGroup Operation

Determines if a user is part of a group or not Up for Deprecation

Input Parameters
name type description
userId long the user to search for
groupName string the name of the group
Return Value
type description
string String representing a boolean

getGroupsOfType Operation

Get a list of groups with the given type code, like 'U'.

Input Parameters
name type description
type string The type code for the groups wanted.
Return Value
type description
list of group A list of groups with the given type code.

getGroupsOfTypeByRoleCode Operation

Get all groups by the role code

Input Parameters
name type description
code string  
Return Value
type description
list of group  

addUserToDefaultGroupsFromClient Operation

Add a user to the default user group of the client specified.

Input Parameters
name type description
userId long The unique ID of the user to add to the group.
clientId long The unique ID of the client with the default user group desired.

addUserToDefaultGroupsFromTmc Operation

Add a user to the default user group of the tmc of the client specified.

Input Parameters
name type description
userId long The unique ID of the user to add to the group.
clientId long The unique ID of the client that belongs to a tmc.

addUserToDefaultManagerGroup Operation

Add a user to the default manager group for the client and the tmc of the client.

Input Parameters
name type description
userId long The unique ID of the user to add to the group.
clientId long The unique ID of the client that the user was added to as a manager.
roleCode string the name/code of the group that the user is being added to. Example: "Travel Manager" or "M" for manager.
Return Value
type description
group The group that the user was added to, if any.

changeClientUserGroup Operation

Add all users to a new user group of the client specified, while removing the previous user group.

Input Parameters
name type description
clientId long The unique ID of the client with the old default user group.
oldGroupId long  
groupId long The unique ID of the new group.

changeClientDefaultUserGroup Operation

Add all users to a new user group of the client specified, while removing all previous user groups of the same type.

Input Parameters
name type description
clientId long The unique ID of the client.
groupCode string The group code, or type, of group this should be exchanging.
group group The new group.

changeClientUserGroups Operation

Add all users to new user groups of the client specified and remove the previous user groups.

Input Parameters
name type description
clientId long The unique Id of the client with the old default user group.
addGroupIds list of long A list user group Ids to add to users of the given client
removeGroupIds list of long A list of user group Ids to remove from users of the given client

changeDefaultAgentUserGroups Operation

Clears out all of the A,O,P groups and adds the given ones to each user of the client

Input Parameters
name type description
clientId long The id of the client
newGroupIds list of long The list of user groups to add to users of the given client

getDefaultGroupIdOfType Operation

Get the default user group id of the given user group type

Input Parameters
name type description
clientId long The id of the client
type string The type of the default user group: A - Agent, P - Profile, O - Online, U - User (deprecated)
Return Value
type description
long The id of the requested group