Patch User

openspecimen/rest/ng/users/{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 id

Non Patchable Fields :

Login name
Domain name

Parameter	Details
firstName	First name of the user
middleName	Middle name of the user
domainName[optional]	Name of the authentication domain . 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 openSpecimen application
loginName	Login Name through which user can login to openSpecimen application, should be unique in authentication domains
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, 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 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.

Below is the example of the patch user:

Method	URL
URL	openspecimen/rest/ng/users/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", "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