Skip to content

Latest commit

 

History

History
 
 

README.md

Alert data model

Note: The latest version of these Data Models can be found at https://github.com/smart-data-models/dataModel.Alert

This repository is going to be archived (Jan-2020) and subsequent works will be carried out in [Smart data models] (https://github.com/smart-data-models) repositories. Further questions on migration. alberto.abella@fiware.org

Description

This entity models an alert and could be used to send alerts related to traffic jam, accidents, weather conditions, high level of pollutants and so on. The purpose of the model is to support the generation of notifications for a user or trigger other actions, based on such alerts.

An alert is generated by a specific situation. The main features of an alert is that it is not predictable and it is not a recurrent data. That means that an alert could be an accident or a high level of pollutants measure, additionally it could be the fall down of a patient or a car driving in the opposite direction.

Some examples of context data are: type of alert (traffic, suspicious activities, and pollution, etc.), severity, location and so on.

Note: JSON Schemas only capture the NGSI simplified representation, this means that to test the JSON schema examples with a FIWARE NGSI version 2 API implementation, you need to use the keyValues mode (options=keyValues).

Examples of use

{
    "id": "Alert:1",
    "type": "Alert",
    "category": "traffic",
    "subCategory": "trafficJam",
    "severity": "high",
    "location": {
        "type": "Point",
        "coordinates": [-3.712247222222222, 40.423852777777775]
    },
    "dateIssued": "2017-01-02T09:25:55.00Z",
    "description": "The road is completely blocked for 3kms",
    "alertSource": "https://account.lab.fiware.org/users/8"
}