Versions Compared

Key

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

This API available for creating new user.

 

Mandatory Fields :

  1. First Name
  2. Last Name
  3. Email Address
  4. Domain Name
  5. Login Name
  6. Site Names
  7. CP Titles
  8. Activity Status
  9. Department Name

Unique Fields :

  1. Login Name (Should be unique in same domain)
  2. Email Address

 

Method
URL
POSTcatissuecore/rest/ng/users

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 log in to the OpenSpecimen application should be unique in authentication domains
instituteNameName of the department to which the user belongs

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}


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": "
Piterson
Admin",

    

    "firstName": "
Sam
Admin",

    

    "domainName": "
catissue
openspecimen",

    

    "emailAddress": "
sam.piterson@live
admin@admin.com",

    "loginName

    "phoneNumber": "
samPiterson
1234567890",

    "siteNames

    "loginName":
["My group
 "admin@admin.com",
"New Site"],
    "cpTitles":["MyCp", "Test Cp"],
    "

    "activityStatus": "Active",

    

    "deptName": "
Department of onchology
Immunology",

    "comments

    "type": "
bla bla bla
SUPER",

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


    "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",
    "type": "SUPER",
    "address": null
}



code
Applies to
Status Message
200All resources
 
User has been created successfully
400All requestsInvalid parameters,
this will also includes application specific error messages
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