/icws/{sessionId}/configuration/defaults/user

GET

/icws/{sessionId}/configuration/defaults/user

Returns an initialized user object with default values.
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.

        Response

        200 - OK
        An initialized user object with defaults is in the response.
        user
        Represents the user 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.
        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.

        id
        String
        The unique identifier used to reference this configuration object. The value of this can be null when the grouping of this value is All. Otherwise, it is required.

        This property can be null.

        displayName
        String
        The display name of this configuration object.

        This property can be null.

        uri
        Uri
        A URI used to access this configuration object.

        This property can be null.

        none
        0
        Represents no object type.
        acg
        1
        Represents an ACG object type.
        workgroup
        2
        Represents the workgroup object type.
        lineGroup
        3
        Represents the lineGroup object type.
        feedbackSurveyGroup
        4
        Represents the feedbackSurveyGroup object type.
        all
        0
        Represents all possible ConfigurationIds.
        single
        1
        Represents a single ConfigurationId.
        group
        2
        Represents a grouping of ConfigurationIds where each ConfigurationId is a member of some other Aggregate (Workgroup, Role, ...).
        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        actualValue
        Boolean
        The value directly assigned to this configuration object. This value is required for POST and PUT operations.

        This property can be null.

        effectiveValue
        Boolean
        The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

        This property can be null.

        inheritedValue
        Boolean
        The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

        This property can be null.

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        values
        Boolean

        Required

        acdAgentGreeting
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        acdAgentGreetingFile
        String

        This property can be null.

        alias
        String

        This property can be null.

        autoAnswerAcdInteractions
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        autoAnswerNonAcdInteractions
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        clientConfigDateLastModified
        DateTime
        The date this configuration object was last modified.

        This property can be null.

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        applicationId
        String

        Required

        publishedDate
        DateTime

        Required

        cost
        Int
        The value must conform to all of these criteria:
        • Is a value from 0 to 100.

        Setting this property to null will set it to its default value.

        Default value: 0

        emergencyResponderLocationID
        String
        This location ID points to emergency details stored in Emergency Routing service (ERS) database.

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

        Feature Version
        configuration 16

        This property can be null.

        excludeFromDirectory
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        extension
        String
        The user's extension. The value for it must be unique among the workgroups and stations with an extension to ensure that the user can be reached. Additionally, if regional dialing is enabled on one or more locations, than each subset of the extension with a length of the number of significant digits must be unique as well. For example, say User X has an extension of 1111 and User Y has an extension of 111. If the number of significant digits is 3, then these extensions are invalid because User Y's extension is a subset of User X's extension. If the number of significant digits is 4, then these extensions are valid. The value must conform to all of these criteria:
        • Is a value representing a valid Extension.

        This property can be null.

        faxCapability
        Boolean

        Setting this property to null will set it to its default value.

        Default value: true

        homeSite
        Int
        The value must conform to all of these criteria:
        • Is a value referring to an existing configured item.

        This property can be null.

        actualValue
        Duration
        The value directly assigned to this configuration object. This value is required for POST and PUT operations.

        This property can be null.

        effectiveValue
        Duration
        The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

        This property can be null.

        inheritedValue
        Duration
        The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

        This property can be null.

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        values
        Duration

        Required

        acdSocialMedia
        Boolean
        This is used to enable user's Social Media types ACD routing from a configured workgroup.
        Feature Version
        configuration 14

        This property can be null.

        acdWhatsApp
        Boolean
        This is used to enable user's WhatsApp ACD routing from a configured workgroup.
        Feature Version
        configuration 14

        This property can be null.

        assignable
        0
        concurrent
        1
        hasClientAccess
        Boolean
        This is used to indicate if the user should be allowed to access the Interaction Client.

        Setting this property to null will set it to its default value.

        Default value: false

        none
        0
        directRoutedWorkItems
        1
        groupRoutedWorkItems
        2
        processMonitor
        3
        processDesigner
        4
        licenseActive
        Boolean
        This is used to indicate if the user's assigned licenses should be considered active by the server. Setting this to false will remove this user's licenses from the applied counts.

        Setting this property to null will set it to its default value.

        Default value: false

        none
        0
        media1
        1
        media2
        2
        media3
        3
        invalid
        0
        call
        1
        chat
        2
        email
        3
        generic
        4
        callback
        5
        workItem
        6
        socialDirectMessage
        7
        Feature Version
        configuration 14
        socialConversation
        8
        Feature Version
        configuration 14
        lyncIntegrationEnabled
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        lyncLineUri
        String
        The value must conform to all of these criteria:
        • Is a string with from 1 to 128 characters.

        This property can be null.

        none
        0
        publicConnectivity
        1
        remoteCallControl
        2
        organizeMeetingWithAnonymousParticipants
        3
        unifiedCommunications
        4
        enhancedPresence
        5
        remoteCallControlDualMode
        6
        autoAttendantEnabled
        7
        lyncSipAddress
        String
        The value must conform to all of these criteria:
        • Is a string with from 1 to 128 characters.

        This property can be null.

        directoryMoniker
        String

        This property can be null.

        displayName
        String

        This property can be null.

        emailAddress
        String

        This property can be null.

        mailboxMoniker
        String

        This property can be null.

        none
        0
        interactionMessageStore
        1
        imapSmtp
        2
        genericProvider
        3
        mwiAddress
        String

        This property can be null.

        mwiEnabled
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        default
        0
        address
        1
        nameSpellingsAsr
        List [Unbounded]: String

        This property can be null.

        Property type documentation:

        Represents a collection of strings.

        nameSpellingTts
        String

        This property can be null.

        ntDomainUser
        String
        The value must conform to all of these criteria:
        • Has a unique value for this attribute compared to other instances of this configuration object.

        This property can be null.

        outboundAni
        String

        This property can be null.

        outlookIntegrationEnabled
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        pagerActive
        Boolean

        Setting this property to null will set it to its default value.

        Default value: false

        actualValue
        String
        The value directly assigned to this configuration object. This value is required for POST and PUT operations.

        This property can be null.

        effectiveValue
        String
        The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

        This property can be null.

        inheritedValue
        String
        The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

        This property can be null.

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        values
        String

        Required

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        assistantName
        String

        This property can be null.

        city
        String

        This property can be null.

        companyName
        String

        This property can be null.

        country
        String

        This property can be null.

        departmentName
        String

        This property can be null.

        emailAddress
        String

        This property can be null.

        emailAlias
        String

        This property can be null.

        givenName
        String

        This property can be null.

        notes
        String

        This property can be null.

        officeLocation
        String

        This property can be null.

        number
        String

        Required

        This property can be null.

        extension
        String

        This property can be null.

        dialExtensionAutomatically
        Boolean

        This property can be null.

        postalCode
        String

        This property can be null.

        stateOrProvince
        String

        This property can be null.

        streetAddress
        String

        This property can be null.

        surname
        String

        This property can be null.

        title
        String

        This property can be null.

        id
        String

        Required

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

        This property can be null.

        proficiency
        Int

        Required

        desireToUse
        Int

        Required

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        statisticsShiftStarts
        List [Unbounded]: Duration
        Is a collection of items that each conform to all of these criteria:
        • Is a value from 0 to 86340.

        Setting this property to null will set it to its default value.

        Default value: 0:00

        Property type documentation:

        Represents a collection of durations.

        statusText
        String

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

        This property can be null.

        umDestination
        String
        The value must conform to at least one of these criteria:
        • Is a configuration ID reference to an existing instance in the server's 'Station' collection, where 'i3config::attribute::station_type' is 'Unified Messaging'.
        • Is the value ''IC Server''.

        This property can be null.

        umRemoteOverride
        String

        This property can be null.

        All
        0
        Generous
        1
        Best
        2
        Strict
        3
        actualValue
        Int
        The value directly assigned to this configuration object. This value is required for POST and PUT operations.

        This property can be null.

        effectiveValue
        Int
        The effective value of this property, from the blending of the actualValue with the inheritedValue. This value is required for GET object and GET object list operations.

        This property can be null.

        inheritedValue
        Int
        The actual inherited value, based on this configuration object's membership/inheritance, such as Workgroup, Role, and Default User.

        This property can be null.

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        values
        Int

        Required

        phoneNumber
        String

        Required

        The phone number to call.
        timeout
        Int

        Required

        How long to ring the follow-me number before moving to the next number in the list or transferring the call to voice mail.
        usePin
        Boolean

        Required

        If true, than the call recipient will be required to enter their IC password to accept the call.
        invalid
        0
        call
        1
        chat
        2
        email
        3
        generic
        4
        callback
        5
        workItem
        6
        socialDirectMessage
        7
        Feature Version
        configuration 14
        socialConversation
        8
        Feature Version
        configuration 14
        utilization
        Int

        Required

        maxAssignable
        Int

        Required

        none
        0
        The property was not inherited.
        Workgroup
        1
        The property was inherited from a Workgroup configuration object.
        Role
        2
        The property was inherited from a Role configuration object.
        DefaultUser
        3
        The property was inherited from the Default User configuration object.
        ClientConfigurationTemplate
        4
        The property was inherited from a Client Configuration Template configuration object.
        vniStation
        String

        This property can be null.

        whisperToneLevel
        Int
        The value must conform to all of these criteria:
        • Is a value from -40 to 0.

        Setting this property to null will set it to its default value.

        Default value: -25

        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.