Get Stage Command

Table of Contents

• Command
• Response
• Errors
• Examples
  • Request
  • Response

Command

OpCode	Name	Description
8	get_stage	Gets the current stage of Xentara.

Response

The response item outlined in response packet for this command includes:

Name	Type	Description
Operational Stage	Integer	An integer denoting the current Xentara operational stage.

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
4	-32600	Invalid Request
5	-32000	Missing Client Hello Request

Examples

Request

Below is an example for the request to get the current operational stage of Xentara. The message id 65 is an arbitrary number assigned for this particular request.

[
  0,     # Request Packet
  65,    # Message Id
  8      # Get Stage OpCode
]

Response

Below is an example of a successful response to the request described above. It specifies a package type of 1, indicating a successful outcome. The included Message ID is used to match the response with the corresponding request. The response also contains an integer denoting the Xentara operational stage identifier.

[
  1,    # Packet Type - Success Response
  65,   # Message Id
  2     # Operational Stage Xentara
]