Versions Compared

Key

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

openspecimen/rest/ng/users/{id}

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
idUser id to fetch the user


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


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

Result:

The response of this request will contains the details of the user.

Below is the example of the get user :

URL

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

MethodGET
Requestapplication/json

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