# Group operations

### Assigns a user to a group

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter  | Description                |
| ---------- | -------------------------- |
| Group id   | Id of group                |
| Login name | Login name of user, not id |

#### Output <a href="#output" id="output"></a>

Record with information about whether operation failed or not.

| Member       | Description                                                            |
| ------------ | ---------------------------------------------------------------------- |
| HasFailed    | Whether operation has failed or not                                    |
| ErrorMessage | A description of the failure, if any                                   |
| ErrorCode    | An error code related to operation failure. Is 0 if no failure occured |

#### Errors <a href="#errors" id="errors"></a>

| Error code | Description        |
| ---------- | ------------------ |
| 1000       | Unspecified error. |

### Detach user from group <a href="#detach-user-from-group" id="detach-user-from-group"></a>

Detaches the user from the group

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter  | Description                |
| ---------- | -------------------------- |
| Group id   | Id of group                |
| Login name | Login name of user, not id |

#### Output <a href="#output" id="output"></a>

Record with information about whether operation failed or not.

| Member       | Description                                                            |
| ------------ | ---------------------------------------------------------------------- |
| HasFailed    | Whether operation has failed or not                                    |
| ErrorMessage | A description of the failure, if any                                   |
| ErrorCode    | An error code related to operation failure. Is 0 if no failure occured |

#### Errors <a href="#errors" id="errors"></a>

| Error code | Description        |
| ---------- | ------------------ |
| 1000       | Unspecified error. |

### List site groups <a href="#list-site-groups" id="list-site-groups"></a>

Gets and list all site groups

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter | Description |
| --------- | ----------- |

#### Output <a href="#output" id="output"></a>

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

| Member       | Description                                                            |
| ------------ | ---------------------------------------------------------------------- |
| HasFailed    | Whether operation has failed or not                                    |
| ErrorMessage | A description of the failure, if any                                   |
| ErrorCode    | An error code related to operation failure. Is 0 if no failure occured |
| Results      | Table variable containing the results of operation                     |

Structure of Results Results\
\
AllowMembersEditMembership\
AllowRequestToJoinLeave\
AutoAcceptRequestToJoinLeave\
CanCurrentUserEditMembership\
CanCurrentUserManageGroup\
CanCurrentUserViewMembership\
OnlyAllowMembersViewMembership\
RequestToJoinLeaveEmailSetting\
Id\
LoginName\
Title\
Description\
OwnerTitle

#### Errors <a href="#errors" id="errors"></a>

| Error code | Description        |
| ---------- | ------------------ |
| 1000       | Unspecified error. |

### List users by group id <a href="#list-users-by-group-id" id="list-users-by-group-id"></a>

List all users assigned to a group.

#### Parameters <a href="#parameters" id="parameters"></a>

| Parameter | Description |
| --------- | ----------- |
| Group id  | Id of group |

#### Output <a href="#output" id="output"></a>

Record with information about whether operation failed or not. If succesful, result of operation is stored in Results member

| Member       | Description                                                            |
| ------------ | ---------------------------------------------------------------------- |
| HasFailed    | Whether operation has failed or not                                    |
| ErrorMessage | A description of the failure, if any                                   |
| ErrorCode    | An error code related to operation failure. Is 0 if no failure occured |
| Results      | Table variable containing the results of operation                     |

Structure of Results Results

Id\
LoginName\
Email\
Title\
IsSiteAdmin

#### Errors <a href="#errors" id="errors"></a>

| Error code | Description        |
| ---------- | ------------------ |
| 1000       | Unspecified error. |