Skip to content

Alert Notification (notifyAlert) Receipt

Receives an alert notification message.

Output Sample

{
    "jsonrpc": 2,
    "method": "notifyAlert",
    "result": {
        "condition": {
            "type": "Feature",
            "geometry": {
                "type": "Polygon",
                "coordinates": [
                    [
                        [
                            139.744595779187,
                            35.7330988098923
                        ],
                        ...
                    ]
                ]
            },
            "properties": {
                "theme": "rm_hiyarihatto",
                "threshold": 1,
                "interval": 5,
                "notified": 1
            }
        },
        "alert": {
            "type": "FeatureCollection",
            "name": "alertResponse",
            "extraProperties": {
                "servertime": "2018-09-18 09:00:00+0000"
            },
            "features": [
                {
                    "type": "Feature",
                    "properties": {
                        "theme": "rm_hiyarihatto",
                        "risk": 1,
                        "datetime": null
                    },
                    "geometry": {
                        "type": "Polygon",
                        "coordinates": [
                            [
                                [
                                    139.73892234757713,
                                    35.72854147669082
                                ],
                                ...
                            ]
                        ]
                    }
                },
                {
                    "type": "Feature",
                    "properties": {
                        "theme": "rm_hiyarihatto",
                        "risk": 2,
                        "datetime": null
                    },
                    "geometry": {
                        "type": "Polygon",
                        "coordinates": [
                            [
                                [
                                    139.73907227364109,
                                    35.72999964639976
                                ],
                                ...
                            ]
                        ]
                    }
                },
                ...
            ]
        }
    },
    "id": 1
}

Content in parts denoted by ... have been omitted.

Return Values

While WebSocket is used for exchanging Alert notification API messages, the notifyAlert details are received in the JSON-RPC response format.

Key Value
jsonrpc 2.0
method notifyAlert
result Object with "alert" and "condition"
id Optional

Format of the result section

Key Value
alert If no GeoJSON indicating the monitored alert details and the alert itself have occurred, null.
The alert time is stored in "extraProperties" .
condition The geometry object transmitted and specified during setAlert or alterAlert.
The theme, threshold and interval of the search criteria are stored in "properties".

Format of the alert.extraProperties and condition.properties parts

Key Value
alert.extraProperties.servertime Alert incident time.
Text string in the format YYYY-MM-DD HH:MM:SS+0000
condition.properties.comment
condition.properties.theme
condition.properties.threshold
condition.properties.interval
condition.properties.thinning_step
condition.properties.thinning_filter_step
Properties set during setAlert and alterAlert