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

PUT

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

Acknowledges the specified scorecard for the session user by setting the signature state to completed.

Only the scored user or users authorized to override completed scorecards can update the signature.

On success, the scorecard's version is incremented by 1.

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.

          Representations
          ackScorecardRequest
          Property
          Value
          Comments
          comments
          String
          The comments for the scorecard's signature. This can be at most 2000 characters.

          This property can be null.

          version
          Int
          The version of the scorecard being acknowledged. If specified and this does not match the current version in the DB, a version mismatch error is returned. If null the scorecard will be acknowledged regardless of the version found in the DB.

          This property can be null.

          Response

          204 - No Content
          The scorecard signature has been updated.
          404 - Not Found
          The scorecard ID 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 acknowledge 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. This may also occur when the version specified does not match the server.

          Error Responses

          Error Identifier
          Error Type
          Error Description
          error.request.qualityManagement.versionMismatch
          Type: urn:inin.com:common:error
          The specified version does not match the current version on the server.
          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.