Set Live Session

This command sets the Live state of the session to the value of active, where "true" means Live and "false" means not-Live. You specify the session using the session ID.

Note

When Multi-site Live was implemented, the default was changed to not-Live. Previously sessions were Live by default.

Authorizations: All

Requests

setLiveSession sessionID active

Parameters

Parameter

Description/Values

sessionId

The ID of a HMP session.

active

The Live state of the session, either:

true (Live) or
false (not-Live)

Result

Success

OK

Error

Error	Description
`ERROR\|010003\|Expected 2 parameter(s). Got Y parameter(s)`	Calling `setLiveSession` requires 2 parameters.
`ERROR\|010001\|'Y' is not a uuid`	The `sessionId` provided must be a UUID.
`ERROR\|010001\|'Y' is not a boolean`	`active` must be `true` or `false`
`ERROR\|040006\|Session not found`	The 'session' with UUID '`sessionId`' was not found.

Example

The first example toggles the session Live setting/state to Live (active = "true"). The system returns OK.

setLiveSession 46713454-8e31-4efc-babc-6bc9b88f2834 true

OK

The second example toggles the session Live setting/state to not-Live (active = "false"). The system returns OK.

setLiveSession 46713454-8e31-4efc-babc-6bc9b88f2834 false

OK