/icws/{sessionId}/agent-quality/scorecards/{scorecardId}

GET

/icws/{sessionId}/agent-quality/scorecards/{scorecardId}

Retrieves all data for the specified scorecard. Users must have the View Scorecards policy right as well as ACL view rights for the scorecard's questionnaire directory. Agents may only access their own completed scorecards.
Feature Version
quality-management 3

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Template
        scorecardId

        Required

        The ID of the scorecard being viewed/edited.

          Response

          200 - OK
          Returns information about the scorecard and its associated answers.
          Property
          Value
          Comments
          id
          String

          Required

          The unique ID of this scorecard.
          questionnaireId
          String

          Required

          The ID of the questionnaire used for this scorecard.
          recordingId
          String
          The ID of the recording being scored.

          This property can be null.

          scoringUser
          String
          The user assigned to complete the scorecard.

          This property can be null.

          scoredUser
          String
          The user being scored.

          This property can be null.

          invalid
          0
          assigned
          1
          inProgress
          2
          complete
          3
          score
          Double

          Required

          The overall score for this scorecard.
          scorePct
          Double

          Required

          The overall score percentage for this scorecard.
          rank
          String
          The overall rank for this scorecard.

          This property can be null.

          maxScore
          Double
          The maximum possible score for all questions answered.

          This property can be null.

          minScore
          Double
          The minimum possible score for all questions answered.

          This property can be null.

          scoringDate
          DateTime
          The date this scorecard was last updated or completed.

          This property can be null.

          assignedPolicy
          String
          The policy that assigned this scorecard.

          This property can be null.

          nonCriticalMaxScore
          Double
          The maximum possible score for all non-critical questions answered.

          This property can be null.

          nonCriticalMinScore
          Double
          The minimum possible score for all non-critical questions answered.

          This property can be null.

          nonCriticalScore
          Double
          The score for all non-critical questions answered.

          This property can be null.

          criticalScore
          Double
          The score for all critical questions answered.

          This property can be null.

          numAnsweredCritical
          Int
          The number of critical questions answered.

          This property can be null.

          numPositiveAnsweredCritical
          Int
          The number of boolean critical questions answered positively.

          This property can be null.

          isFailed
          Boolean
          True if this scorecard is considered failed.

          This property can be null.

          none
          0
          marked
          1
          required
          2
          notRequired
          0
          inProgress
          1
          complete
          2
          signatureComments
          String
          The comments for the scorecard's signature.

          This property can be null.

          version
          Int

          Required

          The revision number for this scorecard.
          id
          String

          Required

          The unique ID of this answer.
          questionId
          String

          Required

          The ID of the question being answered.
          choiceSequence
          Int

          Required

          The sequence of the choice for this answer.
          score
          Double
          The score for this answer.

          This property can be null.

          rawAnswer
          String
          The raw answer string.

          This property can be null.

          comments
          String
          Comments made by the scoring user.

          This property can be null.

          isMarkedNA
          Boolean

          Required

          True if this answer has been marked N/A.
          version
          Int

          Required

          The revision number for this answer.
          questionGroupId
          String

          Required

          The unique ID of the question group.
          score
          Double

          Required

          The overall score for this question group.
          scorePct
          Double

          Required

          The scoring percentage for this question group.
          scoreMin
          Double

          Required

          The minimum score for all questions answered in this group.
          scoreMax
          Double

          Required

          The maximum score for all questions answered in this group.
          rank
          String

          Required

          The overall rank for this group.
          404 - Not Found
          The scorecard does not exist.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          403 - Forbidden
          The user is not authorized to view this scorecard.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          400 - Bad Request
          The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
          error
          Provides additional detail for an error.
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          401 - Unauthorized
          The specified session token is missing, invalid, or has expired.
          Parameters
          Type
          Name
          Comments
          Header
          WWW-Authenticate

          Required

          Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

          WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            410 - Gone
            This resource has been deprecated and removed from the API.
            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            500 - Internal Server Error
            An unexpected error occurred while processing the request.
            error
            Provides additional detail for an error.
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.