View Source

REQUEST

This API is used to delete multiple found User. First, you have to put the parameter into API to filter data. Then you delete the found User. All the found Users will be deleted.

The structure of API as below:

DELETE	/user/all

It allows admin to query data by some parameters as below:

Parameters	Description
active	Querydatabystatusofuser: Active or not
create_time_gt	Query data by period time to create User. It is start time
create_time_lt	Query data by period time to create User. It is end time
email	Query data by email User.
is_online	Query data by state of the user at the query time: Online or not
last_login_time_gt	Query data by the period time user logged in to system. It is start time
last_login_time_lt	Query data by the period time user logged in to system. It is end time
login_ip	Query data by the IPthatuserusetologintosystem.
name	Query data by name of User.
role_id	Query data by Role of User.
user_id	Query data by ID of the User.
user_id_in	Query by the range of User_ID
user_type	Query by type of User.

HEADER

The request requires you given the Admin Token in headers because onlyadminhasthepermission deleting the User. To get the Token, please refer Authenticate User for more details.

{
	"accept": "application/json",
	"X-Auth-Token": "Admin Token"
}

If you call API without header, the system will return the message as below:

{
  	"error_type": "unauthenticated_error",
   	"success": false,
   	"error":    {
      	"message": "No header X-Auth-Token present",
      	"code": 110,
      	"reason": "auth_token_not_provided"
   	}
}

JSON RESPONSE

There is message return as JSON format. It will return the result of API and the related information as well.

If successful, the server will return code 200 with the message as below:

{
   	"success": true
}

If the Token wrong, it will return code 401 with a message as below:

{
 	"error_type": "unauthenticated_error",
  	"success": false,
  	"error": {
    	"message": "No header X-Auth-Token present",
    	"code": 110,
    	"reason": "auth_token_not_provided"
  	}
}

If you provide the wrong User_id, the server will return code 404 with a message as below:

{
  "error_type": "Object not found error",
  "success": false
}

On this page:

EXAMPLE

We will know more about the API through the example below:

Request

I will call API to Delete the User with Role_ID=3:

curl \
-H "X-Auth-Token: eyaskjksadkasd9.9123kjsadhkj123jhasdjajsjsdhKS.IH5uHASSJsadnbads980asTHo9dhljM" \
-X DELETE "http://88.99.175.131:8000/v1/user/all?role_id=3"

Response

{
	"success": true
}