REST API - Delete an employee from a group
Last modified on 2023/04/17 15:16
Comments
DELETE /groups/{group_id}/employees/{employee_id}
- This method allows a specified employee from a specified group to be deleted.
example groups/123/employees/9505
- The method supports the deletion of a single employee per call.
Notes
See Service Manager REST API Convention
- If successful, an HTTP status code 204 is returned.
List of parameters / fields
Mandatory parameters
You must use the parameters below in the URL.
| Parameter | Type | Description / Example |
|---|---|---|
| group_id | integer | Group identifier |
| employee_id | integer | Employee identifier |
Optional parameters
None
Optional fields
None
HTTP status codes for the method
StatusHeader
Note: A Timeout error code will be returned if the server does not respond to the REST Web service request within a given time (by default 60 seconds).
| Code | Error | Description |
|---|
Status204
| 204 | Deleted | Request successfully processed and element deleted. |
Status401
| 401 | Unauthorized | Incorrect authentication process for accessing the resource: Incorrect login/password, invalid session, incorrect Service Manager account.
example { "error": "Invalid Login / Password" } |
Status404
| 404 | Not found | Resource not found: Incorrect URI, missing resource, incorrect communication with the server, rfc_number not found.
example { "error": "Resource not found" } |
ConventionsAPI
REST API Conventions
| Convention | Meaning | |
|---|---|---|
| Orange | Parameters used in an HTTP request string which do not correspond to Service Manager database fields.
example Method View a list of assets https://{your_server}/api/v1/{your_account}/assets?max_rows=3&fields=asset_tag |
|
| Black and Bold | Parameters used in the URL of an HTTP request which correspond to Service Manager database fields.
example Method View an asset https://{your_server}/api/v1/{your_account}/assets/{asset_id} |
|
| Green | Parameters used in the body of an HTTP request which represent JSON object names corresponding to Service Manager database fields; they allow the value of a database field to be assigned or modified.
example Method Close an incident/request { "closed": { "end_date": "11/20/2016 12:12:12", } } |
|
| Parameters used in the body of an HTTP request which represent JSON object names not corresponding to Service Manager database fields.
example Method Reopen an incident/request { "restarted": { "comment": "string (required)" } } |
||