AVAILABLE WITH BUSINESS SUBSCRIPTION

GET /performance-management/appraisal/session/{sessionId}/results

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.
Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.

Parameters

ParameterTypeDescription
sessionId (required)stringID of the session to get results for

showIndicatorsWithoutResult (optional)

booleanIf true, indicatorResults also includes indicators that have not been answered. For such indicators, the result field is not returned.

showScoreByRoles (optional)

booleanIf true, the method calculates results by respondent role and returns them in the rolesScore array for competencies and indicators.

The showIndicatorsWithoutResult and showScoreByRoles parameters can be used together. In this case, the method returns indicators that have not been answered and calculates competency and indicator results by respondent role.

Response Parameters

ParameterTypeDescription
employeeIdstring (uuid)ID of the employee being evaluated.
sessionIdstring (uuid)Session ID
competencyResultsarrayCompetency results
indicatorResultsarrayIndicator results

Elements of the competencyResults array

ParameterTypeDescription
competencyIdstring (uuid)Competency ID
resultnumberCompetency result
roleScoresarrayCompetency results grouped by respondent role. If the showScoreByRoles parameter is not specified, an empty array is returned.

Elements of the indicatorResults array

ParameterTypeDescription
indicatorIdstring (uuid)Competency indicator ID
resultnumberIndicator result. The field is not returned if the indicator has not been answered and showIndicatorsWithoutResult=true is specified.
roleScoresarrayIndicator results grouped by respondent role. If the showScoreByRoles parameter is not specified, an empty array is returned.

Elements of the roleScores array

ParameterTypeDescription
rolestringRespondent role for which the result was calculated.
resultnumberResult for the specified respondent role.

Response Codes

Code

Text

Description

200OK

The request has been successfully processed.

400Bad RequestA request error.
401UnauthorizedAn authorization error
403Permission deniedNo permission to run this request. 
Only the Account Owner and Account Administrators can run this request.

Sample Request

GET /performance-management/appraisal/session/{sessionId}/results?showScoreByRoles=true
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer N3Hk5sds1_DVj1JFTqJKFWjGHf94DWp1YSffLxeZX8co
CODE

Sample Response

[
  {
    "employeeId": "f542747b-b58b-11f0-b050-fec9f8c9e785",
    "sessionId": "c4ab978a-8bfa-11f1-9b4a-1630a5862f1c",
    "competencyResults": [
      {
        "competencyId": "11caed28-8beb-11f1-bfbd-d281c6a423c2",
        "result": 2,
        "roleScores": [
          {
            "role": "REVIEWER_ROLE_PEER",
            "result": 2
          }
        ]
      }
    ],
    "indicatorResults": [
      {
        "indicatorId": "35f5e15e-8beb-11f1-bfbd-d281c6a423c2",
        "result": 2,
        "roleScores": [
          {
            "role": "REVIEWER_ROLE_PEER",
            "result": 2
          }
        ]
      }
    ]
  }
]
CODE