AVAILABLE WITH BUSINESS SUBSCRIPTION

POST /performance-management/appraisal/session/{sessionId}/employee-card/add

Permissions to Run the Request

Account Owner and Account Administrators

Request Headers

HeaderDescription
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
ParameterDescription
sessionId (required)The session ID
cards [] (required)An array containing data about the employee and the reviewers
employeeId (required)The employee ID
reviewers [] (required)An array with reviewers' data
reviewerId (required)The reviewers' ID
role (required)

Reviewers' roles

  • REVIEWER_ROLE_SELF_REVIEW — self-assessment
  • REVIEWER_ROLE_DIRECT_MANAGER — manager
  • REVIEWER_ROLE_PEER — colleagues
  • REVIEWER_ROLE_DIRECT_REPORT — subordinates
  • REVIEWER_ROLE_CUSTOMER — customers
  • REVIEWER_ROLE_EXPERT — experts

Response Codes

CodeTextDescription
200The request has been successfully processed
400Bad requestA request error
401UnauthorizedAn authorization error

Sample Request

POST /performance-management/appraisal/session/4bba0d8f-1552-11f0-91a5-02420aff005f/employee-card/add
Host: api-learn.ispringlearn.com
Content-Type: application/json
Accept: application/json
X-Auth-Account-Url: https://myaccount.ispringlearn.com
Authorization: Bearer YHcrg8zMRSotoNTVWGzrCTPTlprXubeN8TnFEDFjJ9g

{
  "cards": [
    {
      "employeeId": "66c8714c-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "65a08920-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "65a08920-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "63f72353-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "67c46021-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "67512cbf-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "65037ca5-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "65037ca5-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    },
    {
      "employeeId": "6866b407-137f-11f0-ad73-02420aff0051",
      "reviewers": [
        {
          "reviewerId": "6866b407-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_SELF_REVIEW"
        },
        {
          "reviewerId": "66c8714c-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_MANAGER"
        },
        {
          "reviewerId": "63f72353-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_PEER"
        },
        {
          "reviewerId": "67512cbf-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_DIRECT_REPORT"
        },
        {
          "reviewerId": "67c46021-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_CUSTOMER"
        },
        {
          "reviewerId": "68127983-137f-11f0-ad73-02420aff0051",
          "role": "REVIEWER_ROLE_EXPERT"
        }
      ]
    }
  ]
}
XML

Sample Response

HTTP/1.1 200 OK 
XML