Expand All Collapse All

/icws/{sessionId}/agent-quality/questionnaire-directories

POST

/icws/{sessionId}/agent-quality/questionnaire-directories

Creates an empty questionnaire directory. The user must have permission to create directories.
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.

        Representations
        createQuestionnaireDirRequest
        Expand AllCollapse All
        Property
        Value
        Comments
        id
        String
        The unique ID of this questionnaire directory.

        This property can be null.

        name
        String

        Required

        The name of the questionnaire directory. This can be at most 255 characters.
        isTemplate
        Boolean

        Required

        True if this questionnaire directory is a template.
        note
        String
        Note for the questionnaire directory. This can be at most 1024 characters.

        This property can be null.

        version
        Int

        Required

        The version of the questionnaire directory.

        Response

        201 - Created
        The questionnaire directory has been created.
        createQuestionnaireDirResponse
        Expand AllCollapse All
        Property
        Value
        Comments
        questionnaireDirId
        String

        Required

        The unique ID of the new questionnaire directory.
        403 - Forbidden
        The user is not authorized to create questionnaire directories.
        error
        Provides additional detail for an error.
        Expand AllCollapse All
        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 specified questionnaire directory data was invalid.

        Error Responses

        Error Identifier
        Error Type
        Error Description
        error.request.qualityManagement.duplicateQuestionnaireDir
        Type: urn:inin.com:common:error
        The request failed because the questionnaire directory already exists.
        error
        Provides additional detail for an error.
        Expand AllCollapse All
        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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          Property
          Value
          Comments
          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.

          GET

          /icws/{sessionId}/agent-quality/questionnaire-directories

          Gets the list of viewable questionnaire directories and their questionnaires.
          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.

                Response

                200 - OK
                The questionnaire directories and their associated questionnaire IDs.
                getQuestionnaireDirsResponse
                Expand AllCollapse All
                Property
                Value
                Comments
                __type
                "urn:inin.com:qualityManagement:questionnaireDirContents"

                Required

                The JSON type representing this option.
                id
                String
                The unique ID of this questionnaire directory.

                This property can be null.

                name
                String

                Required

                The name of the questionnaire directory. This can be at most 255 characters.
                isTemplate
                Boolean

                Required

                True if this questionnaire directory is a template.
                note
                String
                Note for the questionnaire directory. This can be at most 1024 characters.

                This property can be null.

                version
                Int

                Required

                The version of the questionnaire directory.
                writable
                Boolean

                Required

                True if this questionnaire directory is writable.
                name
                String

                Required

                id
                String

                Required

                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.
                Expand AllCollapse All
                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.
                  Expand AllCollapse All
                  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.
                  Expand AllCollapse All
                  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.
                  Expand AllCollapse All
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.