OPS: emergencypassthrough

OPS: Emergency Passthrough

This call is made to put all clients in a particular GemGroup into an "emergency passthrough" state, or optionally all the active groups in a specific show. This is used to implement operator functionality that is invoked when there are unforseen circumstances that require everyone to see their real surroundings for safety reasons.

Endpoint: /api/v1/ops/emergencypassthrough

Verb: POST

Payload:

The request payload contains several optional field which allow you to choose how you wish to reference the user to be deboarded. One of them must be provided. If more than one is provided, only one will be used to select the user and the others will be ignored.

Type	Attribute	Required	Description
uint64	gem_group_id	Yes	Specifies the GemGroup ID whose members should be put into passthrough mode. If 0, acts on all active groups in the show.
bool	passthrough_state	Yes	true = Turn passthrough on; false = Turn passthrough off
string	message	No	Optional message to display on the passthrough screen.

Example Response:

{
    "api_code": 0,
}

or

{
    "api_code": xxxx,
    "error": {
        "error_code": xxxxx,
        "error_message": "Erorr message",
        "error_detail": "Optional additional details about error",
        "suggestion": "Optional suggestion on how to resolve error",
        "callstack": "Optional debug callstack."
    }
}

See https://studio.wevr.com/wevr/projects/gem/gem-platform/-/wikis/GEM-API-Codes for error codes contained therein.

See https://studio.wevr.com/wevr/projects/gem/gem-platform/-/wikis/GEM-Server-Codes for error codes contained therein.