openspecimen/rest/ng/users
Use this resource to create new user in the openSpecimen application. Use HTTP POST 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:
| |
|---|
| firstName | First name of the user |
middleNameMiddle name | Last name of the user |
| emailAddress | Email Address of the user. This attribute should be unique in openSpecimen application |
| phoneNumber |
domainName[optional]| 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 the application. By default its openSpecimen |
in applicationemailAddress | Email Address of the user. This attribute should be unique openSpecimen | application |
| loginName | Login Name through which a user can |
login openSpecimen | the OpenSpecimen application |
, Collection | should be unique in authentication domains |
userSiteNames{optional] | site names | department 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 | |
type | Type of the user: - Super Administrator → "SUPER"
- Institute Administrator → "INSTITUTE"
- Regular User → "NONE"
- Contact User → "CONTACT"
|
| address[optional] | Address of the user |
| activity status | 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
Use this URL to add user in openSpecimen application.
Result:
The response of this request will contains the details of the created user.
Below is the example of the create user:
{ | language | js |
|---|
| theme | Eclipse |
|---|
| linenumbers | true |
|---|
| {
"id": 1,
"lastName": " |
|
Piterson Sam catissue sam.piterson@live "loginNamesamPiterson "userSiteNames["My group"], "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}], "admin@admin.com",
"activityStatus": "Active", |
|
Department of onchology "commentsbla 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 : |
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",
"siteNames":
[
],
"creationDate": null,
"activityStatus": "Active",
"instituteName": "A1 - For Demo Users",
"deptName": "Immunology",
"type": "SUPER",
"address": null
} |
|
| | |
|---|
| 200 | All resources | User has been created 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 |
| 500 | All requests | Internal server error, encountered server error while performing operations |