REST-User
This topic provides details about the REST - User API call that GFI HelpDesk uses, including its field types, arguments, and responses.
GET /Base/User/Filter OR GET /Base/User/Filter/$marker$/$maxitems$
Retrieve a list of all users in the help desk starting from a marker (user id) till the item fetch limit is reached (by default this is 1000).
Response
<user><id>1</id>
<usergroupid>2</usergroupid>
<userrole>manager</userrole>
<userorganizationid>1</userorganizationid>
<salutation>Mr.</salutation>
<userexpiry>0</userexpiry>
<fullname>John Doe</fullname>
<email>john.doe@gfi.com</email>
<email>john@gfi.com</email>
<designation>CEO</designation>
<phone>123456789</phone>
<dateline>1296540309</dateline>
<lastvisit>0</lastvisit>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>0</enabledst>
<slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</user>
</users>
GET /Base/User/$id$
Retrieve the user identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user |
Response
<user><id>1</id>
<usergroupid>2</usergroupid>
<userrole>manager</userrole>
<userorganizationid>1</userorganizationid>
<salutation>Mr.</salutation>
<userexpiry>0</userexpiry>
<fullname>John Doe</fullname>
<email>john.doe@gfi.com</email><email>john@gfi.com</email>
<designation>CEO</designation>
<phone>123456789</phone>
<dateline>1296540309</dateline>
<lastvisit>0</lastvisit>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>0</enabledst>
<slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</user>
</users>
PUT /Base/User/$id$
Update the user identified by $id$.
Arguments
| Name | Description |
|---|---|
| fullname | The full name of User |
| usergroupid | The User Group ID (registered group) to assign to this User. |
| The Email Address of User, you can send multiple email addresses by using "email[]" as the key | |
| userorganizationid | The User Organization ID |
| salutation | The User Salutation, available options are: Mr., Ms., Mrs., Dr. |
| designation | The User Designation/Title |
| phone | The Phone Number |
| isenabled | Toggle whether the user is to be enabled/disabled |
| userrole | The User Role, available options are: user, manager. Default: user |
| timezone | The Time Zone |
| enabledst | Enable Daylight Savings? |
| slaplanid |
The SLA Plan ID to assign to the user |
| slaplanexpiry |
The SLA Plan Expiry, 0 = never expires |
| userexpiry |
The User Expiry, 0 = never expires |
Response
<user>
<id>1</id>
<usergroupid>2</usergroupid>
<userrole>manager</userrole>
<userorganizationid>1</userorganizationid>
<salutation>Mr.</salutation>
<userexpiry>0</userexpiry>
<fullname>John Doe</fullname>
<email>john.doe@gfi.com</email>
<email>john@gfi.com</email>
<designation>CEO</designation>
<phone>123456789</phone>
<dateline>1296540309</dateline>
<lastvisit>0</lastvisit>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>0</enabledst>
<slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</user>
</users>
POST /Base/User
Create a new User record.
Arguments
| Name | Description |
|---|---|
| fullname | The full name of User |
| usergroupid | The User Group ID to assign to this User |
| password | The User Password |
| The Email Address of User, you can send multiple email addresses by using "email[]" as the key | |
| userorganizationid | The User Organization ID |
| salutation | The User Salutation, available options are: Mr., Ms., Mrs., Dr. |
| designation | The User Designation/Title |
| phone | The Phone Number |
| isenabled | Toggle whether the user is to be enabled/disabled |
| userrole |
The User Role, available options are: user, manager. Default: user |
Response
<user>
<id>1</id>
<usergroupid>2</usergroupid>
<userrole>manager</userrole>
<userorganizationid>1</userorganizationid>
<salutation>Mr.</salutation>
<userexpiry>0</userexpiry>
<fullname>John Doe</fullname>
<email>john.doe@gfi.com</email>
<email>john@kayako.com</email>
<designation>CEO</designation>
<phone>123456789</phone>
<dateline>1296540309</dateline>
<lastvisit>0</lastvisit>
<isenabled>1</isenabled>
<timezone>GMT</timezone>
<enabledst>0</enabledst>
<slaplanid>0</slaplanid>
<slaplanexpiry>0</slaplanexpiry>
</user>
</users>
DELETE /Base/User/$id$
Delete the user identified by $id$.
Arguments
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user |