Skip to content

Latest commit

 

History

History
816 lines (759 loc) · 30.1 KB

spec.md

File metadata and controls

816 lines (759 loc) · 30.1 KB

Smart Data Models

Entity: KeyCardSwitch

Open License

document generated automatically

Global description: Smart Data Models Program adaptation of the original IoTData data Models. This Resource describes the operation of a KeyCard style switch. It has one mandatory Property,'stateofcard', which is a string enum type. It has two enum values: 'validCardInserted', 'validCardNotInserted'. 'validCardInserted' means that a keycard was inserted and passed validation check. 'validCardNotInserted' means that a keycard is not inserted or it was inserted but failed to pass validation check.

version: 0.0.1

List of properties

[*] If there is not a type in an attribute is because it could have several types or different formats/patterns

  • address[object]: The mailing address . Model: https://schema.org/address
  • alternateName[string]: An alternative name for this item
  • areaServed[string]: The geographic area where a service or offered item is provided . Model: https://schema.org/Text
  • dataProvider[string]: A sequence of characters identifying the provider of the harmonised data entity
  • dateCreated[date-time]: Entity creation timestamp. This will usually be allocated by the storage platform
  • dateModified[date-time]: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
  • description[string]: A description of this item
  • id[*]: Unique identifier of the entity
  • if[array]: The OCF Interface set supported by this Resource.
  • location[*]: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon
  • n[string]: Friendly name of the Resource
  • name[string]: The name of this item
  • owner[array]: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
  • rt[array]: The Resource Type of KeyCardSwitch
  • seeAlso[*]: list of uri pointing to additional resources about the item
  • source[string]: 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
  • stateofcard[string]: The status of the keycardswitch. 'validCardInserted' means that a keycard was inserted and passed validation check. 'validCardNotInserted' means that a keycard is not inserted or it was inserted but failed to pass validation check.
  • type[string]: NGSI entity type. It has to be KeyCardSwitch

Required properties

  • id
  • type

This data model comes from the original Open Connectivity Foundation repository. It has been extended to comply with NGSI requirements.

Data Model description of properties

Sorted alphabetically (click for details)

