Api :
...
Method
...
URL
...
openspecimen/rest/ng/users/{id}?close=true
Use this resource to delete/close the user in the application. Use HTTP DELETE method to call this API by passing the below details in JSON format.
Below are the attributes which need to be sent in the request body:
Parameter | Details |
---|---|
id | User id of the user |
close[optional] | User will be closed if given value is true |
http[s]:<host>:<port>/openspecimen/rest/ng/users/{id}
Use this URL to delete user in openSpecimen application.
Result:
The response of this request will contains the details of the deleted user.
Below is the example of the delete user:
URL | http://<host>:<port>/ openspecimen/rest/ng/users/134 |
Method | DELETE |
Request | application /json |
Response | "success" |
Parameter Details :
{id} : User Id.
...
|
Error Cases :
code | Applies to | Status Message | ||
---|---|---|---|---|
200 | All resources | User has been deleted/closed successfully | 400 | All requests|
Invalid parameters, e.g duplicate Login Name, duplicate Email Address, blank First Name etc | 401 | All requests | Authorization failed, User user doesn’t have Authorityauthority | |
404 | All requests | User not found, User user with given details not present in the system | ||
500 | All requests | Internal server error, Encountered encountered server error while performing operations |
...