OPS: Inspect Shows

OPS: Inspect Shows

Returns all the data about the shows available at the site. Indicates if the show is enabled and/or alive. If alive, connection information is provided.

Endpoint: /api/v1/ops/inspect/shows

Verb: GET

Payload: None

Example Response:

{
    "api_code": 0,
    "error": null,
    "shows": {
        "shows": [

            {
                "show_id": 7,
                "name": "Little Prince Windows Server",
                "active": false,
                "alive": false,
                "address": "",
                "port": 0
            },
            {
                "show_id": 8,
                "name": "Little Prince Linux Server",
                "active": true,
                "alive": true,
                "address": "192.168.1.160",
                "port": 13707
            },
            {
                "show_id": 9,
                "name": "Little Prince MacOS Server",
                "active": true,
                "alive": false,
                "address": "",
                "port": 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.