Versions Compared

Key

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

openspecimen/rest/ng/users/{userIdid}

Use this resource to get user. This API returns user present in the openSpecimen application. Use HTTP GET 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
userIdidUser id to fetch the user

...

http[s]:<host>:<port>/openspecimen/rest/ng/users/{userIdid}


Use this URL to get user by an id in openSpecimen application.

...

Below is the example of the get user :

URL

http://<host>:<port>/catissuecoreopenspecimen/rest/ng/users/31

MethodGET
Requestapplication/json

Response

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

    "userSiteNames

    "loginName":
["My group"],
    "userCPRoles":[{"roleName":"Scientiest1","cpTitle":"My Cp1"}],
   
 "admin@admin.com",
    "siteNames":
    [
    ],
    "creationDate": null,
    "activityStatus": "Active",

    "deptName

    "instituteName":
"Department of onchology",
    "comments":"bla bla bla",
    "city":"Jalgaon",
    "state":"Maharashtra",
    "country":"India",
    "zipCode":"425022",
    "faxNumber":"434343AS",
    "phoneNumber":"654323"
 "A1 - For Demo Users",
    "deptName": "Immunology",
    "admin": true,
    "address": null
}

 

Error Cases :

code
Applies to
Status Message
200All resourcesUser got successfully
401All requestsAuthorization failed, user doesn’t have authority
500All requestsInternal server error, encountered server error while performing operations