Command

OpCode	Name	Description
10	suspend	Suspend Xentara

Parameters

The parameter object outlined in request packet for this command includes:

ID	Name	Optional	Description
0	session_id	yes	A UUID specifying the UUID of the opened sub-session. If the sub-session ID is not provided, access is verified based on the authorization of the WebSocket connection. If provided, access is verified based on authorization of both, the WebSocket connection and the authentication method utilized for opening a sub-session.

Response

In case of successful execution, the response item indicated in response packet contains no elements. It simply includes the successful response packet type and the message id. If an error occurs, the response will include an error packet with detailed error information.

Errors

Below is the list of the potential errors that may be encountered with this command. Further details regarding errors in the Xentara WebSocket interface can be accessed here.

Sr. No.	Error Code	Error Description
1	-32700	Parse Error
2	-32603	Internal Error
3	-32602	Invalid Parameter
4	-32600	Invalid Request
5	-32000	Missing Client Hello Request
6	-32102	Access Denied
7	-32112	Invalid Stage Change Request

Examples

Request

Below is an example for the request to suspend Xentara. The message id 65 is an arbitrary number assigned for this particular request.

[
  0,                                            # Request Packet
  65,                                           # Message Id
  10,                                           # Suspend Xentara OpCode
  {                                             
    0: 37('E3EE10714D884BA18E5D0F1E4CE25EE8')   # Opened Sub-Session Id
  }
]

Response

Below is an example of the successful response to the aforementioned request. It indicates a package type of 1, signifying a successful response. The provided message id is intended for matching with the corresponding request.

[
  1,     # Packet Type - Success Response
  65     # Message Id
]

Table of Contents

Command

Parameters

Response

Errors

Examples

Request

Response