...
openspecimen/rest/ng/users?start={start}&max={maxResults}&searchString={searchString}&countReq={maxResultstrue/false}
Use this resource to get users. This API returns all the users present in the openSpecimen application.
...
Below are the attributes which need to be sent in the request body:
Parameter | Details |
|---|---|
| searchString | 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, Identifier. |
| start | start index of the results |
| maxResults | Maximum number of records to fetch. By default it will be 1000 |
http[s]:<host>:<port>/openspecimen/rest/ng/users
...
| 50 | |
| countReq | Set this parameter to true, if want to get the total count of matching results. |
http[s]:<host>:<port>/openspecimen/rest/ng/users?maxResults={maxResults}
Use this URL to get users in openSpecimen application.
...
| URL | http://<host>:<port>/openspecimen/rest/ng/users?searchString=Piterson |
| 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 |