Versions Compared

Version Old Version 27 New Version Current
Changes made by

Vinayak Lonushte

Swapnil Ingle

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

Parameter
Details
firstName

First name of the user

lastNameLast name of the user
emailAddressEmail Address of the user. This attribute should be unique in openSpecimen application
phoneNumberPhone number of the user, By default it will be blank
domainNameName of the authentication domain . For providing domain name, domain should be already registered in the application. By default its openSpecimen in application
loginNameLogin Name through which a user can
login
log in to
openSpecimen
the OpenSpecimen application
,
should be unique in authentication domains
deptName
instituteNameName of the department to which the user belongs
admin

type

Set user as superadmin. values are {true, false}.

Type of the user:

  • Super Administrator → "SUPER"
  • Institute Administrator → "INSTITUTE"
  • Regular User → "NONE"
  • Contact User → "CONTACT"
address[optional]Address of the user
activityStatus
activity status

Activity status of the user, permissible values are

{active, closed, pending, disabled}


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:

URLhttp://<host>:<port>/openspecimen/rest/ng/users
MethodPOST
Requestapplication/json
json


Code Block
languagejs
themeEclipse
linenumberstrue
{
    "id": 1,
    "lastName": "Admin",
    "firstName": "Admin",
    "domainName": "openspecimen",
    "emailAddress": "admin@admin.com",
    "phoneNumber": "1234567890",
    "loginName": "admin@admin.com",
    "activityStatus": "Active",
    "deptName": "Immunology",
    "
admin
type":
true
"SUPER",
    "address": null
}


Response


Code Block
languagejs
themeEclipse
linenumberstrue
{
    "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
type":
true
"SUPER",
    "address": null
}



code
Applies to
Status Message
200All resourcesUser has been created successfully
400All requestsInvalid parameters, e.g  duplicate login name, duplicate email address, blank first name etc
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations