Expand All Collapse All

/icws/{sessionId}/screenrecordings/record/stop/{recordedUserId}

POST

/icws/{sessionId}/screenrecordings/record/stop/{recordedUserId}

Stops the screen recording for the list of screen recording IDs provided for the specified user. The specified user must have the screen capture client installed and properly configured in order for screen recording to be stopped.
Feature Version
recordings 2

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
        recordedUserId

        Required

        The ID of the user being recorded.

          Representations
          recordingIdList
          Expand AllCollapse All
          Property
          Value
          Comments
          recordingIds
          List [Unbounded]: String

          Required

          A list of recording IDs.

          Response

          202 - Accepted
          The stop screen recording request was accepted for processing. The client should wait for the completion of the operation via an asyncOperationCompletedMessage and the returned requestId.
          asyncOperationAcceptedResponse
          Represents the successful initiation of an asynchronous operation.
          Expand AllCollapse All
          Property
          Value
          Comments
          requestId
          String

          Required

          The ID associated with the asynchronous operation request. This can be used to correlate future events and operations.
          Associated Message
          The async operation of stopping the screen recordings has completed.
          asyncOperationCompletedMessage
          Expand AllCollapse All
          Property
          Value
          Comments
          __type
          "urn:inin.com:messaging:asyncOperationCompletedMessage"

          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.

          requestId
          String

          Required

          errorId
          String
          The error identifier that describes the current error.
          message
          String

          Required

          A message that describes the current error.
          403 - Forbidden
          The user is not authorized to use recordings management.
          error
          Provides additional detail for an error.
          Expand AllCollapse All
          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.
          Expand AllCollapse All
          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.
            Expand AllCollapse All
            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.
            Expand AllCollapse All
            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.
            Expand AllCollapse All
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.