Group Methods

Method Description
addGroup Adds a group to the system.

Users are assigned to groups to have access to transfer definitions. They have no rights associated with them. The user calling this method must have UpdateGroupRight or AdministratorRight.

updateGroup Updates a group in the system.

The user calling this method must have UpdateGroupRight or AdministratorRight.

To update a field to become null, you can use an empty string (for example: "").
Note: When performing an update, only set the fields that you want to update in the role object. The rest of the fields will be null.
removeGroup Removes a group from the system.

The user calling this method must have UpdateGroupRight or AdministratorRight.

getGroup Gets a group from the system.

If the group is not found, a null is returned. The user calling this method must have ViewGroupRight, UpdateGroupRight, or AdministratorRight.

retrieveAllGroups Retrieves all groups from the system as an array of groups.

The last element of the array is null. If no groups are found, an array of one element is returned with a value null.

retrieveAllGroupsInDept Retrieves all groups from the department as an array of groups.

The last element of the array is null. If no groups are found, an array of one element is returned with a value of null.

retrieveAllGroupsForUser Retrieves all groups that user is assigned to, and returns an array of groups.

The last element of the array is null. If no groups are found, an array of one element is returned with a value of null.

The user calling this method must have ViewGroupRight, UpdateGroupRight, or AdministratorRight.

retrieveAllUsersInGroup Retrieves all users that are assigned to a group, and returns an array of Users.

The last element of the array is null. If no users are found, an array of one element is returned with a value of null.

The user calling this method must have ViewGroupRight, UpdateGroupRight, or AdministratorRight.

retrieveAllUsersNotInGroup Retrieves all users that are not assigned to this group, and returns an array of users.

The last element of the array is null. If no users are found, an array of one element is returned with a value of null.

The user calling this method must have ViewGroupRight, UpdateGroupRight, or AdministratorRight.

retrieveAllGroupIds Retrieves all groups IDs from the system as an array of strings.

The last element of the array is null. If no groups IDs are found, an array of one element is returned with a value of null.

addUserToGroup Assigns a user to a group.

The user calling this method must have UpdateGroupRight or AdministratorRight.

removeUserFromGroup Removes a user from a group they are assigned to.

The user calling this method must have UpdateRoleRight or AdministratorRight.