[EVENT]

A Session Starts

A session_start_result event will occur whenever the session_start command succeeds.

See Also: A Session Fails to Start.

Parameters

result_code number

The HTTP response code 200.
result_text string

"OK"

session_id number A unique ID for the new session, which should be recorded in case any issues require technical diagnosis of the session.
authority_table string The name of the table authorised for query during this session. This will depend on the details used to establish the session, and any associated permissions.
authority_id number The unique ID of the operator or customer (table dependent) over which this session has authority.
config_id number

The unique ID of the configuration being used by the session. This will either have been specified by the initiating command, or automatically assigned based on the specified operator.

If absent, no configuration has been assigned to the session.
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.

Example Response

Copy 
{"event":{"event_type":"session_start_result", "result_code":200, "result_text":"OK", "session_id":1234, "authority_table":"sample_table", "authority_id":90210, "api_version":"1.0-123"}}