full yaml details 
KeyCardSwitch:      
  description: 'Smart Data Models Program adaptation of the original IoTData data Models. This Resource describes the operation of a KeyCard style switch. It has one mandatory Property,''stateofcard'', which is a string enum type. It has two enum values: ''validCardInserted'', ''validCardNotInserted''. ''validCardInserted'' means that a keycard was inserted and passed validation check. ''validCardNotInserted'' means that a keycard is not inserted or it was inserted but failed to pass validation check.'      
  properties:      
    address:      
      description: The mailing address      
      properties:      
        addressCountry:      
          description: 'The country. For example, Spain'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressCountry      
            type: Property      
        addressLocality:      
          description: 'The locality in which the street address is, and which is in the region'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressLocality      
            type: Property      
        addressRegion:      
          description: 'The region in which the locality is, and which is in the country'      
          type: string      
          x-ngsi:      
            model: https://schema.org/addressRegion      
            type: Property      
        district:      
          description: 'A district is a type of administrative division that, in some countries, is managed by the local government'      
          type: string      
          x-ngsi:      
            type: Property      
        postOfficeBoxNumber:      
          description: 'The post office box number for PO box addresses. For example, 03578'      
          type: string      
          x-ngsi:      
            model: https://schema.org/postOfficeBoxNumber      
            type: Property      
        postalCode:      
          description: 'The postal code. For example, 24004'      
          type: string      
          x-ngsi:      
            model: https://schema.org/https://schema.org/postalCode      
            type: Property      
        streetAddress:      
          description: The street address      
          type: string      
          x-ngsi:      
            model: https://schema.org/streetAddress      
            type: Property      
        streetNr:      
          description: Number identifying a specific property on a public street      
          type: string      
          x-ngsi:      
            type: Property      
      type: object      
      x-ngsi:      
        model: https://schema.org/address      
        type: Property      
    alternateName:      
      description: An alternative name for this item      
      type: string      
      x-ngsi:      
        type: Property      
    areaServed:      
      description: The geographic area where a service or offered item is provided      
      type: string      
      x-ngsi:      
        model: https://schema.org/Text      
        type: Property      
    dataProvider:      
      description: A sequence of characters identifying the provider of the harmonised data entity      
      type: string      
      x-ngsi:      
        type: Property      
    dateCreated:      
      description: Entity creation timestamp. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    dateModified:      
      description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform      
      format: date-time      
      type: string      
      x-ngsi:      
        type: Property      
    description:      
      description: A description of this item      
      type: string      
      x-ngsi:      
        type: Property      
    id:      
      anyOf:      
        - description: Identifier format of any NGSI entity      
          maxLength: 256      
          minLength: 1      
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
          type: string      
          x-ngsi:      
            type: Property      
        - description: Identifier format of any NGSI entity      
          format: uri      
          type: string      
          x-ngsi:      
            type: Property      
      description: Unique identifier of the entity      
      x-ngsi:      
        type: Property      
    if:      
      description: The OCF Interface set supported by this Resource.      
      items:      
        enum:      
          - oic.if.s      
          - oic.if.baseline      
        type: string      
      minItems: 2      
      readOnly: true      
      type: array      
      uniqueItems: true      
      x-ngsi:      
        type: Property      
    location:      
      description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'      
      oneOf:      
        - description: Geojson reference to the item. Point      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                type: number      
              minItems: 2      
              type: array      
            type:      
              enum:      
                - Point      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON Point      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. LineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  type: number      
                minItems: 2      
                type: array      
              minItems: 2      
              type: array      
            type:      
              enum:      
                - LineString      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON LineString      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. Polygon      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    type: number      
                  minItems: 2      
                  type: array      
                minItems: 4      
                type: array      
              type: array      
            type:      
              enum:      
                - Polygon      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON Polygon      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiPoint      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  type: number      
                minItems: 2      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiPoint      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiPoint      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiLineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    type: number      
                  minItems: 2      
                  type: array      
                minItems: 2      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiLineString      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiLineString      
          type: object      
          x-ngsi:      
            type: GeoProperty      
        - description: Geojson reference to the item. MultiLineString      
          properties:      
            bbox:      
              items:      
                type: number      
              minItems: 4      
              type: array      
            coordinates:      
              items:      
                items:      
                  items:      
                    items:      
                      type: number      
                    minItems: 2      
                    type: array      
                  minItems: 4      
                  type: array      
                type: array      
              type: array      
            type:      
              enum:      
                - MultiPolygon      
              type: string      
          required:      
            - type      
            - coordinates      
          title: GeoJSON MultiPolygon      
          type: object      
          x-ngsi:      
            type: GeoProperty      
      x-ngsi:      
        type: GeoProperty      
    n:      
      description: Friendly name of the Resource      
      maxLength: 64      
      readOnly: true      
      type: string      
      x-ngsi:      
        type: Property      
    name:      
      description: The name of this item      
      type: string      
      x-ngsi:      
        type: Property      
    owner:      
      description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)      
      items:      
        anyOf:      
          - description: Identifier format of any NGSI entity      
            maxLength: 256      
            minLength: 1      
            pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$      
            type: string      
            x-ngsi:      
              type: Property      
          - description: Identifier format of any NGSI entity      
            format: uri      
            type: string      
            x-ngsi:      
              type: Property      
        description: Unique identifier of the entity      
        x-ngsi:      
          type: Property      
      type: array      
      x-ngsi:      
        type: Property      
    rt:      
      description: The Resource Type of KeyCardSwitch      
      items:      
        enum:      
          - oic.r.keycardswitch      
        maxLength: 64      
        type: string      
      minItems: 1      
      readOnly: true      
      type: array      
      uniqueItems: true      
      x-ngsi:      
        type: Property      
    seeAlso:      
      description: list of uri pointing to additional resources about the item      
      oneOf:      
        - items:      
            format: uri      
            type: string      
          minItems: 1      
          type: array      
        - format: uri      
          type: string      
      x-ngsi:      
        type: Property      
    source:      
      description: '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'      
      type: string      
      x-ngsi:      
        type: Property      
    stateofcard:      
      description: The status of the keycardswitch. 'validCardInserted' means that a keycard was inserted and passed validation check. 'validCardNotInserted' means that a keycard is not inserted or it was inserted but failed to pass validation check.      
      enum:      
        - validCardInserted      
        - validCardNotInserted      
      readOnly: true      
      type: string      
      x-ngsi:      
        type: Property      
    type:      
      description: NGSI entity type. It has to be KeyCardSwitch      
      enum:      
        - KeyCardSwitch      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - id      
    - type      
  type: object      
  x-derived-from: https://github.com/OpenInterConnect/IoTDataModels/blob/master/KeyCardSwitchResURI.swagger.json      
  x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted  provided that the license conditions are met. Copyleft (c) 2022 Contributors to Smart Data Models Program'      
  x-license-url: https://github.com/smart-data-models/dataModel.OCF/blob/master/KeyCardSwitch/LICENSE.md      
  x-model-schema: https://smart-data-models.github.io/dataModel.IoTDataModels/KeyCardSwitch/schema.json      
  x-model-tags: OCF      
  x-version: 0.0.1

