DELETE Role
Overview
The following table contains important information about the DELETE method in regards to deleting a role by using id.
| DELETE Role with Id | |
|---|---|
| Method | DELETE |
| URL or Endpoint | /api/roles/id |
| Headers | Authorization |
| Parameters | projectId,id |
| Body | Not Applicable |
The description of the URL parameters is as follows:
| URL Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
projectId | Yes | string | Unique Id of the project. |
id | Yes | integer($int32) | Unique id of the role. |
Request Body
The request does not contain a request body
Response
{
"success": true,
"errors": [],
"messages": [
"Role deleted successfully!"
],
"result": true,
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise will return false. |
| errors | array[] | Indicates if there was an error. |
| messages | array[] | Returns the response message from back-end. |
| result | array[Object] | Returns the response object. |
| resultInfo | string | Returns extra information about the result. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed