catissuecoreopenspecimen/rest/ng/users
Use this resource to create new user in the caTissue 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 Last name of the user |
emailAddress |
domainName[optional]Email Address of the user. This attribute should be unique in openSpecimen application |
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 the application. By default its |
catissue
openSpecimen in application |
emailAddressEmail Address of the user. This attribute should be unique in catissue application | loginName | Login Name through which a user can |
login catissue 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 CollectionuserCPRoles[Optional] | Collection of the Collection Protocol names and their Role names to which user belongs. By default it will be none. i.e. Blank Collection |
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 blankcity [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>/catissuecoreopenspecimen/rest/ng/users
Use this URL to add user in caTissue openSpecimen application.
Result:
The response of this request will contains the details of the created user.
Below is the example of the create user:
catissuecoreopenspecimen/rest/ng/users |
Method | POST |
Request | application/json |
json | |
{ Piterson Sam catissue sam.piterson@live "loginNamesamPiterson "userSiteNames["My group"], "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}], "activityStatus":"Active", "admin@admin.com",
"activityStatus": "Active",
"deptName": " |
|
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 Email Address First Name first name etc |
401 | All requests | Authorization failed, |
User Authorityauthority |
500 | All requests | Internal server error, |
Encountered encountered server error while performing operations |