data-models

Building

This repository is now archived and subsequent works will be carried out the in Smart data models repositories.

Description

This entity contains a harmonised description of a Building. This entity is associated with the vertical segments of smart homes, smart cities, industry and related IoT applications.

This data model has been partially developed in cooperation with mobile operators and the GSMA, compared to GSMA data model following changes are introduced:

• the reference to BuildingType is removed, since BuildingType compared to category attribute does not introduce significant information.

• category attribute is required.

• openingHours is introduced following schema.org data model to allow fine-grained on building opening times. GSMA supported this as free text in the notes attribute (removed as well).

• refSubscriptionService is not supported, since SubscriptionService model is not supported currently.

Data Model

For a full description of the following attributes refer to GSMA IoT Big Data Harmonised Data Model

• id

• type

• source : A sequence of characters giving the source of the entity data.

  • Attribute type: Property. Text or URL
  • Optional

• dataProvider : Specifies the URL to information about the provider of this information

  • Attribute type: Property. URL
  • Optional

• dateModified : Last update timestamp of this entity.

  • Attribute type: Property. DateTime
  • Read-Only. Automatically generated.

• dateCreated : Entity’s creation timestamp.

  • Attribute type: Property. DateTime
  • Read-Only. Automatically generated.

• owner

  • Optional

• category

  • Required

• location

  • Attribute type: GeoProperty. geo:json.
  • Normative References: https://tools.ietf.org/html/rfc7946
  • Optional.

• containedInPlace

  • Optional.

• address

  • Attribute type: Property. Address
  • Normative References: https://schema.org/address
  • Required

• description

  • Attribute type: Property. Text
  • Normative References: https://uri.etsi.org/ngsi-ld/description equivalent to description
  • Optional

• occupier

  • Optional

• floorsAboveGround

  • Optional

• floorsBelowGround

  • Optional

• refMap

  • Optional

The following attribute has been introduced:

• openingHours : Opening hours of this building.
  • Normative references: https://schema.org/openingHours
  • Optional

Note: JSON Schemas are intended to capture the data type and associated constraints of the different Attributes, regardless their final representation format in NGSI(v2, LD).

Examples

Normalized Example

Normalized NGSI response

{
    "id": "building-a85e3da145c1",
    "type": "Building",
    "category": {
        "value": ["office"]
    },
    "floorsBelowGround": {
        "value": 0
    },
    "description": {
        "value": "Office block"
    },
    "floorsAboveGround": {
        "value": 7
    },
    "occupier": {
        "type": "Relationship",
        "value": ["9830f692-7677-11e6-838b-4f9fb3dc5a4f"]
    },
    "mapUrl": {
        "type": "URL",
        "value": "http://www.example.com"
    },
    "dateCreated": {
        "type": "DateTime",
        "value": "2016-08-08T10:18:16Z"
    },
    "source": {
        "value": "http://www.example.com"
    },
    "location": {
        "type": "geo:json",
        "value": {
            "type": "Polygon",
            "coordinates": [
                [
                    [100, 0],
                    [101, 0],
                    [101, 1],
                    [100, 1],
                    [100, 0]
                ]
            ]
        }
    },
    "address": {
        "type": "PostalAddress",
        "value": {
            "addressLocality": "London",
            "postalCode": "EC4N 8AF",
            "streetAddress": "25 Walbrook"
        }
    },
    "owner": {
        "type": "Relationship",
        "value": [
            "cdfd9cb8-ae2b-47cb-a43a-b9767ffd5c84",
            "1be9cd61-ef59-421f-a326-4b6c84411ad4"
        ]
    },
    "openingHours": {
        "value": ["Mo-Fr 10:00-19:00", "Sa 10:00-22:00", "Su 10:00-21:00"]
    },
    "dataProvider": {
        "value": "OperatorA"
    },
    "dateModified": {
        "type": "DateTime",
        "value": "2016-08-08T10:18:16Z"
    },
    "containedInPlace": {
        "value": {
            "type": "Polygon",
            "coordinates": [
                [
                    [100, 0],
                    [101, 0],
                    [101, 1],
                    [100, 1],
                    [100, 0]
                ]
            ]
        }
    }
}

key-value pairs Example

Sample uses simplified representation for data consumers ?options=keyValues

{
    "id": "building-a85e3da145c1",
    "type": "Building",
    "dateCreated": "2016-08-08T10:18:16Z",
    "dateModified": "2016-08-08T10:18:16Z",
    "source": "http://www.example.com",
    "dataProvider": "OperatorA",
    "category": ["office"],
    "containedInPlace": {
        "type": "Polygon",
        "coordinates": [
            [
                [100, 0],
                [101, 0],
                [101, 1],
                [100, 1],
                [100, 0]
            ]
        ]
    },
    "location": {
        "type": "Polygon",
        "coordinates": [
            [
                [100, 0],
                [101, 0],
                [101, 1],
                [100, 1],
                [100, 0]
            ]
        ]
    },
    "address": {
        "addressLocality": "London",
        "postalCode": "EC4N 8AF",
        "streetAddress": "25 Walbrook"
    },
    "owner": [
        "cdfd9cb8-ae2b-47cb-a43a-b9767ffd5c84",
        "1be9cd61-ef59-421f-a326-4b6c84411ad4"
    ],
    "occupier": ["9830f692-7677-11e6-838b-4f9fb3dc5a4f"],
    "floorsAboveGround": 7,
    "floorsBelowGround": 0,
    "description": "Office block",
    "mapUrl": "http://www.example.com",
    "openingHours": ["Mo-Fr 10:00-19:00", "Sa 10:00-22:00", "Su 10:00-21:00"]
}

LD Example

Sample uses the NGSI-LD representation

{
    "id": "urn:ngsi-ld:Building:building-a85e3da145c1",
    "type": "Building",
    "modifiedAt": "2016-08-08T10:18:16Z",
    "createdAt": "2016-08-08T10:18:16Z",
    "category": {
        "type": "Property",
        "value": ["office"]
    },
    "floorsBelowGround": {
        "type": "Property",
        "value": 0
    },
    "description": {
        "type": "Property",
        "value": "Office block"
    },
    "floorsAboveGround": {
        "type": "Property",
        "value": 7
    },
    "occupier": {
        "type": "Relationship",
        "object": ["urn:ngsi-ld:Person:9830f692-7677-11e6-838b-4f9fb3dc5a4f"]
    },
    "mapUrl": {
        "type": "Property",
        "value": "http://www.example.com"
    },
    "source": {
        "type": "Property",
        "value": "http://www.example.com"
    },
    "location": {
        "type": "GeoProperty",
        "value": {
            "type": "Polygon",
            "coordinates": [
                [
                    [100, 0],
                    [101, 0],
                    [101, 1],
                    [100, 1],
                    [100, 0]
                ]
            ]
        }
    },
    "address": {
        "type": "Property",
        "value": {
            "addressLocality": "London",
            "postalCode": "EC4N 8AF",
            "streetAddress": "25 Walbrook",
            "type": "PostalAddress"
        }
    },
    "owner": {
        "type": "Relationship",
        "object": [
            "urn:ngsi-ld:Person:cdfd9cb8-ae2b-47cb-a43a-b9767ffd5c84",
            "urn:ngsi-ld:Person:1be9cd61-ef59-421f-a326-4b6c84411ad4"
        ]
    },
    "openingHours": {
        "type": "Property",
        "value": ["Mo-Fr 10:00-19:00", "Sa 10:00-22:00", "Su 10:00-21:00"]
    },
    "dataProvider": {
        "type": "Property",
        "value": "OperatorA"
    },
    "containedInPlace": {
        "type": "Property",
        "value": {
            "type": "Polygon",
            "coordinates": [
                [
                    [100, 0],
                    [101, 0],
                    [101, 1],
                    [100, 1],
                    [100, 0]
                ]
            ]
        }
    },
    "@context": [
        "https://schema.lab.fiware.org/ld/context",
        "https://uri.etsi.org/ngsi-ld/v1/ngsi-ld-core-context.jsonld"
    ]
}

Test it with a real service

T.B.D.

This site is open source. Improve this page.