Versions Compared

Key

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

catissuecoreopenspecimen/rest/ng/users/{userIdid}?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
userIdidUser Id id of the user
close[optional]User will be closed if given value is true


http[s]:<host>:<port>/catissuecoreopenspecimen/rest/ng/users/{id}

Use this URL to close delete user in caTissue openSpecimen application.

Result:

The response of this request will contains the details of the closed deleted user.

Below is the example of the close delete user:

URLhttp://<host>:<port>/catissuecoreopenspecimen/rest/ng/users/{userId}134
MethodDELETE
Requestapplication /json

Response

Code Block
"success"
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 :

code
Applies to
Status Message
200All resourcesUser has been deleted/closed successfully
401All 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

...