Alert data model JSON Schema


An alert generated by a user or device in a given location

root allOf GSMA-Commons
Type: object

root allOf item 0 id
Type: object

Property. Unique identifier of the entity

root allOf item 0 id anyOf item 0
Type: string

Property. Identifier format of any NGSI entity

Must match regular expression: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$

Must be at least 1 characters long

Must be at most 256 characters long

root allOf item 0 id anyOf item 1
Type: stringFormat: uri

Property. Identifier format of any NGSI entity

root allOf item 0 dateCreated
Type: stringFormat: date-time

Property. Entity creation timestamp. This will usually be allocated by the storage platform.

root allOf item 0 dateModified
Type: stringFormat: date-time

Property. Timestamp of the last modification of the entity. This will usually be allocated by the storage platform.

root allOf item 0 source
Type: string

Property. A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object.

root allOf item 0 name
Type: string

Property. The name of this item.

root allOf item 0 alternateName
Type: string

Property. An alternative name for this item

root allOf item 0 description
Type: string

Property. A description of this item

root allOf item 0 dataProvider
Type: string

Property. A sequence of characters identifying the provider of the harmonised data entity.

root allOf item 0 owner
Type: array

Property. A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)

Each item of this array must be:

root allOf item 0 owner EntityIdentifierType
Type: object

Property. Unique identifier of the entity

Same definition as id

root allOf item 0 seeAlso

Property. list of uri pointing to additional resources about the item

root allOf item 0 seeAlso oneOf item 0
Type: array of string

Must contain a minimum of 1 items

Each item of this array must be:

root allOf item 0 seeAlso oneOf item 0 item 0 items
Type: stringFormat: uri
root allOf item 0 seeAlso oneOf item 1
Type: stringFormat: uri
root allOf Location-Commons
Type: object

root allOf item 1 location

GeoProperty. Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon

root allOf item 1 location oneOf GeoJSON Point
Type: object

GeoProperty. Geojson reference to the item. Point

root allOf item 1 location oneOf GeoJSON Point type
Type: enum (of string)

Must be one of:

  • "Point"

root allOf item 1 location oneOf GeoJSON Point coordinates
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point coordinates coordinates items
Type: number

root allOf item 1 location oneOf GeoJSON Point bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Point bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON LineString
Type: object

GeoProperty. Geojson reference to the item. LineString

root allOf item 1 location oneOf GeoJSON LineString type
Type: enum (of string)

Must be one of:

  • "LineString"

root allOf item 1 location oneOf GeoJSON LineString coordinates
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString coordinates coordinates items coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON LineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON LineString bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON Polygon
Type: object

GeoProperty. Geojson reference to the item. Polygon

root allOf item 1 location oneOf GeoJSON Polygon type
Type: enum (of string)

Must be one of:

  • "Polygon"

root allOf item 1 location oneOf GeoJSON Polygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon coordinates coordinates items coordinates items items coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON Polygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON Polygon bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPoint
Type: object

GeoProperty. Geojson reference to the item. MultiPoint

root allOf item 1 location oneOf GeoJSON MultiPoint type
Type: enum (of string)

Must be one of:

  • "MultiPoint"

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates coordinates items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint coordinates coordinates items coordinates items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPoint bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPoint bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiLineString
Type: object

GeoProperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiLineString type
Type: enum (of string)

Must be one of:

  • "MultiLineString"

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items
Type: array of array

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items coordinates items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString coordinates coordinates items coordinates items items coordinates items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiLineString bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiLineString bbox bbox items
Type: number
root allOf item 1 location oneOf GeoJSON MultiPolygon
Type: object

GeoProperty. Geojson reference to the item. MultiLineString

root allOf item 1 location oneOf GeoJSON MultiPolygon type
Type: enum (of string)

Must be one of:

  • "MultiPolygon"

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items
Type: array of array

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items
Type: array of array

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items coordinates items items items
Type: array of number

Must contain a minimum of 2 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon coordinates coordinates items coordinates items items coordinates items items items coordinates items items items items
Type: number

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox
Type: array of number

Must contain a minimum of 4 items

Each item of this array must be:

root allOf item 1 location oneOf GeoJSON MultiPolygon bbox bbox items
Type: number

root allOf item 1 address
Type: object

Property. The mailing address. Model:'https://schema.org/address'

root allOf item 1 address streetAddress
Type: string

Property. The street address. Model:'https://schema.org/streetAddress'

root allOf item 1 address addressLocality
Type: string

Property. The locality in which the street address is, and which is in the region. Model:'https://schema.org/addressLocality'

root allOf item 1 address addressRegion
Type: string

Property. The region in which the locality is, and which is in the country. Model:'https://schema.org/addressRegion'

root allOf item 1 address addressCountry
Type: string

Property. The country. For example, Spain. Model:'https://schema.org/addressCountry'

root allOf item 1 address postalCode
Type: string

Property. The postal code. For example, 24004. Model:'https://schema.org/https://schema.org/postalCode'

root allOf item 1 address postOfficeBoxNumber
Type: string

Property. The post office box number for PO box addresses. For example, 03578. Model:'https://schema.org/postOfficeBoxNumber'

root allOf item 1 address streetNr
Type: string

Number identifying a specific property on a public street.

root allOf item 1 address district
Type: string

A district is a type of administrative division that, in some countries, is managed by the local government.

