openspecimen/rest/ng/users
or
openspecimen/rest/ng/users?maxResults={maxResults}
Use this resource to get users. This API returns all the users present in the openSpecimen application. User can also specify the search string which will be used to match the values.
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 |
|---|---|
| maxResults | maximum number of records to fetch. By default it will be 1000 |
http[s]:<host>:<port>/openspecimen/rest/ng/users
or
http[s]:<host>:<port>/openspecimen/rest/ng/users?maxResults={maxResults}
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 |
| Method | GET |
| Request | application/json |
Response | [{ "id" : "1", },{ "id" : "2", "lastName":"Mike", "firstName":"Hussey", "loginName":"mikeHussey" }]
|
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 |