Content Comparison

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:

[optional]

Parameter	Details
firstName	First name of the user
middleNamelastName	Middle 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 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 deptName	Name of 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.

admin	Set user as superadmin. values are {true, false}.
address[optional]	Address of the user
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

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:

URL http://<host>:<port>/openspecimen/rest/ng/users

Method POST

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.piterson@live

admin@admin.com",

"loginName


    "phoneNumber": "

samPiterson

1234567890",

"userSiteNames


    "loginName":

["My group"],
    "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}],
    "activityStatus":"Active",

 "admin@admin.com",
    "activityStatus": "Active",
    "deptName": "

Department of onchology

Immunology",

    "comments":"bla 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 :


    "admin": true,
    "address": null
}

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",
    "admin": true,
    "address": null
}

code	Applies to	Status Message
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

Version	Old Version 26	New Version 27
Changes made by	Darpan Patil	Vinayak Lonushte
Saved on	Jul 30, 2014	Jan 03, 2016

Versions Compared

Key