/icws/{sessionId}/messaging/subscriptions/configuration/actions/{subscriptionId}

PUT

/icws/{sessionId}/messaging/subscriptions/configuration/actions/{subscriptionId}

Creates or updates the message subscription to actions.
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
        subscriptionId

        Required

        The ID of the subscription.

          Representations
          configObjectSubscription
          Subscription on a collection of configuration objects.
          Property
          Value
          Comments
          configurationIds
          List [Unbounded]: String

          Required

          List of configuration ID's that are to be watched. When the wildcard character '*' is used, a subscription on all configuration objects is started. The wildcard in configurationIds cannot be combined with a wildcard in properties.
          properties
          List [Unbounded]: String

          Required

          The list of object properties to include in the watch. When the wildcard character '*' is used as a property, a subscription on all properties for the specified configuration object(s) is started. The wildcard in configurationIds cannot be combined with a wildcard in properties. Properties with a NULL value will not be returned on the initial subscription response to conserve the Interaction Center server's resources. After the initial message, properties set to NULL will be in the subsequent messages to tell consumers that they have been cleared out.
          rightsFilter
          String

          Required

          The Security Right to use with the watch. The values that can be used with this are found on the rightsFilter query parameter of the GET operation for this object type.

          Response

          200 - OK
          The message subscription to actions has been created or updated.
          Associated Message
          The action list changed.
          actionsMessage
          Represents a message containing updated action configuration objects.
          Property
          Value
          Comments
          __type
          "urn:inin.com:configuration.system:actionsMessage"

          Required

          The JSON type representing this option.
          isDelta
          Boolean

          Required

          When true, this property indicates that some optional properties that have not changed may be omitted (all required properties will be included). In this case, the client side cache should be updated with the values for the properties provided and no change should be made for the properties not included as part of the message. This allows the API to deliver smaller messages that only represent the properties that have changed.

          When this property is false, the client side cache for this subscription should be cleared and replaced with the data provided in the message. For the initial message in response to a subscription, this property will be false to indicate the cache should be initialized with the data provided.

          subscriptionId
          String
          The ID of the subscription that this message pertains to. For subscriptions that use subscription IDs to differentiate between different subscriptions on the same session, this value indicates which subscription ID the message is for.
          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.
          createdDate
          DateTime
          The date this configuration object was created.

          This is a read only property and can not be changed with PUT or POST operations.

          This property can be null.

          name
          String

          Required

          The key identifying this pair.
          value
          String

          Required

          The value of this pair.

          This property can be null.

          lastModifiedDate
          DateTime
          The date this configuration object was last modified.

          This is a read only property and can not be changed with PUT or POST operations.

          This property can be null.

          notes
          String
          The notes for this configuration object.

          This property can be null.

          dde
          0
          customScreenPop
          1
          webBrowserScreenPop
          2
          url
          String

          Required

          The URL to open in the browser.
          new
          0
          Pop to a new browser (only supported in Internet Explorer and Firefox).
          tab
          1
          Pop to a new tab on an existing browser session (Not supported in web-based clients).
          name
          String

          Required

          The name to identify the parameter.
          friendlyName
          String

          Required

          The name displayed to the user.
          allow
          0
          Allow override.
          restrict
          1
          Allow override with restricted values(multiple choice).
          disallow
          2
          Do not allow override.
          defaultValue
          String
          The value to use when Attendant overrides are disallowed, or the default value to use then they are allowed or restricted.

          This property can be null.

          [key]
          String

          Required

          [value]
          String

          Required

          removed
          List [1,*]: String
          404 - Not Found
          A action does not exist for a specified ID. The entity-body will contain the ID which caused the error.
          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.
          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.

            DELETE

            /icws/{sessionId}/messaging/subscriptions/configuration/actions/{subscriptionId}

            Removes the message subscription to actions.
            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
                  subscriptionId

                  Required

                  The ID of the subscription.

                    Response

                    204 - No Content
                    The actions message subscription was deleted.
                    404 - Not Found
                    The message subscription 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.
                    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.