Skip to content

Latest commit

 

History

History
619 lines (563 loc) · 22.1 KB

File metadata and controls

619 lines (563 loc) · 22.1 KB

Smart Data Models

Entität: ComplaintsCollection

Offene Lizenz

Dokument automatisch generiert

Globale Beschreibung: Diese Einheit enthält eine harmonisierte Beschreibung einer generischen Beschwerdesammlung für den Bereich der Anrufbeschwerden.

Version: 0.0.2

Liste der Eigenschaften

[*] Wenn es für ein Attribut keinen Typ gibt, kann es mehrere Typen oder verschiedene Formate/Muster haben.

  • address[object]: Die Postanschrift . Model: https://schema.org/address
  • alternateName[string]: Ein alternativer Name für diesen Artikel
  • areaServed[string]: Das geografische Gebiet, in dem eine Dienstleistung oder ein angebotener Artikel erbracht wird . Model: https://schema.org/Text
  • dataProvider[string]: Eine Folge von Zeichen zur Identifizierung des Anbieters der harmonisierten Dateneinheit
  • dateCreated[date-time]: Zeitstempel der Entitätserstellung. Dieser wird normalerweise von der Speicherplattform zugewiesen
  • dateModified[date-time]: Zeitstempel der letzten Änderung der Entität. Dieser wird in der Regel von der Speicherplattform vergeben
  • description[string]: Eine Beschreibung dieses Artikels
  • groupedAt[date-time]: Der Zeitpunkt der Zusammenstellung der Beschwerden, aus denen diese Sammlung besteht . Model: https://schema.org/Time
  • hasCategories[array]: Array von Strings. Die Kategorien der Reklamationen, die in diese Sammlung gehören . Model: https://schema.org/Text
  • hasComplaints[array]: Die IDs der Reklamationen, die zu dieser Sammlung gehören . Model: https://schema.org/Text
  • id[*]: Eindeutiger Bezeichner der Entität
  • location[*]: Geojson-Referenz auf das Element. Es kann Punkt, LineString, Polygon, MultiPoint, MultiLineString oder MultiPolygon sein
  • name[string]: Der Name dieses Artikels
  • owner[array]: Eine Liste mit einer JSON-kodierten Zeichenfolge, die auf die eindeutigen Kennungen der Eigentümer verweist
  • seeAlso[*]: Liste von URLs, die auf zusätzliche Ressourcen zu dem Artikel verweisen
  • source[string]: Eine Folge von Zeichen, die die ursprüngliche Quelle der Entitätsdaten als URL angibt. Empfohlen wird der voll qualifizierte Domänenname des Quellanbieters oder die URL des Quellobjekts.
  • type[string]: NGSI-LD Entitätstyp. Er muss gleich Collection sein

Erforderliche Eigenschaften

  • id
  • type

Datenmodell Beschreibung der Eigenschaften

Alphabetisch sortiert (für Details anklicken)

full yaml details
ComplaintsCollection:      
  description: This entity contains a harmonised description of a generic Complaints Collection made for the Call Complaints domain.      
  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      
    groupedAt:      
      description: The time of grouping of the complaints that this Collection consists of      
      format: date-time      
      type: string      
      x-ngsi:      
        model: https://schema.org/Time      
        type: Property      
    hasCategories:      
      description: Array of Strings. The categories of the Complaints that belong in this Collection      
      items:      
        type: string      
      type: array      
      x-ngsi:      
        model: https://schema.org/Text      
        type: Property      
    hasComplaints:      
      description: The IDs of the Complaints that belong in this Collection      
      items:      
        format: uri      
        type: string      
      type: array      
      x-ngsi:      
        model: ' https://schema.org/Text'      
        type: Relationship      
    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      
    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      
    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      
    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      
    type:      
      description: NGSI-LD Entity Type. It must be equal to Collection      
      enum:      
        - ComplaintsCollection      
      type: string      
      x-ngsi:      
        type: Property      
  required:      
    - id      
    - type      
  type: object      
  x-derived-from: ""      
  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.CallComplaints/blob/master/ComplaintsCollection/LICENSE.md      
  x-model-schema: https://raw.githubusercontent.com/smart-data-models/dataModel.CallComplaints/master/ComplaintsCollection/schema.json      
  x-model-tags: ""      
  x-version: 0.0.2      

Beispiel-Nutzlasten

ComplaintsCollection NGSI-v2 key-values Beispiel