root allOf item 1 areaServed
Type: string

Property. The geographic area where a service or offered item is provided. Model:'https://schema.org/Text'
root allOf Common-Alert
Type: object

root allOf item 2 type
Type: enum (of string)

Property. NGSI Entity type. It has to be Alert.

Must be one of:

  • "Alert"

root allOf item 2 dateIssued
Type: stringFormat: date-time

Property. Model:'https://schema.org/DateTime'. The date and time the item was issued in ISO8601 UTC format.

root allOf item 2 validFrom
Type: stringFormat: date-time

Property. Model:'https://schema.org/DateTime'. The start of the validity period for this forecast as a ISO8601 format

root allOf item 2 validTo
Type: stringFormat: date-time

Property. Model:'https://schema.org/DateTime'. The end of the validity period for this forecast as a ISO8601 format

root allOf item 2 severity
Type: enum (of string)

Property. Severity of the Alarm

Must be one of:

  • "informational"
  • "low"
  • "medium"
  • "high"
  • "critical"

root allOf item 2 category
Type: enum (of string)

Property. Category of the Alert. Enum:'traffic, naturalDisaster, weather, environment, health, security, agriculture'

Must be one of:

  • "traffic"
  • "naturalDisaster"
  • "weather"
  • "environment"
  • "health"
  • "security"
  • "agriculture"

root allOf item 2 alertSource

Relationship. Source of the alert. Model:'http://schema.org/URL'.

root allOf item 2 alertSource anyOf item 0
Type: string

Property. Identifier format of any NGSI entity

Must match regular expression: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$

Must be at least 1 characters long

Must be at most 256 characters long

root allOf item 2 alertSource anyOf item 1
Type: stringFormat: uri

Property. Identifier format of any NGSI entity

root allOf item 2 data
Type: object

Property. Payload containing the data retrieved.
root allOf item 3
Type: object

root allOf item 3 subCategory

Property. Describe the sub category of alert. Enum:'trafficJam, carAccident, carWrongDirection, carStopped, pothole, roadClosed, roadWorks, hazardOnRoad, injuredBiker, pedestrianOnRoad, bikerOnRoad, tramApproaching, flood, tsunami, coastalEvent, earthquake, rainfall, highTemperature, lowTemperature, heatWave, coldWave, ice, snow, wind, fog, tornado, tropicalCyclone, hurricane, snow/ice, thunderstorms, fireRisk, avalancheRisk, floodRisk, airPollution, waterPollution, pollenConcentration, asthmaAttack, bumpedPatient, fallenPatient, heartAttack, suspiciousAction, robbery, assault, civilDisorder, buildingFire, forestFire, noxiousWeed, snail, insect, rodent, bacteria, microbe, fungus,mite, virus, nematodes, irrigation, fertilisation

root allOf item 3 subCategory anyOf item 0
Type: enum (of string)

Must be one of:

  • "trafficJam"
  • "carAccident"
  • "carWrongDirection"
  • "carStopped"
  • "pothole"
  • "roadClosed"
  • "roadWorks"
  • "hazardOnRoad"
  • "injuredBiker"
  • "pedestrianOnRoad"
  • "bikerOnRoad"
  • "tramApproaching"
  • "crowdRisk"
  • "flood"
  • "tsunami"
  • "coastalEvent"
  • "earthquake"
  • "rainfall"
  • "highTemperature"
  • "lowTemperature"
  • "lowHumidity"
  • "highHumidity"
  • "highAtmosphericPressure"
  • "losAtmosphericPressure"
  • "heatWave"
  • "coldWave"
  • "ice"
  • "snow"
  • "wind"
  • "fog"
  • "tornado"
  • "tropicalCyclone"
  • "hurricane"
  • "snow/ice"
  • "badSeaState"
  • "thunderstorms"
  • "fireRisk"
  • "avalancheRisk"
  • "floodRisk"
  • "airPollution"
  • "waterPollution"
  • "pollenConcentration"
  • "asthmaAttack"
  • "bumpedPatient"
  • "fallenPatient"
  • "heartAttack"
  • "suspiciousAction"
  • "robbery"
  • "assault"
  • "civilDisorder"
  • "buildingFire"
  • "forestFire"
  • "noxiousWeed"
  • "snail"
  • "insect"
  • "rodent"
  • "bacteria"
  • "microbe"
  • "fungus"
  • "mite"
  • "virus"
  • "nematodes"
  • "irrigation"
  • "fertilisation"
root allOf item 3 subCategory anyOf WeatherAlertCategories
Type: enum (of string)

Property. Weather categories. Enum:' avalanches,coastalEvent, coldWave, flood, fog, forestFire, heatWave, highTemperature, hurricane, ice, lowTemperature, rainfall, rainflood, snow, snowice, thunderstorms, tornado, tropicalCyclone, tsunami, wind'

Must be one of:

  • "avalanches"
  • "coastalEvent"
  • "coldWave"
  • "flood"
  • "fog"
  • "forestFire"
  • "heatWave"
  • "highTemperature"
  • "hurricane"
  • "ice"
  • "lowTemperature"
  • "rainfall"
  • "rain_flood"
  • "snow"
  • "snow_ice"
  • "thunderstorms"
  • "tornado"
  • "tropicalCyclone"
  • "tsunami"
  • "wind"

The following properties are required: