Page Comparison

...

Use this resource to update the user in OpenSpecimen application. Use HTTP PUT method to call invoke 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
userIdid	User id ID of the user to be updated
firstName	First name of the user
middleNamelastName	Middle Last 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 applicationemailAddress	Email address of the user. This is a unique key for the users.
phoneNumber	Phone number of the user, By default it will be blank
domainName	Name of the authentication domain . For providing domain name, domain should be already registered in application. By default, it is 'openspecimen'.
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
sign-in to OpenSpecimen. This is a unique within the authentication domain.
instituteName	Institute to which the user is affiliated.
primarySite	Primary work site/lab of the user. This is an optional field.
type	User type. Permissible values are - SUPER, INSTITUTE, NONE. When set to SUPER, the user will be super administrator. The values INSTITUTE and NONE are for institute admin and regular users respectively.
manageForms	Boolean indicating whether user has rights to create/update custom forms. Default value is false.
address	Address of the user. This is an optional field
activityStatus	User status. The allowed values are - Active, Locked, Pending, Disabled.

http[s]:<host>:<port>/openspecimen/rest/ng/users/{userId}

Use this URL to update user in openSpecimen application.

...

"
{
    "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

URL

openspecimen/rest/ng/users/{userId}1

Method

PUT

Request

application/json

json{

Code Block

language	js
theme	Eclipse
linenumbers	true

{
    "id": 1,
    "lastName": "

Piterson

Admin",


    "firstName": "

Sam

Admin",


    "domainName": "

catissue

openspecimen",


    "emailAddress": "

sam

admin@admin.

piterson@live.

com",

"loginName


    "phoneNumber": "

samPiterson

1234567890",

"userSiteNames


    "loginName":

["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

 "admin@admin.com",
    "activityStatus": "Active",
    "type": "SUPER",
    "instituteName": "Hospital for Rare Diseases",
    "address": "HRD, New City"
}

Response

Code Block

language	js
theme	Eclipse
linenumbers	true

{
    "id": 1,
    "lastName": "Admin",
    "firstName": "Admin",
    "domainName": "openspecimen",
    "emailAddress": "admin@admin.com",
    "phoneNumber": " 1234567890",
    "loginName": "admin@admin.com",
    "creationDate": 1548909110207,
    "activityStatus": "Active",
    "instituteName": "Hospital for Rare Diseases",
    "type": "SUPER",
    "address": "HRD, New City"
}

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

...

Versions Compared

Old Version 23

New Version Current

Key