/icws/{sessionId}/licenses

POST

/icws/{sessionId}/licenses

Acquire a set of licenses. If the license has already been acquired, there is no effect. There is no effect on any other licenses that have been previously acquired in this session.
Feature Version
licenses 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.

        Representations
        Property
        Value
        Comments
        licenseList
        List [1,*]: String

        Required

        Represents a list of license strings. Some examples of valid license strings are I3_LICENSE_BASIC_STATION and I3_ACCESS_CLIENT. The complete list can be found in the Interaction Center documentation.

        Response

        200 - OK

        The request was successful. For more information, see the licenseOperationResults representation in the body of the response. If the client requests a license that does not exist, the only information provided is that it will not have been acquired. The API does not discern between valid and invalid license strings.

        licenseOperationResults
        Represents a list of licenseOperationResult representations.
        Property
        Value
        Comments
        errorDetails
        String

        Required

        isAvailable
        Boolean

        Required

        If true, the license was successfully acquired for the user. Otherwise, check the errorDetails and licenseStatus for more information on why it was not acquired.

        licenseName
        String

        Required

        unknownError
        0
        Indicates that an error occurred while checking the license.
        none
        1
        Represents no status.
        available
        2
        Represents a license that is available.
        notAssigned
        3
        Represents a license that has not been assigned.
        licenseUnavailable
        4
        Represents a license that assigned but unavailable because all concurrent licenses are in use, or insufficient licenses are installed.
        userOnAnotherStation
        5
        Represents a license that is unavailable because the user is logged onto another station.
        stationAlreadyInUseOnAnotherMachine
        6
        Represents a license that is unavailable because the station is already in use on another machine.
        stationAlreadyInUseByAnotherUser
        7
        Represents a license that is unavailable because the station is being used by another user.
        otherApplicationUsingLicense
        8
        Represents a license that is unavailable because the license is in use by another application.
        licenseUnknown
        9
        Represents a license name that is unknown to the IC System.
        Feature Version
        licenses 2
        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.
          500 - Internal Server Error
          An unexpected error occurred while processing the request.
          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.

          PUT

          /icws/{sessionId}/licenses

          Acquires a set of new licenses and releases a previous set of licenses. Any licenses previously acquired during the session will be released. For example, licenses A, B and C are already acquired a PUT requests B, C and D. After the PUT, A will no longer be acquired and the complete set of acquired licenses will be B, C and D.

          Feature Version
          licenses 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.

                Representations
                Property
                Value
                Comments
                licenseList
                List [1,*]: String

                Required

                Represents a list of license strings. Some examples of valid license strings are I3_LICENSE_BASIC_STATION and I3_ACCESS_CLIENT. The complete list can be found in the Interaction Center documentation.

                Response

                200 - OK

                The request was successful. Any licenses acquired before this request have been released. For more information, see the licenseOperationResults representation in the body of the response. If the client requests a license that does not exist, the only information provided is that it will not have been acquired. The API does not discern between valid and invalid license strings.

                licenseOperationResults
                Represents a list of licenseOperationResult representations.
                Property
                Value
                Comments
                errorDetails
                String

                Required

                isAvailable
                Boolean

                Required

                If true, the license was successfully acquired for the user. Otherwise, check the errorDetails and licenseStatus for more information on why it was not acquired.

                licenseName
                String

                Required

                unknownError
                0
                Indicates that an error occurred while checking the license.
                none
                1
                Represents no status.
                available
                2
                Represents a license that is available.
                notAssigned
                3
                Represents a license that has not been assigned.
                licenseUnavailable
                4
                Represents a license that assigned but unavailable because all concurrent licenses are in use, or insufficient licenses are installed.
                userOnAnotherStation
                5
                Represents a license that is unavailable because the user is logged onto another station.
                stationAlreadyInUseOnAnotherMachine
                6
                Represents a license that is unavailable because the station is already in use on another machine.
                stationAlreadyInUseByAnotherUser
                7
                Represents a license that is unavailable because the station is being used by another user.
                otherApplicationUsingLicense
                8
                Represents a license that is unavailable because the license is in use by another application.
                licenseUnknown
                9
                Represents a license name that is unknown to the IC System.
                Feature Version
                licenses 2
                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.
                  500 - Internal Server Error
                  An unexpected error occurred while processing the request.
                  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}/licenses

                  Releases all licenses acquired during the current session.
                  Feature Version
                  licenses 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
                        The request was successful. Any licenses acquired in this session have been released.
                        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.
                          500 - Internal Server Error
                          An unexpected error occurred while processing the request.
                          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.