This API available for patch the user object. You can patch user through the HTTP PATCH URL http://<host>:<port>/catissuecore/openspecimen/rest/ng/users/{userId} id}
Use this resource to patch the user. Use HTTP PATCH 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:
Mandatory Fields :
- User Idid
Non Patchable Fields :
- Login Namename
- Domain Namename
Parameter | Details | userId||
|---|---|---|---|
| User id of the User | firstName | First name of the user | |
| middleName | Middle name of the user | ||
| domainName[optional] | Name of the authentication domain . You cannot able to change domain of the user once user created For providing domain name, domain should be already registered in application. By default its openSpecimen in application | ||
| emailAddress | Email Address of the user. This attribute should be unique in catissue openSpecimen application | ||
| loginName | Login Name through which user can login to catissue openSpecimen application, should be unique in authentication domains. You cannot able to change domain of the user once user created | siteNames | Name of the sites |
| userSiteNames{optional] | Collection of the site names to which the user belongs | cpTitles | Name of the collection protocols . 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, By default it will be blank | ||
| country | Country of which the user belongs | ||
| state [optional] | State of which the user belongs, By default it will be blank | ||
| city [optional] | City of which the user belongs, By default it will be blank | ||
| zipCode [optional] | Zip Code code of location which the user belongs, By default it will be blank | ||
| phoneNumber [optional] | Phone number of the user, By default it will be blank | ||
| faxNumber [optional] | Fax number of the user, By default it will be blank |
http[s]:<host>:<port>/openspecimen/rest/ng/users/{id}
Use this URL to patch user in openSpecimen application.
Result:
The response of this request will contains the details of the patched user
...
API Example .
Below is the example of the patch user:
Method | URL |
|---|---|
| URL | catissuecoreopenspecimen/rest/ng/users/{userId}1 |
| Method | PATCH |
| Request | application/json |
| json | { "lastName":"Piterson", "firstName":"Sam" } |
Response | { "id" : " 1", "lastName":"Piterson", "firstName":"Sam", "domainName":"catissue", "emailAddress":"sam.piterson@live.com", "loginName":"samPiterson", "siteNamesuserSiteNames":["My group", "New Site"], "cpTitlesuserCPRoles":[{"roleName":"MyCpScientiest1","Test Cp"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 Namelogin name, duplicate Email Addressemail address, blank First Name 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 |
...