Skip to content

Commit 970e7aa

Browse files
updated CarbonFootprint/doc/spec.md
1 parent 28698bf commit 970e7aa

1 file changed

Lines changed: 12 additions & 2 deletions

File tree

CarbonFootprint/doc/spec.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,26 @@
77
[document generated automatically](https://docs.google.com/presentation/d/e/2PACX-1vTs-Ng5dIAwkg91oTTUdt8ua7woBXhPnwavZ0FxgR8BsAI_Ek3C5q97Nd94HS8KhP-r_quD4H0fgyt3/pub?start=false&loop=false&delayms=3000#slide=id.gb715ace035_0_60)
88
<!-- /15-License -->
99
<!-- 20-Description -->
10+
Global description: **Data model to represent the carbon footprint in CO2 equivalents.**
11+
version: 0.0.1
1012
<!-- /20-Description -->
1113
<!-- 30-PropertiesList -->
1214

1315
## List of properties
1416

1517
<sup><sub>[*] If there is not a type in an attribute is because it could have several types or different formats/patterns</sub></sup>
16-
<!-- /30-PropertiesList -->
18+
- `CO2eq[number]`: Amount of emissions in tons of CO2 equivalent . Model: [https://schema.org/Number](https://schema.org/Number)- `address[object]`: The mailing address . Model: [https://schema.org/address](https://schema.org/address) - `addressCountry[string]`: The country. For example, Spain . Model: [https://schema.org/addressCountry](https://schema.org/addressCountry)
19+
- `addressLocality[string]`: The locality in which the street address is, and which is in the region . Model: [https://schema.org/addressLocality](https://schema.org/addressLocality)
20+
- `addressRegion[string]`: The region in which the locality is, and which is in the country . Model: [https://schema.org/addressRegion](https://schema.org/addressRegion)
21+
- `district[string]`: A district is a type of administrative division that, in some countries, is managed by the local government
22+
- `postOfficeBoxNumber[string]`: The post office box number for PO box addresses. For example, 03578 . Model: [https://schema.org/postOfficeBoxNumber](https://schema.org/postOfficeBoxNumber)
23+
- `postalCode[string]`: The postal code. For example, 24004 . Model: [https://schema.org/https://schema.org/postalCode](https://schema.org/https://schema.org/postalCode)
24+
- `streetAddress[string]`: The street address . Model: [https://schema.org/streetAddress](https://schema.org/streetAddress)
25+
- `streetNr[string]`: Number identifying a specific property on a public street
26+
- `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](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 - `emissionDate[date-time]`: Date and time of the measurement . Model: [https://schema.org/Text](https://schema.org/Text)- `emissionSource[string]`: Source of emissions (e.g., Transport, Energy, Industry) - `id[*]`: Unique identifier of the entity - `location[*]`: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon - `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) - `relatedSource[uri]`: Reference to the data source or related entity - `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 - `tags[array]`: Tags associated with the carbon footprint calculation. - `type[string]`: NGSI Entity type. It must be 'CarbonFootprint' <!-- /30-PropertiesList -->
1727
<!-- 35-RequiredProperties -->
1828
Required properties
19-
- No required properties <!-- /35-RequiredProperties -->
29+
- `id` - `type` <!-- /35-RequiredProperties -->
2030
<!-- 40-NotesYaml -->
2131
<!-- /40-NotesYaml -->
2232
<!-- 50-DataModelHeader -->

0 commit comments

Comments
 (0)