/icws/{sessionId}/configuration/feedback-surveys/{id}

GET

/icws/{sessionId}/configuration/feedback-surveys/{id}

Returns a specific feedbackSurvey resource.
Feature Version
configuration 1

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
        id

        Required

        The ID of the feedbackSurvey resource.

          Query
          select

          A comma-delimited list of fields to include in the query. If no fields are specified, then only the ID of the items is returned.

          Example: select=extension,defaultWorkstation

          One can also specify that all of the properties should be returned by using the '*' wildcard value. This is a shortcut for specifying all of the properties' names in the parameter.

          The selected properties with a NULL value will not be returned to conserve the Interaction Center server's resources.

            Query
            rightsFilter
            The security right to use when filtering the results.

            Default value: admin

            Options:

            • view
            • admin

            Response

            200 - OK
            The feedbackSurvey resource is included in the response.
            feedbackSurvey
            Represents the feedbackSurvey configuration object.
            Property
            Value
            Comments
            id
            String

            Required

            The unique identifier used to reference this configuration object.
            displayName
            String
            The display name of this configuration object.

            This property can be null.

            uri
            Uri
            A URI used to access this configuration object.
            400 - Bad Request
            Invalid parameter value was specified.

            Error Responses

            Error Identifier
            Error Type
            Error Description
            error.request.invalidRepresentation.malformed
            Type: urn:inin.com:common:error
            The request representation object was malformed.
            Feature Version
            configuration 2
            error.request.configuration.get.selectAll
            Type: urn:inin.com:common:error
            Combining the wildcard (*) and one or more specific properties in one request is not supported.
            Feature Version
            configuration 2
            error.request.configuration.getObject
            Type: urn:inin.com:configuration:getObjectError
            One or more of the properties in the 'rightsFilter' or 'select' query parameters are not supported.
            Feature Version
            configuration 2
            error
            Provides additional detail for an error.
            Property
            Value
            Comments

            Multiple options:

            The value can be assigned any of the following options.
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            __type
            "urn:inin.com:configuration:getObjectError"

            Required

            The JSON type representing this option.
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            select
            List [Unbounded]: String
            The properties in the select query parameter that are not supported by the object type.

            Property type documentation:

            Represents a collection of strings.

            rightsFilter
            String
            The properties in the rightsFilter query parameter that are not supported by the object type.
            403 - Forbidden
            Not authorized to retrieve this resource.
            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.
            404 - Not Found
            The feedbackSurvey 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.
            500 - Internal Server Error
            An unexpected error occurred while processing the request.

            Error Responses

            Error Identifier
            Error Type
            Error Description
            error.request.internalServerError
            Type: urn:inin.com:common:error
            The server encountered an unexpected, internal error.
            Feature Version
            configuration 2
            error.request.timeout
            Type: urn:inin.com:common:error
            The request timed out.
            Feature Version
            configuration 2
            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.