/icws/{sessionId}/agent-quality/questionnaires/{questionnaireId}

GET

/icws/{sessionId}/agent-quality/questionnaires/{questionnaireId}

Retrieves all data for the specified questionnaire. The user must be able to view the questionnaire's directory.
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
        questionnaireId

        Required

        The ID of the questionnaire being viewed/edited.

          Response

          200 - OK
          Returns information about the questionnaire and its associated questions.
          Property
          Value
          Comments
          id
          String
          The unique ID of this questionnaire.

          This property can be null.

          name
          String

          Required

          The name of the questionnaire. This can be at most 255 characters.
          directoryId
          String

          Required

          The ID of the questionnaire's directory.
          rankGroupId
          String

          Required

          The ID of the questionnaire's rank group.
          maxScore
          Double
          The maximum score for this questionnaire.

          This property can be null.

          minScore
          Double
          The minimum score for this questionnaire.

          This property can be null.

          minAcceptableScore
          Double
          The minimum acceptable score for this questionnaire.

          This property can be null.

          note
          String
          Note for the questionnaire. This can be at most 1024 characters.

          This property can be null.

          isTemplate
          Boolean

          Required

          True if this questionnaire is a template.
          isLocked
          Boolean

          Required

          True if this questionnaire is locked. New questionnaires cannot be locked.
          showRankWhileScoring
          Boolean

          Required

          True if ranks should be shown while scoring.
          totalNumCriticalQuestions
          Int

          Required

          The number of critical questions in the questionnaire.
          isActive
          Boolean

          Required

          True if this questionnaire is active.
          showPassFailWhileScoring
          Boolean

          Required

          True if pass/fail should be shown while scoring.
          version
          Int

          Required

          The version of the questionnaire.
          id
          String
          The unique ID of this question group.

          This property can be null.

          name
          String

          Required

          The name of the question group. This can be at most 255 characters.
          sequence
          Int

          Required

          The position of the group in the questionnaire.
          isTemplate
          Boolean

          Required

          True if this question group is a template.
          isOptional
          Boolean

          Required

          True if this question group is optional.
          note
          String
          Note for the question group. This can be at most 1024 characters.

          This property can be null.

          version
          Int

          Required

          The version of the question group.
          id
          String
          The unique ID of this question.

          This property can be null.

          questionText
          String

          Required

          The question text. This can be at most 1024 characters.
          sequence
          Int

          Required

          The position of the question in the group.
          unknown
          0
          freeText
          1
          integer
          2
          numeric
          3
          boolean
          4
          multipleChoice
          5
          unknown
          0
          optional
          1
          required
          2
          critical
          3
          weight
          Double

          Required

          The weight of the score for this question.
          maxScore
          Double

          Required

          The maximum score for this question.
          minScore
          Double

          Required

          The minimum score for this question.
          minAcceptableScore
          Double

          Required

          The minimum acceptable score for this question.
          helpText
          String
          Help text for the question. This can be at most 1024 characters.

          This property can be null.

          note
          String
          Note for the question. This can be at most 1024 characters.

          This property can be null.

          isTemplate
          Boolean

          Required

          True if this question is a template.
          hasCommentField
          Boolean

          Required

          True if this question allows comments.
          canMarkNA
          Boolean

          Required

          True if this question can be marked N/A.
          version
          Int

          Required

          The version of the question.
          choiceText
          String

          Required

          The choice text. This can be at most 255 characters.
          helpText
          String
          Help text for the choice. This can be at most 1024 characters.

          This property can be null.

          score
          Double

          Required

          The score for this choice.
          sequence
          Int

          Required

          The position of the choice in the question.
          version
          Int

          Required

          The version of the choice.
          404 - Not Found
          The questionnaire 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 questionnaire's directory.
          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.