Merge pull request #94 from OpenDataManchester/63-components-update-j…

…son-and-csv-examples-to-match-version-2-schema Update Components JSON Example
OpenDataManchester · Sep 7, 2023 · efa787b · efa787b
2 parents 8a43c80 + b4d3ab6
commit efa787b
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 84 deletions.
diff --git a/docs/3_Data_Specification/3_3_Components.md b/docs/3_Data_Specification/3_3_Components.md
@@ -130,84 +130,65 @@ The specification of this csv file is as follows:
 === "JSON"
 
     ``` json linenums="1"
-    --Food grade PET circular pot made in the UK
-    {
-      "identifier": "278EFE8A-720A-06C1-A411-CB94878AD3E2",
-      "name": "Guacamole Dip Pot",
-      "description": "Clear PET pot for the Guacamole Dip",
-      "externalIdentifiers": {
-        "internalId": "GUA-PET-2022-1",
-        "GTIN": "00123456789012",
-        },
-      "imageURL": "",
-      "LOWcode": "15 01 02",
-      "materialIdentifier":"278EFE8A-720A-06C1-A411-CB94878AD3E2",
-      "height": 46,
-      "heightDate": "01/08/2022",
-      "width": 101,
-      "widthDate": "01/08/2022",
-      "depth": 101,
-      "depthDate": "01/08/2022",
-      "volume": "",
-      "volumeDate": "",
-      "weight": 6.85,
-      "weightTolerance": "4.38%",
-      "weightDate": "01/08/2022",
-      "shape": {
-        "identifier":"c-shape-0005",
-        "category":"cylinder",
-        "detailed":"3D shape with 2 parallel circular bases connected by a curved surface"
-      },
-      "function": {
-        "identifier":"function-0030",
-        "category":"pot",
-        "detailed":""
-      },
-      "flexibility": {
-        "identifier": "c-flexibility-0001",
-        "category": "Rigid",
-        "detailed": ""
-      },
-      "branding": "FALSE",
-      "componentRecyclingDisruptors": "",
-      "colour": "",
-      "opacity": {
-        "identifier": "c-opacity-0003",
-        "category": "transparent",
-        "detailed": "allows light to pass through so that objects behind can be distinctly seen; no colour/ clear"
-      },
-      "loaned": "FALSE",
-      "reuseSystems": "",
-      "manufacturedCountry": {
-        "Country": "United Kingdom of Great Britain and Northern Ireland (the)",
-        "Numeric": 826
-      },
-      "recycledContent": 90,
-      "recycledContentEvidenceType": {
-        "identifier":"c-recycled-evidence-0001",
-        "category":"certificate",
-        "detailed":""
-      },
-      "recycledContentEvidenceReference": "EXA-123-MPL-4-E",
-      "recyclability": "TRUE",
-      "recyclabilitySource": {
-        "identifier":"recyclability-source-0001",
-        "category":"OPRL",
-        "detailed":"OPRL is a not-for-profit company limited by guarantee, any surpluses being reinvested in our activities to promote recycling of packaging."
-      },
-      "recyclabilityDate": "01/08/2022",
-      "partOfMultipack": "TRUE",
-      "certification": "TRUE",
-      "certificationSource": {
-        "identifier": "certification-source-0002",
-        "category": "FSA",
-        "detailed": "The Food Standards Agency (FSA) is the independent government department working to protect public health and consumers’ wider interests in relation to food in England, Wales and Northern Ireland."
-      },
-      "certificationDate": "01/08/2022",
-      "updateDate": "01/08/2022",
-      "releaseDate": "01/08/2022",
-      "discontinueDate": ""
-    }
+    --Food grade PET pot made in Ireland
+{
+    "identifier": "9F459508-E365-0B9F-E3BB-FF4A7AED481B",
+    "name": "Thermoformed rPET tray",
+    "description": "Clear PET tray for food products",
+    "externalIdentifiers": {
+        "internalId": "14",
+        "GTIN": "00123456789012"
+    },
+    "imageURLs": [
+        "http://standard.open3p.org/2.0/img/measurements/figure1.measuring.png"
+    ],
+    "LOWcode": "150102",
+    "componentConstituents": [
+        "DCEE1F88-A83B-5BBC-D2D9-6A862B344977"
+    ],
+    "height": 50,
+    "heightDate": "01/08/2022",
+    "width": 220,
+    "widthDate": "01/08/2022",
+    "depth": 170,
+    "depthDate": "01/08/2022",
+    "volume": 1870,
+    "volumeDate": "01/08/2022",
+    "weight": 23,
+    "weightTolerance": 1.5,
+    "weightToleranceType": "grams",
+    "weightDate": "01/08/2022",
+    "shape": "c-shape-0004",
+    "function": "function-0041",
+    "flexibility": "c-flexibility-0002",
+    "branding": true,
+    "componentEndOfLifeRoutes": [
+
+    ],
+    "colour": "cmyk(0%,0%,0%,10%)",
+    "opacity": "c-opacity-0002",
+    "loaned": false,
+    "reuseSystems": [
+        "c-reuse-system-0001"
+    ],
+    "partOfMultipack": false,
+    "recycledContent": 0.3,
+    "recycledContentClaims": [
+        "23e8251a-4fe6-4b25-9966-b08acac9ba34"
+    ],
+    "recyclability": true,
+    "recyclabilityClaims": [
+        "b101889f-87e5-4c42-abb7-0df5fc3d1a26"
+    ],
+    "certification": true,
+    "certificationClaims": [
+        "eed87ac3-6e3e-45fb-af2c-dd0f64fdb597"
+    ],
+    "manufacturedCountry": 372,
+    "updateDate": "01/08/2022",
+    "releaseDate": "01/08/2022",
+    "discontinueDate": ""
+}
     ```
 === "CSV download"
 

