This API available for creating new user. You can create user through the HTTP POST URL http://<host>:<port>/catissuecore/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 | 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 in applicationemailAddress | Email Address of the user. This attribute should be unique in catissue openSpecimen in application |
| loginName | Login Name through which a user can |
login catissue | the OpenSpecimen application |
, | should be unique in authentication domains |
siteNames sites | department to which the user belongs |
| cpTitles | Name of the collection protocols to which user belongs. |
activityStatustype | 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 |
| country | Country of the user |
| state [optional] | state of the user |
| city [optional] | city of the user |
| zipCode | zipCode of the user |
| phoneNumber [optional] | Phone number of the user |
| faxNumber [optional] | Fax number of the user |
API Example 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:
catissuecore| openspecimen/rest/ng/users |
| Method | POST |
| Request | application/json |
| json |
{
| Code Block |
|---|
| language | js |
|---|
| theme | Eclipse |
|---|
| linenumbers | true |
|---|
| {
"id": 1,
"lastName": " |
|
Piterson Sam catissue sampiterson@live. "loginNamesamPiterson "siteNames["My group", "New Site"], "cpTitles":["MyCp", "Test Cp"], "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",
"siteNames":["My group", "New Site"],
"cpTitles":["MyCp", "Test Cp"],
"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 Authority| authority |
| 500 | All requests | Internal server error, |
Encountered | encountered server error while performing operations |