AVAILABLE WITH ENTERPRISE SUBSCRIPTION

POST /performance-management/appraisal/session/{sessionId}/start

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

sessionIds
(required)

The ID of the session to start.

Existing customers may continue using ispringlearn.com, and new customers should use ispring.com.

Response Codes

Code

Text

Description

200OK

The request has been successfully processed.

  • SUCCESS — the session has been successfully started.
  • ALREADY_STARTED — the session has "In progress" or "Completed" status,
  • EMPTY_PROFILE — no competencies in the profile selected for the session,

  • NO_PROFILE — the competency profile is not selected for the session,

  • NO_EMPLOYEES —  there are no employees to evaluate in the session,
  • NO_REVIEWERS — there are no reviewers in the session.
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.
404Session not foundThe session was not found. 

Sample Request

POST ​/performance-management​/appraisal​/session​/{sessionId}​/start
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

SUCCESS
CODE