Merge branch 'variable-co-main'

wbcsd · Mar 14, 2024 · 2ee7d17 · 2ee7d17
2 parents 7899bfd + 1e30d73
commit 2ee7d17
Show file tree

Hide file tree

Showing 2 changed files with 115 additions and 0 deletions.
diff --git a/spec/v2/examples/list-footprint-response.json b/spec/v2/examples/list-footprint-response.json
@@ -0,0 +1,79 @@
+{
+  "data": {
+    "id": "d9be4477-e351-45b3-acd9-e1da05e6f633",
+    "specVersion": "2.1.0",
+    "version": 1,
+    "created": "2022-05-22T21:47:32Z",
+    "status": "Active",
+    "companyName": "My Corp",
+    "companyIds": [
+      "urn:uuid:51131FB5-42A2-4267-A402-0ECFEFAD1619",
+      "urn:epc:id:sgln:4063973.00000.8"
+    ],
+    "productDescription": "Cote'd Or Ethanol",
+    "productIds": [
+      "urn:gtin:4712345060507"
+    ],
+    "productCategoryCpc": "3342",
+    "productNameCompany": "Green Ethanol",
+    "comment": "",
+    "pcf": {
+      "declaredUnit": "liter",
+      "unitaryProductAmount": "12.0",
+      "pCfExcludingBiogenic": "0.0",
+      "fossilGhgEmissions": "0.123",
+      "fossilCarbonContent": "0.0",
+      "biogenicCarbonContent": "0.0",
+      "landManagementGhgEmissions": "0.01",
+      "characterizationFactors": "AR5",
+      "crossSectoralStandardsUsed": [
+        "GHG Protocol Product standard"
+      ],
+      "productOrSectorSpecificRules": [
+        {
+          "operator": "EPD International",
+          "ruleNames": [
+            "ABC 2021"
+          ]
+        }
+      ],
+      "boundaryProcessesDescription": "End-of-life included",
+      "referencePeriodStart": "2021-01-01T00:00:00Z",
+      "referencePeriodEnd": "2022-01-01T00:00:00Z",
+      "geographyCountry": "FR",
+      "secondaryEmissionFactorSources": [
+        {
+          "name": "Ecoinvent",
+          "version": "1.2.3"
+        }
+      ],
+      "exemptedEmissionsPercent": 3.1,
+      "exemptedEmissionsDescription": "",
+      "packagingEmissionsIncluded": false,
+      "primaryDataShare": 56.12,
+      "assurance": {
+        "coverage": "product line",
+        "level": "reasonable",
+        "boundary": "Cradle-to-Gate",
+        "providerName": "My Auditor",
+        "completedAt": "2022-12-08T14:47:32Z",
+        "standardName": "ISO ...",
+        "comments": "This is a comment",
+        "assurance": false
+      }
+    },
+    "extensions": [
+      {
+        "specVersion": "2.0.0",
+        "dataSchema": "https://catalog.carbon-transparency.com/shipment/1.0.0/data-model.json",
+        "data": {
+          "shipmentId": "S1234567890",
+          "consignmentId": "Cabc.def-ghi",
+          "shipmentType": "PICKUP",
+          "weight": 10,
+          "transportChainElementId": "ABCDEFGHI"
+        }
+      }
+    ]
+  }
+}
diff --git a/spec/v2/index.bs b/spec/v2/index.bs
@@ -2277,6 +2277,13 @@ path: examples/list-footprints-response.json
 highlight: json
 </pre>
 
+Example response empty body:
+<pre highlight=json>
+{
+  "data": []
+}
+</pre>
+
 </div>
 
 ### Example Error Response ### {#api-error-response-example}
@@ -2450,6 +2457,35 @@ Example Response Event response headers
 </div>
 
 
+### Example Action GetFootprint request and response ### {#api-action-get-example}
+
+<div class="example">
+
+Example request:
+
+<pre highlight=http>
+GET /2/footprint/d9be4477-e351-45b3-acd9-e1da05e6f633 HTTP/2
+host: api.pathfinder.sine.dev
+authorization: Bearer [BearerToken]
+</pre>
+
+Example response HTTP headers:
+<pre highlight=http>
+HTTP/1.1 200 OK
+date: Mon, 23 May 2022 19:33:16 GMT
+content-type: application/json
+content-length: 1831
+server: Pathfinder
+</pre>
+
+Example response body:
+<pre class=include-code>
+path: examples/list-footprint-response.json
+highlight: json
+</pre>
+
+</div>
+
 # Appendix A: License # {#license}
 
 <pre class=include>