Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
idUser 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:

URLhttp://<host>:<port>/openspecimen/rest/ng/users/134
MethodDELETE
Requestapplication /json

Response

"success"

 

Parameter Details :

{id} :  User Id.

...

Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 134,
    "lastName": "Snow",
    "firstName": "Jon",
    "domainName": "openspecimen",
    "emailAddress": "jon.snow@domain.com_1451816544148",
    "phoneNumber": " 1234567890",
    "loginName": "jon.snow@domain.com_1451816544148",
    "siteNames":
    [
    ],
    "creationDate": 1451759400000,
    "activityStatus": "Disabled",
    "instituteName": "A1 - For Demo Users",
    "deptName": "Immunology",
    "admin": false,
    "address": null
}

 

 Error Cases :

All requests
code
Applies to
Status Message
200All resourcesUser has been deleted/closed successfully400
Invalid parameters, e.g  duplicate Login Name, duplicate Email Address, blank First Name etc401All requestsAuthorization failed, User user doesn’t have Authorityauthority
404All requestsUser not found, User user with given details not present in the system
500All requestsInternal server error, Encountered encountered server error while performing operations

...