POST user/remove?Token={Token}
Remove user from the system. Privilege "Delete" of licensed agenda "Users" required. Functionality may also be restricted by record permission "Delete" of agenda "User"
Request Information
Authorization
- Authorization by token required
Availability
- Method can be used
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| Token |
The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds |
globally unique identifier |
Required |
Body Parameters
UserRemoveReq| Name | Description | Type | Additional information |
|---|---|---|---|
| LoginName |
Unique identification of the user in the system |
string |
Required String length: inclusive between 0 and 100 |
Request Formats
application/json
Sample:
{"LoginName":"John.Doo"}
application/xml
Sample:
<Request> <LoginName>John.Doo</LoginName> </Request>
Response Information
Response Codes
| Http Code | Error Number | Description |
|---|---|---|
| 200 request succesfully done | 0 | Processed with result: ExecOK |
| 400 bad request | 1002 | Entry parameter missing or parameter bindigs failed |
| 401 unauthorized | 1000 | Token {0} not found |
| 401 unauthorized | 1001 | Token {0} already expired |
| 401 unauthorized | 1006 | Ip filter violated for ip client address [{0}] |
| 401 unauthorized | 1007 | Ip filter [{0}] parsing failed |
| 401 unauthorized | 1008 | Request rate policy violated for [{0}] |
| 403 server refuses fo fulfill the request | 1407 | Privilege Delete of agenda Users violated for [LoginName {0}] |
| 403 server refuses fo fulfill the request | 1 | Db operation failed, agenda missing priviliges |
| 403 server refuses fo fulfill the request | 2 | Db operation failed, record missing priviliges |
| 403 server refuses fo fulfill the request | 3 | Db operation failed, Record duplicity |
| 403 server refuses fo fulfill the request | 4 | Db operation failed, already changed by another user |
| 403 server refuses fo fulfill the request | 5 | Db operation failed, already deleted by another user |
| 403 server refuses fo fulfill the request | 6 | Db operation failed, database data consistence violation |
| 403 server refuses fo fulfill the request | 7 | Db operation failed, operation can not be executed because another problems occured |
| 403 server refuses fo fulfill the request | 8 | Db operation failed, licence violation |
| 404 required resource does not exist on the server | 1400 | User for [LoginName {0}, ID_Firma {1}] not found or it could be a system user |
| 415 unsupported Media Type | The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported |
Resource Description
BaseRespOfUserRemoveReq| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | RequestResult |
None. |
|
| Request | UserRemoveReq |
None. |
Response Formats
application/json
Sample:
{"Result":{"Message":"Processed with result: ExecOK","Code":0,"ModelStateErr":null},"Request":{"LoginName":"John.Doo"}}
application/xml
Sample:
<Response>
<Result>
<Message>Processed with result: ExecOK</Message>
<Code>0</Code>
</Result>
<Request>
<LoginName>John.Doo</LoginName>
</Request>
</Response>