Example payloads

KeyCardSwitch NGSI-v2 key-values Example

Here is an example of a KeyCardSwitch in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues and returns the context data of an individual entity.

show/hide example 
{  
  "id": "urn:ngsi-ld:KeyCardSwitch:id:EICU:62882679",  
  "dateCreated": "1984-05-02T03:57:17Z",  
  "dateModified": "1990-10-10T17:17:22Z",  
  "source": "Early generation once couple whom would. Item toni",  
  "name": "Institution game o",  
  "alternateName": "Special say hundred ",  
  "description": "Go own involve region candidate there go. Provide finish card thousand. Why raise second pick thus.",  
  "dataProvider": "Total big nation couple writer picture voice. Easy charge centur",  
  "owner": [  
    "urn:ngsi-ld:KeyCardSwitch:items:MQFE:06102243",  
    "urn:ngsi-ld:KeyCardSwitch:items:JYJG:56880066"  
  ],  
  "seeAlso": [  
    "urn:ngsi-ld:KeyCardSwitch:items:QFUB:66511170"  
  ],  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      79.4951555,  
      -149.538487  
    ]  
  },  
  "address": {  
    "streetAddress": "View ball rock subject those decide bring. Number ok line use door.",  
    "addressLocality": "Deep relationship about fight mind. Really wall today cause position.",  
    "addressRegion": "Do authority religious college director thought. Hear air nat",  
    "addressCountry": "Enough accept nearly sport hotel. Know child away en",  
    "postalCode": "Near huge black. Would issue he need.",  
    "postOfficeBoxNumber": "S",  
    "streetNr": "System plan tax point analysis reduce. Individual stand work",  
    "district": "Writer share reduce child form. Growth smile clear information nothing heavy sport. Figure method church southern attorney fish."  
  },  
  "areaServed": "Campaign paper seven. List former movement throughout all red act.",  
  "rt": [  
    "oic.r.keycardswitch"  
  ],  
  "stateofcard": "validCardInserted",  
  "n": "Use su",  
  "if": [  
    "oic.if.baseline",  
    "oic.if.s"  
  ],  
  "type": "KeyCardSwitch"  
}

KeyCardSwitch NGSI-v2 normalized Example

Here is an example of a KeyCardSwitch in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.

