REST - UserGroup
This article provides details about the REST - UserGroup API call that GFI HelpDesk uses, including its field types, arguments, and responses.
GET /Base/UserGroup
Retrieve a list of all user groups in the helpdesk.
Response
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup><usergroup>
<id>2</id>
<title>Guest</title>
<grouptype>guest</grouptype>
<ismaster>1</ismaster>
</usergroup><usergroup>
<id>3</id>
<title>Clients</title>
<grouptype>registered</grouptype>
<ismaster>0</ismaster>
</usergroup>
</usergroups>
GET /Base/UserGroup/$id$
Retrieve the user group identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user group |
Response
PUT /Base/UserGroup/$id$
Update the user group identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user group |
| title | The title of the user group |
Response
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup>
</usergroups>
POST /Base/UserGroup
Create a user group.
Arguments
| Name | Description |
|---|---|
| title | The title of the user group |
| grouptype | The type of user group('guest' or 'registered') |
Response
<usergroup>
<id>1</id>
<title>Registered</title>
<grouptype>registered</grouptype>
<ismaster>1</ismaster>
</usergroup>
</usergroups>
DELETE /Base/UserGroup/$id$
Delete the user group identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ |
The unique numeric identifier of the user group |