GET/depts/{DeptId}/users/{UserId}

Applies to QAComplete�14.4, last modified on August 06, 2024

Returns information about a specified user.

Use this operation to get information about the specified user.

Authentication

Basic authentication using a user’s login and password. See Authentication for details.

Security Rights

The authenticating user must have administrator privileges.

Request Format

To get information on a user, send a GET request to the following URL:

http://{server}/rest-api/service/api/v1/depts/{DeptId}/users/{UserId}

DeptId  :  integer, required

The ID of the needed department.

UserId  :  integer, required

The ID of the needed user.

A sample request:

GET http://yourserver.com/rest-api/service/api/v1/depts/8162/users/24793 HTTP/1.1
Host: yourserver.com
Connection: keep-alive
Accept: application/json
Authorization: Basic am9obkBleGFtcGxlLmNvbTpwQHNzd29yZA==

A sample request made by using cURL:

curl -u [email protected]:p@ssword -H "Accept: application/json" http://yourserver.com/service/api/v1/depts/8162/users/24793

Response Format

If successful, the operation responds with HTTP status code 200 and returns a JSON object with information about the specified user.

If the operation fails, it returns the appropriate status code and (optionally) the error description in the response body.

A sample response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 507


{
"id": 24793,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"is_logged_on": false,
"is_security_admin": false,
"is_active": true,
"nbr_times_logon": 0,
"date_of_anniv": "1900-01-01T00:00:00.0000000",
"is_selected": false,
"update_user_id": 0,
"date_created": "2016-01-01T00:00:00.0000000",
"date_updated": "2016-01-01T00:00:00.0000000",
"discount": 0,
"import_id": 0,
"primary_dept_id": 8162,
"logon_attempts": 0,
"is_a_d_account": false
}

See Also

Users REST API Reference

Highlight search results