Skip to main content

Subscribe to the 'map obsolescence' event.

GET 

/maps/events/obsoleted

This endpoint allows clients to subscribe to server-sent events (SSE) that notify them when any map in the inventory has become obsolete. Additionally, the endpoint sends an event if the check against the server fails. The response includes information about any obsoleted maps and any errors encountered during the check.

Warning: Only maps that are both obsoleted and in a "Ready" (fully downloaded) state will be included. Maps that are obsoleted but not fully downloaded or are waiting for deletion will not be considered as obsoleted by this event.

Request

Responses

Schema

    error

    object

    nullable

    Represents various types of errors that can occur in the application.

    When serialized, it will be represented in the following format:

    {
    "type": "ErrorType",
    "msg": "ErrorMessage"
    }

    Where:

    • type is the specific error type (e.g., ClientError, InternalServerError).

    • msg is the associated error message (a string).

    oneOf

    msg stringrequired
    type stringrequired

    Possible values: [ClientError]

    lastCheck date-timenullable

    The last time the inventory was checked against the server to determine if there are any obsolete maps.

    obsoleted booleanrequired

    Indicates whether there is any map in the inventory that is obsoleted.

Loading...