openspecimen/rest/ng/users
or
openspecimen/rest/ng/users?start={start}&max={maxResults}&searchString={searchString}&name={name}&loginName={loginName}&institute={institute}&activityStatus={activityStatus}
Use this resource to get users. This API returns all the matching users based on the searchString, if searchString not specified then it returns all the users 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 |
|---|---|
| start [optional] | start index of the results |
| maxResults [optional] | Maximum number of records to fetch. By default it will be 50 |
| searchString [optional] | The value with which you want to search the User. The given value will be matched with First Name, Last Name, Login Name, Email Address. |
| name | The value given will be matched with First Name, and Last name of the user |
| loginName | The given value will be matched with loginName of the user |
| institute | Result contains the users which belongs to given institute |
| activityStatus | Result contains the users which have given activityStatus |
http[s]:<host>:<port>/openspecimen/rest/ng/users
Use this URL to get users in openSpecimen application.
Result:
The response of this request will contains the details of the users.
Below is the example of the get users:
| URL | http://<host>:<port>/openspecimen/rest/ng/users?searchString=admin |
| Method | GET |
| Request | application/json |
Response | [
{
"id": 1,
"firstName": "Admin",
"lastName": "Admin",
"loginName": "admin@admin.com",
"domain": null,
"emailAddress": "admin@admin.com",
"admin": null,
"cpCount": 0,
"creationDate": null
},
{
"id": 100,
"firstName": "Bocabio",
"lastName": "Admin",
"loginName": "Bocabio@admin.com",
"domain": null,
"emailAddress": "Bocabio@admin.com",
"admin": null,
"cpCount": 0,
"creationDate": 1437589800000
}
]
|
Error Cases :
code | Applies to | Status Message |
|---|---|---|
| 200 | All resources | Users got successfully |
| 401 | All requests | Authorization failed, user doesn’t have authority |
| 500 | All requests | Internal server error, encountered server error while performing operations |