Hier ist ein Beispiel für eine ComplaintsCollection im JSON-LD-Format als Key-Values. Dies ist mit NGSI-v2 kompatibel, wenn options=keyValues verwendet wird und liefert die Kontextdaten einer einzelnen Entität.

show/hide example
{  
  "id": "urn:ngsi-ld:ComplaintsCollection:01",  
  "type": "ComplaintsCollection",  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      40.3,  
      25.5  
    ]  
  },  
  "hasCategories": [  
    "Brown water",  
    "Low pressure"  
  ],  
  "hasComplaints": [  
    "urn:ngsi-ld:Complaint:01",  
    "urn:ngsi-ld:Complaint:02"  
  ],  
  "groupedAt": "2021-04-19T10:00:00.000"  
}  

ComplaintsCollection NGSI-v2 normalisiert Beispiel

Hier ist ein Beispiel für eine ComplaintsCollection im JSON-LD-Format in normalisierter Form. Dies ist kompatibel mit NGSI-v2, wenn keine Optionen verwendet werden, und liefert die Kontextdaten einer einzelnen Entität.

show/hide example
{  
  "id": "urn:ngsi-ld:ComplaintsCollection:01",  
  "type": "ComplaintsCollection",  
  "location": {  
    "type": "geo:json",  
    "value": {  
      "type": "Point",  
      "coordinates": [  
        40.3,  
        25.5  
      ]  
    }  
  },  
  "hasCategories": {  
    "type": "StructuredValue",  
    "value": [  
      "Brown water",  
      "Low pressure"  
    ]  
  },  
  "hasComplaints": {  
    "type": "StructuredValue",  
    "value": [  
      "urn:ngsi-ld:Complaint:01",  
      "urn:ngsi-ld:Complaint:02"  
    ]  
  },  
  "groupedAt": {  
    "type": "DateTime",  
    "value": "2021-04-19T10:00:00.000"  
  }  
}  

ComplaintsCollection NGSI-LD Schlüsselwerte Beispiel

Hier ist ein Beispiel für eine ComplaintsCollection im JSON-LD-Format als Key-Values. Dies ist mit NGSI-LD kompatibel, wenn options=keyValues verwendet wird und liefert die Kontextdaten einer einzelnen Entität.

show/hide example
{  
  "id": "urn:ngsi-ld:ComplaintsCollection:01",  
  "type": "ComplaintsCollection",  
  "groupedAt": "2021-04-19T10:00:00.000",  
  "hasCategories": [  
    "Brown water",  
    "Low pressure"  
  ],  
  "hasComplaints": [  
    "urn:ngsi-ld:Complaint:01",  
    "urn:ngsi-ld:Complaint:02"  
  ],  
  "location": {  
    "type": "Point",  
    "coordinates": [  
      40.3,  
      25.5  
    ]  
  },  
  "@context": [  
    "https://raw.githubusercontent.com/smart-data-models/dataModel.CallComplaints/master/context.jsonld"  
  ]  
}  

ComplaintsCollection NGSI-LD normalisiert Beispiel

Hier ist ein Beispiel für eine ComplaintsCollection im JSON-LD-Format in normalisierter Form. Dies ist mit NGSI-LD kompatibel, wenn keine Optionen verwendet werden, und liefert die Kontextdaten einer einzelnen Entität.

show/hide example
{  
    "id": "urn:ngsi-ld:ComplaintsCollection:01",  
    "type": "ComplaintsCollection",  
    "groupedAt": {  
        "type": "Property",  
        "value": {  
            "@type": "DateTime",  
            "@value": "2021-04-19T10:00:00.000"  
        }  
    },  
    "hasCategories": {  
        "type": "Property",  
        "value": [  
            "Brown water",  
            "Low pressure"  
        ]  
    },  
    "hasComplaints": {  
        "type": "Relationship",  
        "object": [  
            "urn:ngsi-ld:Complaint:01",  
            "urn:ngsi-ld:Complaint:02"  
        ]  
    },  
    "location": {  
        "type": "GeoProperty",  
        "value": {  
            "type": "Point",  
            "coordinates": [  
                40.3,  
                25.5  
            ]  
        }  
    },  
    "@context": [  
        "https://raw.githubusercontent.com/smart-data-models/dataModel.CallComplaints/master/context.jsonld"  
    ]  
}  

Siehe [FAQ 10] (https://smartdatamodels.org/index.php/faqs/), um eine Antwort auf die Frage zu erhalten, wie man mit Größeneinheiten umgeht


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