DELETE Delete User API

This API will delete a particular user from the specified company.

Request Attributes

API Content Type: JSON

Head

ATTRIBUTE DESCRIPTION
x-access-token
string
mandatory
Token generated from the authentication api.
Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.TU5NzgyMDA1N30.9eO_xh eyJEYXRhIjp7InVzZXJpZCI6IjY3NCIsImVtYWlsIjoiYWFhYWFhYWFhYWjuunGJQ YmwuY29tIiwia2V5IjoidGVzdGluZ0tleSJ9LCJpYXQiOjE1OTc3NDA4NTpj6gc8dM csIFhY7n1mV4cUBxa2P3ICI6M2VyWq19OzuHAefeTEj

body

ATTRIBUTE DESCRIPTION
company_id
string
mandatory
It is the id of the company from which the user needs to be deleted, it can be found from the developer console in company module in KONSIGN.
Example: ZmE1MjAI3Nzc4MmUyYjYtZTtyMDE4NIY0ZS00MTY3LWNjTM1Ng==
user_id
numeric
mandatory
It is Id of the user which will be deleted from the specified company.
Example: 1129
email
string
mandatory
It is the email address of the user.
Example: govyanshi.upadhyay@konze.com

Response Attributes

API Content Type: JSON

body

ATTRIBUTE DESCRIPTION
statuscode
string(3)
This is the status code corresponding to a particular message and is returned to the user. The different status codes corresponding to this API are mentioned below
Example: 200
status
boolean
This parameter indicates the status of API call.
Possible Values: true or false
message
string(100)
This parameter is the result message which contains information about the result.
Example: User deleted successfully.
user_id
string
It is Id of the user which will be deleted from the specified company, it can be fetched from developer console in company module in KONSIGN.
Example: ZmE1MjAI3Nzc4MmUyYjYtZTtyMDE4NIY0ZS00MTY3LWNjTM1Ng==

Response Codes and Messages

statuscode status Description
200
true
 Success
422
false
 Invalid parameter
500
false
 System error
https://console.konsign.com/api/user/delete
https://console.konsign.com/api/user/delete
REQUEST RESPONSE 
                                            
                                                var request = require('request');
                                                var options = {
                                                'method': 'DELETE',
                                                'url': 'https://console.konsign.com/api/user/delete',
                                                'headers': {
                                                    'Content-Type': 'application/json',
                                                    'Authorization': 'Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJEYXRhIjp7InVzZXJpZCI6IjU0NiIsImVtYWlsIjoiaGl0ZXNoLmpvc2hpQGtvbnplLmNvbSIsImFwcEtleSI6IjNhNjI4N2U3LTNkOTItNDVjNy04YTk2LTg0MjAyMjA0MDc1MiIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjgzMDExNjU5LCJleHAiOjE2ODMwOTA4NTl9.qx4DOIupSn2CnEPzM4KjXoceXsULF8eUogxBHbI4hmk'
                                                },
                                                body: JSON.stringify({
                                                    "company_id": "39",
                                                    "user_id": "1096",
                                                    "email": "yogesh.sonavane@konze.com"
                                                })

                                                };
                                                request(options, function (error, response) {
                                                if (error) throw new Error(error);
                                                console.log(response.body);
                                                });

										    
									

                                            var client = new HttpClient();
                                            var request = new HttpRequestMessage(HttpMethod.Delete, "https://console.konsign.com/api/user/delete");
                                            request.Headers.Add("Authorization", "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJEYXRhIjp7InVzZXJpZCI6IjU0NiIsImVtYWlsIjoiaGl0ZXNoLmpvc2hpQGtvbnplLmNvbSIsImFwcEtleSI6IjNhNjI4N2U3LTNkOTItNDVjNy04YTk2LTg0MjAyMjA0MDc1MiIsImtleSI6InByb2R1Y3Rpb25LZXkifSwiaWF0IjoxNjgzMDExNjU5LCJleHAiOjE2ODMwOTA4NTl9.qx4DOIupSn2CnEPzM4KjXoceXsULF8eUogxBHbI4hmk");
                                            var content = new StringContent("{\r\n    \"company_id\":\"39\",\r\n    \"user_id\":\"1096\",\r\n    \"email\":\"yogesh.sonavane@konze.com\"\r\n}", null, "application/json");
                                            request.Content = content;
                                            var response = await client.SendAsync(request);
                                            response.EnsureSuccessStatusCode();
                                            Console.WriteLine(await response.Content.ReadAsStringAsync());

										
									
										{
											"head": {
												"responseTimestamp": "1526969112101",
												"version": "v1",
												"clientId": "C11",
												"signature": "TXBw50YPUKIgJd8gR8RpZuOMZ+csvCT7i0/YXmG//J8+BpFdY5goPBiLAkCzKlCkOvAQip/Op5aD6Vs+cNUTjFmC55JBxvp7WunZ45Ke2q0="
											},
											"body": {
												"resultInfo": {
													"resultStatus": "S",
													"resultCode": "0000",
													"resultMsg": "Success"
												},
												"txnToken": "fe795335ed3049c78a57271075f2199e1526969112097",
												"isPromoCodeValid": false,
												"authenticated": false
											}
										}