| Table of contents |
|---|
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
An 'HTTP 200 OK' with the following XML payload:
GET /Base/User/$id$
Retrieve the user identified by $id$.
Arguments
Red = required
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user. |
Response
An 'HTTP 200 OK' with the following XML payload:
PUT /Base/User/$id$
Update the user identified by $id$.
Arguments
Red = required
| Name | Description |
|---|---|
| fullname | The full name of User. |
| usergroupid | The User Group ID 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
An 'HTTP 200 OK' with the following XML payload:
POST /Base/User
Create a new User record
Arguments
Red = required
| 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 |
| 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 |
| sendwelcomeemail | Whether to send a welcome email to the user, default: 1 |
Response
An 'HTTP 200 OK' with the following XML payload:
DELETE /Base/User/$id$
Delete the user identified by $id$.
Arguments
Red = required
| Name | Description |
|---|---|
| $id$ | The unique numeric identifier of the user. |
Response
If an 'HTTP 200 OK' is returned, the deletion was successful. If a different HTTP status code is returned, the deletion failed. Consult the status code list for a list of error statuses and their respective meanings.
Labels:
None