/icws/{sessionId}/configuration/mail/interaction-message-store-mailbox-attributes

GET

/icws/{sessionId}/configuration/mail/interaction-message-store-mailbox-attributes

Gets the user attributes and values necessary to configure a user to have a FBMC mailbox.
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.

        Query
        userId

        Required

        Parameter userId for interactionMessageStoreMailboxAttributes function.

          Query
          displayName
          Parameter displayName for interactionMessageStoreMailboxAttributes function.

            Response

            200 - OK
            The interactionMessageStoreMailboxAttributesResult resource is included in the response.
            interactionMessageStoreMailboxAttributesResult
            Represent a result object returned by interactionMessageStoreMailboxAttributes function.
            Property
            Value
            Comments
            displayName
            String

            Required

            emailAddress
            String

            Required

            directoryEntry
            String

            Required

            mailbox
            String

            Required

            mailboxOption
            String

            Required

            400 - Bad Request
            Invalid request was provided.

            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
            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
            Not authorized to create these resources.
            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.