diff --git a/docs/6_Relationship_Lists/6_005_Certification_Claims.md b/docs/6_Relationship_Lists/6_005_Certification_Claims.md
@@ -36,4 +36,16 @@ erDiagram
       CONTROLLED_LISTS {
     certificationSource required }
   }
-```
+```
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    --A certificate provided by the FSA
+{
+    "certificationIdentifier": "eed87ac3-6e3e-45fb-af2c-dd0f64fdb597",
+    "certificationSource": "certification-source-0002",
+    "certificationIssueDate": "01/08/2022"
+}
diff --git a/docs/6_Relationship_Lists/6_006_Recyclability_Claims.md b/docs/6_Relationship_Lists/6_006_Recyclability_Claims.md
@@ -5,7 +5,7 @@ description: The recyclability claims relationship list.
 
 # Recyclability Claims
 
-The recyclability claims relationship list identifies the materials that are combined to create components. This is used in the following schemas:
+The recyclability claims relationship list identifies organisations and schemes that provide the recyclability claims. This is used in the following schemas:
 
 * [Components](../3_Data_Specification/3_3_Components.md)
 * [Complete Packaging](../3_Data_Specification/3_4_Complete_Packaging.md)
@@ -33,4 +33,16 @@ erDiagram
       CONTROLLED_LISTS {
     recyclabilitySource required }
   }
-```
+```
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    --Claim provided by OPRL
+{
+    "recyclabilityIdentifier": "b101889f-87e5-4c42-abb7-0df5fc3d1a26",
+    "recyclabilitySource": "recyclability-source-0001",
+    "recyclabilityIssueDate": "01/08/2022"
+}
diff --git a/docs/6_Relationship_Lists/6_009_Recycled_Content_Claims.md b/docs/6_Relationship_Lists/6_009_Recycled_Content_Claims.md
@@ -5,13 +5,13 @@ description: The recycled content claims relationship list.
 
 # Recycled Content Claims
 
-The recycled content claims relationship list identifies the materials that are combined to create components. This is only used in [components](../3_Data_Specification/3_3_Components.md).
+The recycled content claims relationship list identifies the document that details the recycled content claim. This is only used in [components](../3_Data_Specification/3_3_Components.md).
 
 ## Data
 |Column|<div style="width:90px">Status</div>|Format|Notes|
 |:-|:-|:-|:-|
 |recycledContentIdentifier|`required`|String|A globally unique identifier. See [identifiers](../4_Identifiers/4_1_Identifiers.md) section for information on how to construct this identifier|
-|recycledContentEvidenceType|`recommended`|String|What source provided the certificate? The entry should be the [recyclability source controlled list](../5_Controlled_Lists/5_005_Recyclability_Source.md) identifier.|
+|recycledContentEvidenceType|`recommended`|String|What type of document provides the information regarding the claim? The entry should be the [recycled content evidence type](../5_Controlled_Lists/5_011_Recycled_Content_Evidence_Type.md) identifier.|
 |recycledContentEvidenceReference|`recommended`|String|An accompanying reference number associated with the recycled content evidence type for the component.|
 |recycledContentIssueDate|`recommended`|String|The date that the recycled content evidence was issued. Use the format `dd/mm/yyyy`.|
 
@@ -31,4 +31,17 @@ erDiagram
       CONTROLLED_LISTS {
     recycledContentEvidenceType required }
   }
-```
+```
+
+## Example
+
+=== "JSON"
+
+    ``` json linenums="1"
+    --A certificate providing information about a recycled content claim
+{
+    "recycledContentIdentifier": "23e8251a-4fe6-4b25-9966-b08acac9ba34",
+    "recycledContentEvidenceType": "c-recycled-evidence-0001",
+    "recycledContentEvidenceReference": "ABC-123-Example",
+    "recycledContentIssueDate": "01/08/2022"
+}