Clear notification

Clears a notification, which effectively notifies GEM that the situtation referenced by the notification has been resolved.

Calling this API on a notification that has already been marked resolved is not considered an error and will silently succeed.

If a notification is cleared and the situation that generated the notification is still ongoing, GEM will subsequently generate a new notification for the same situation. The same notification will reappear in the notification list, with a new creation timestamp and a new ID.

Once a notification is cleared, there is no way to retrieve it again.

Endpoint: /api/v1/ops/notify/clear

Verb: POST

Payload:

{
    "show_id":    integer,    // int64 in the DB
    "notify_id":  integer     // as reported by the ops/inspect/notify call
}

Example Response:

{
    "api_code": 0,
    "error": null
}

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.