show/hide example 
{  
  "id": "urn:ngsi-ld:KeyCardSwitch:id:EICU:62882679",  
  "dateCreated": {  
    "type": "DateTime",  
    "value": "1984-05-02T03:57:17Z"  
  },  
  "dateModified": {  
    "type": "DateTime",  
    "value": "1990-10-10T17:17:22Z"  
  },  
  "source": {  
    "type": "Text",  
    "value": "Early generation once couple whom would. Item toni"  
  },  
  "name": {  
    "type": "Text",  
    "value": "Institution game o"  
  },  
  "alternateName": {  
    "type": "Text",  
    "value": "Special say hundred "  
  },  
  "description": {  
    "type": "Text",  
    "value": "Go own involve region candidate there go. Provide finish card thousand. Why raise second pick thus."  
  },  
  "dataProvider": {  
    "type": "Text",  
    "value": "Total big nation couple writer picture voice. Easy charge centur"  
  },  
  "owner": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:KeyCardSwitch:items:MQFE:06102243",  
      "urn:ngsi-ld:KeyCardSwitch:items:JYJG:56880066"  
    ]  
  },  
  "seeAlso": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:KeyCardSwitch:items:QFUB:66511170"  
    ]  
  },  
  "location": {  
    "type": "geo:json",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        79.4951555,  
        -149.538487  
      ]  
    }  
  },  
  "address": {  
    "type": "StructuredValue",  
    "value": {  
      "streetAddress": "View ball rock subject those decide bring. Number ok line use door.",  
      "addressLocality": "Deep relationship about fight mind. Really wall today cause position.",  
      "addressRegion": "Do authority religious college director thought. Hear air nat",  
      "addressCountry": "Enough accept nearly sport hotel. Know child away en",  
      "postalCode": "Near huge black. Would issue he need.",  
      "postOfficeBoxNumber": "S",  
      "streetNr": "System plan tax point analysis reduce. Individual stand work",  
      "district": "Writer share reduce child form. Growth smile clear information nothing heavy sport. Figure method church southern attorney fish."  
    }  
  },  
  "areaServed": {  
    "type": "Text",  
    "value": "Campaign paper seven. List former movement throughout all red act."  
  },  
  "rt": {  
    "type": "StructuredValue",  
    "value": [  
      "oic.r.keycardswitch"  
    ]  
  },  
  "stateofcard": {  
    "type": "Text",  
    "value": "validCardInserted"  
  },  
  "n": {  
    "type": "Text",  
    "value": "Use su"  
  },  
  "if": {  
    "type": "StructuredValue",  
    "value": [  
      "oic.if.baseline",  
      "oic.if.s"  
    ]  
  },  
  "type": "KeyCardSwitch"  
}

KeyCardSwitch NGSI-LD key-values Example

Here is an example of a KeyCardSwitch in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues and returns the context data of an individual entity.

show/hide example 
{  
  "id": "urn:ngsi-ld:KeyCardSwitch:id:EICU:62882679",  
  "dateCreated": "1984-05-02T03:57:17Z",  
  "dateModified": "1990-10-10T17:17:22Z",  
  "source": "Early generation once couple whom would. Item toni",  
  "name": "Institution game o",  
  "alternateName": "Special say hundred ",  
  "description": "Go own involve region candidate there go. Provide finish card thousand. Why raise second pick thus.",  
  "dataProvider": "Total big nation couple writer picture voice. Easy charge centur",  
  "owner": [  
    "urn:ngsi-ld:KeyCardSwitch:items:MQFE:06102243",  
    "urn:ngsi-ld:KeyCardSwitch:items:JYJG:56880066"  
  ],  
  "seeAlso": [  
    "urn:ngsi-ld:KeyCardSwitch:items:QFUB:66511170"  
  ],  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      79.4951555,  
      -149.538487  
    ]  
  },  
  "address": {  
    "streetAddress": "View ball rock subject those decide bring. Number ok line use door.",  
    "addressLocality": "Deep relationship about fight mind. Really wall today cause position.",  
    "addressRegion": "Do authority religious college director thought. Hear air nat",  
    "addressCountry": "Enough accept nearly sport hotel. Know child away en",  
    "postalCode": "Near huge black. Would issue he need.",  
    "postOfficeBoxNumber": "S",  
    "streetNr": "System plan tax point analysis reduce. Individual stand work",  
    "district": "Writer share reduce child form. Growth smile clear information nothing heavy sport. Figure method church southern attorney fish."  
  },  
  "areaServed": "Campaign paper seven. List former movement throughout all red act.",  
  "rt": [  
    "oic.r.keycardswitch"  
  ],  
  "stateofcard": "validCardInserted",  
  "n": "Use su",  
  "if": [  
    "oic.if.baseline",  
    "oic.if.s"  
  ],  
  "type": "KeyCardSwitch",  
  "@context": [  
    "https://smartdatamodels.org/context.jsonld"  
  ]  
}

KeyCardSwitch NGSI-LD normalized Example

Here is an example of a KeyCardSwitch in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.

show/hide example 
{  
    "id": "urn:ngsi-ld:KeyCardSwitch:id:EICU:62882679",  
    "dateCreated": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "1984-05-02T03:57:17Z"  
        }  
    },  
    "dateModified": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "1990-10-10T17:17:22Z"  
        }  
    },  
    "source": {  
        "type": "Property",  
        "value": "Early generation once couple whom would. Item toni"  
    },  
    "name": {  
        "type": "Property",  
        "value": "Institution game o"  
    },  
    "alternateName": {  
        "type": "Property",  
        "value": "Special say hundred "  
    },  
    "description": {  
        "type": "Property",  
        "value": "Go own involve region candidate there go. Provide finish card thousand. Why raise second pick thus."  
    },  
    "dataProvider": {  
        "type": "Property",  
        "value": "Total big nation couple writer picture voice. Easy charge centur"  
    },  
    "owner": {  
        "type": "Property",  
        "value": [  
            "urn:ngsi-ld:KeyCardSwitch:items:MQFE:06102243",  
            "urn:ngsi-ld:KeyCardSwitch:items:JYJG:56880066"  
        ]  
    },  
    "seeAlso": {  
        "type": "Property",  
        "value": [  
            "urn:ngsi-ld:KeyCardSwitch:items:QFUB:66511170"  
        ]  
    },  
    "location": {  
        "type": "GeoProperty",  
        "value": {  
            "type": "Point",  
            "coordinates": [  
                79.4951555,  
                -149.538487  
            ]  
        }  
    },  
    "address": {  
        "type": "Property",  
        "value": {  
            "streetAddress": "View ball rock subject those decide bring. Number ok line use door.",  
            "addressLocality": "Deep relationship about fight mind. Really wall today cause position.",  
            "addressRegion": "Do authority religious college director thought. Hear air nat",  
            "addressCountry": "Enough accept nearly sport hotel. Know child away en",  
            "postalCode": "Near huge black. Would issue he need.",  
            "postOfficeBoxNumber": "S",  
            "streetNr": "System plan tax point analysis reduce. Individual stand work",  
            "district": "Writer share reduce child form. Growth smile clear information nothing heavy sport. Figure method church southern attorney fish."  
        }  
    },  
    "areaServed": {  
        "type": "Property",  
        "value": "Campaign paper seven. List former movement throughout all red act."  
    },  
    "rt": {  
        "type": "Property",  
        "value": [  
            "oic.r.keycardswitch"  
        ]  
    },  
    "stateofcard": {  
        "type": "Property",  
        "value": "validCardInserted"  
    },  
    "n": {  
        "type": "Property",  
        "value": "Use su"  
    },  
    "if": {  
        "type": "Property",  
        "value": [  
            "oic.if.baseline",  
            "oic.if.s"  
        ]  
    },  
    "type": "KeyCardSwitch",  
    "@context": [  
        "https://smartdatamodels.org/context.jsonld"  
    ]  
}

See FAQ 10 to get an answer on how to deal with magnitude units

Smart Data Models +++ Contribution Manual +++ About