Versions Compared

Version Old Version 25 New Version Current
Changes made by

Darpan Patil (Deactivated)

Swapnil Ingle

Saved on

Key

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

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:

Parameter
Details
firstName

First name of the user

middleName
lastName
Middle name
Last 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
domainName
[optional]
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
loginNameLogin Name through which a user can
login
log in to
catissue
the OpenSpecimen application
, Collection
should be unique in authentication domains
userSiteNames{optional]
instituteNameName of the
site names
department to which the user belongs
. By default it will be none. i.e. Blank collectionuserCPRoles[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.

 

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}

deptNameName of department to which user belongscomments [optional]Comments on user given by admin while approval, By default it will be blankcountryCountry of which the user belongsstate [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 blankzipCode [optional]Zip Code of location which the user belongs, By default it will be blankphoneNumber [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:

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


Code Block
language
{
   
js
themeEclipse
linenumberstrue
{
    "id": 1,
    "lastName": "
Piterson
Admin",

    

    "firstName": "
Sam
Admin",

    

    "domainName": "
catissue
openspecimen",

    

    "emailAddress": "
sam
admin@admin.
piterson@live.
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

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


    "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 resourcesUser has been created successfully
400All requestsInvalid parameters, e.g  duplicate
Login Name
login name, duplicate
Email Address
email address, blank
First Name
first name etc
401All requestsAuthorization failed,
User
user doesn’t have
Authority
authority
500All requestsInternal server error,
Encountered
encountered server error while performing operations

 

 

 

 

...