openspecimen/rest/ng/users/{userId}
Use this resource to update the user. Use HTTP PUT 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 |
|---|---|
| userId | User id of the user |
| firstName | First name of the user |
| middleName | Middle name of the user |
| domainName | It is the name of the authentication domain. You cannot able to change domain of the user once user has been created |
| emailAddress | Email address of the user. This attribute should be unique in openSpecimen application |
| loginName | Login name through which user can login to openSpecimen application, should be unique in authentication domains. You cannot able to change domain of the user once user created |
| userSiteNames[Optional] | Collection of the site names to which the user belongs. By default it will be none. i.e. blank collection |
| userCPRoles[Optional] | Collection of the collection protocol titles and their role names to which user belongs. By default it will be none. i.e. blank collection. Mainly contains following parameters : roleName : Role of user like Scientist, Admin etc. For this attribute role must be present in application. cpTitle : Collection Protocol title. For this attribute CP must be present in application. |
| activityStatus | Activity status of the user, permissible values are {active, closed, pending, disabled} |
| deptName | Name of department to which user belongs |
| comments [optional] | Comments on user given by admin while approval |
| country | Country of the user |
| state [optional] | State of the user |
| city [optional] | City of the user |
| zipCode | Zip code of the user |
| phoneNumber [optional] | Phone number of the user |
| faxNumber [optional] | Fax number of the user |
http[s]:<host>:<port>/openspecimen/rest/ng/users/{userId}
Use this URL to update user in openSpecimen application.
Result:
The response of this request will contains the details of the updated user.
Below is the example of the update user:
| URL | openspecimen/rest/ng/users/{userId} |
| Method | PUT |
| Request | application/json |
| json | { "lastName":"Piterson", "firstName":"Sam", "domainName":"catissue", "emailAddress":"sam.piterson@live.com", "loginName":"samPiterson", "userSiteNames":["My group"], "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}], "activityStatus":"Active", "deptName":"Department of onchology", "comments":"bla bla bla", "city":"Jalgaon", "state":"Maharashtra", "country":"India", "zipCode":"425022", "faxNumber":"434343AS", "phoneNumber":"654323" } |
Response | { "id" : 1, "lastName":"Piterson", "firstName":"Sam", "domainName":"catissue", "emailAddress":"sam.piterson@live.com", "loginName":"samPiterson", "userSiteNames":["My group"], "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}], "activityStatus":"Active", "deptName":"Department of onchology", "comments":"bla bla bla", "city":"Jalgaon", "state":"Maharashtra", "country":"India", "zipCode":"425022", "faxNumber":"434343AS", "phoneNumber":"654323" } |
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | User has been updated successfully |
| 400 | All requests | Invalid parameters, e.g duplicate login name, duplicate email address, blank first name etc |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 404 | All requests | User not found, user with given details not present in the system |
| 500 | All requests | Internal server error, encountered server error while performing operations |