OPS: showpause

OPS: Pause show

This call is made to pause/unpause all progression on the stage. When a show has been paused, users who are in a particular area (whether in a slot in the onboarding area or in a zone on the main stage) can continue what they are doing, but they will not be able to progress to the next zone/phase. This is useful when there are technical issues that need to be resolved or when the show is in a state where it is not safe to progress. When the show is unpaused, progression continues as normal.

Endpoint: /api/v1/ops/showpause

Verb: POST

Payload:

The request specifies the show being paused/unpaused and what the new state is expected to be.

Type	Attribute	Required	Description
uint64	show_id	Yes	Specifies the id of the show being modified.
bool	pause_on	Yes	true = Pause show; false = Unpause show

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.