Getting User Information in Session
AVAILABLE WITH ENTERPRISE SUBSCRIPTION
POST /performance-management/appraisal/session/{sessionId}/user/attributes/list
Permissions to Run the Request
Account Owner and Account Administrators
Request Headers
Header | Description |
|---|---|
| Authorization (required) | Access token. You can obtain a token by making a request. |
| Content-Type: application/json (required) | Property for processing a request in JSON. |
| Accept: application/json (required) | Property for processing a request in JSON. |
| Parameter | Description |
sessionIds | Session ID |
userIds (required) | The ID of the user whose data we want to obtain. |
Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.
Response Parameters
| Parameter | Description |
|---|---|
| sessionId | Session ID |
| userId | User ID |
| displayingName | User's first and last name. If these are not provided, their login will be displayed instead. |
| initials | First letters of the first and last name or login. |
| departmentId | The ID of department this user is part of. |
| departmentName | The name of department this user is part of. |
| status | User status in the system:
|
| attributes | User profile fields. The date field uses the yyyy-mm-dd format. |
| key | Field ID |
| value | Field value |
| title | Field label in the interface |
Response Codes
Code | Text | Description |
|---|---|---|
| 200 | OK | The request has been successfully processed. |
| 400 | Bad Request | A request error. |
| 401 | Unauthorized | An authorization error. |
| 403 | Permission denied | No permission to run this request. Only the Account Owner and Account Administrators can run this request. |
| 404 | Session not found | The session was not found. |
Sample Request
POST /performance-management/appraisal/session/{sessionId}/user/attributes/list
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer N3Hk5sds1_DVj1JFTqJKFWjGHf94DWp1YSffLxeZX8co
{
"userIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}
CODE
Sample Response
[
{
"sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"displayingName": "string",
"initials": "string",
"departmentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"departmentName": "string",
"status": "ACTIVE",
"attributes": [
{
"key": "string",
"value": "2020-11-12",
"title": "USER_DEFINED_FIELD3"
}
]
}
]
CODE