[EVENT]

A Session Fails to Start

A session_start_result event will occur whenever the session_start command fails.

Parameters

result_code number

An HTTP response code related to the failure.

result_text string

An explanation of what caused the failure, e.g. missing password.

session_id number 0
authority_table string ""
authority_id number 0
config_id number

0

api_version string

A numeric string in the format "X.Y-Z", where:

  • X is the major version number of the current WebSocket.

  • Y is the minor version number of the current WebSocket.

  • Z is the version number of CC4Web.

Depending on the type of failure, this value may be absent, indicating that the version was not detectable.

Example Response

No Config ID or Operator Specified

Copy
{"event":{"event_type":"session_start_result","result_code":500,"result_text":"201 FAILED - No configuration specified and no operator selected to get a default configuration from. on session ID 408731393","session_id":0,"authority_table":"","authority_id":0,"config_id":0,"api_version":"1.14."}}

Incorrect Password

Copy
{"event":{"event_type":"session_start_result","result_code":500,"result_text":"201 FAILED - Login failed (login result -1): Incorrect credentials supplied on session ID 408731405","session_id":0,"authority_table":"","authority_id":0,"config_id":0,"api_version":"1.14."}}