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.
e.g. 22, 23 etc.
|
Error Cases :
code | Applies to | Status Message |
---|---|---|
200 | All resources | |
400 | All requests | Invalid parameters, this will also includes application specific error messages |
User has been deleted/closed successfully | ||
401 | All requests | Authorization failed, user doesn’t have authority |
404 | All requests | Resource User not found, also includes specified resource id/name/titleuser with given details not present in the system |
500 | All requests | Internal server error, encountered server error while performing operations |