(Quick Reference)
Service: Show a user
Description: Returns the requested user in json format when successful. Returns a json response, describing the failure condition when unsuccessful.
URL:
https://BASE_URL/api/VERSION/users/{id}:
https://BASE_URL/api/VERSION/users/reference/{id}: GET
Parameters:
| Name | Description | Type | Required | Example values |
|---|
| id | The unique ID of the desired user | Long/String | yes | 123 |
Success Output
Success case: response.status=200
{
"id": 1,
"email": "foobar@example.com",
"firstName": "John",
"lastName": "Doe",
"reference": "emp05",
"employee": {
"id": 5,
"href": "/api/v1.0/employees/5"
},
"enabled": true,
"organization": "entity1",
"dateCreated": "2015-12-15T08:55:36Z",
"lastUpdated": "2016-07-22T09:20:29Z"
} Failure Output
Failure case:response.status = 400
{
"error": "invalid_param_type",
"error_description": "The type of parameter id you provided is not valid for this request."
} Failure case:response.status = 404
{
"error": "not_found",
"error_description": "The user with the id 100 doesn't exist."
}
