OPS: Inspect Notify

OPS: Inspect Notify

Returns a summary of the active notification for the specified show. Notifications are added to this list by the GEM server when a condition needing an attendant's attention is detected. The are automatically removed from this list when GEM detects that the condition has been marked as resolved.

Some conditions that trigger a notification (for example, a group taking too long to suit-up) can not only be detected by GEM, but can also be automatically marked resolved by GEM if the groups finishes suiting up before an attendant has had a chance to intervene. In these cases, the notification simply goes away so as not to be an extra detraction for the attendant.

Other conditions (for example, a game server dying) can ben detected by GEM but the resolution involves an attendant escorting the group from the stage to the onboard area because their headsets may no longer be correctly communicating with GEM. In these cases, the notification will remain until an attendant marks it as resolved.

Resolution of a notification can be done with the ops/notify/clear API call.

If there are multiple attendants monitoring the same show, the notification will be visible to all of them. So that the attendants do not need to manually coordinate between them as to who is handling which notification, a notification can be marked as "in progress" with the ops/notify/mark API call..

Endpoint: /api/v1/ops/inspect/notify/:showid

Verb: GET

Payload: None

Example Response:

{
    "api_code": 0,
    "error": null,
    "notifications": [
        {
            "id": 5,
            "message": "The game server for group 163 (in zone 2) has died. Escort customers back to onboard area to restart the experience.",
            "in_progress": false,
            "created": "2025-03-26T16:07:36.641894342-07:00",
            "modified": "0001-01-01T00:00:00Z"
        },
        {
            "id": 5,
            "message": "The game server for group 163 (in zone 2) has died. Escort customers back to onboard area to restart the experience.",
            "in_progress": false,
            "created": "2025-03-26T16:07:36.641894342-07:00",
            "modified": "0001-01-01T00:00:00Z"
        }
    ]
}

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.