Merge pull request #977 from brentzundel/pallets

Add data about packaging

docs/openapi/components/schemas/common/AgriculturePackage.yml

@@ -111,6 +111,15 @@ properties:
     $linkedData:
       term: harvest
       '@id': https://w3id.org/traceability#AgricultureActivity
+  instrumentOfTrade:
+    title: Instrument of International Trade
+    description: The materials used for shipping the product, such as boxes, pallets, etc.
+    type: array
+    items:
+      $ref: ./InstrumentOfTrade.yml
+    $linkedData:
+      term: instrumentOfTrade
+      '@id': https://w3id.org/traceability#InstrumentOfTrade
 additionalProperties: true
 required:
   - type
@@ -199,5 +208,20 @@ example: |-
         "labelImageUrl": "https://img.example.org/033383401508/640/480/",
         "labelImageHash": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"
       }
+    ],
+    "instrumentOfTrade": [
+      {
+        "type": ["InstrumentOfTrade"],
+        "packagingMaterial": "wood",
+        "ippcStamp": {
+          "originCountry": "US",
+          "providerCode": "000",
+          "treatmentCode": "HT"
+        }
+      },
+      {
+        "type": ["InstrumentOfTrade"],
+        "packagingMaterial": "paper"
+      }
     ]
   }

docs/openapi/components/schemas/common/InstrumentOfTrade.yml

@@ -0,0 +1,76 @@
+$linkedData:
+  term: InstrumentOfTrade
+  '@id': https://w3id.org/traceability#InstrumentOfTrade
+title: Intrument of International Trade
+description: >-
+  The actual packaging (container, crate, pallet, etc.) which is used to
+  transport goods.
+type: object
+properties:
+  type:
+    type: array
+    readOnly: true
+    const:
+      - InstrumentOfTrade
+    default:
+      - IntrumentOfTrade
+    items:
+      type: string
+      enum:
+        - InstrumentOfTrade
+  packagingMaterial:
+    title: Packaging Material
+    description: >-
+      The material used for packaging the goods, e.g., wood, plastic, cardboard.
+    type: string
+  ippcStamp:
+    title: IPPC Stamp
+    type: object
+    description: >-
+      IPPC ISPM 15 stamp information as described in
+      https://www.ippc.int/en/publications/640/
+    properties:
+      originCountry:
+        title: Country
+        description: The two-letter ISO 3166-1 alpha-2 country code.
+        type: string
+      providerCode:
+        title: Provider Code
+        description: >-
+          The producer/treatment provider code is a unique code assigned by the
+          NPPO to the producer of the wood packaging material or treatment
+          provider who applies the marks or the entity otherwise responsible
+          to the NPPO for ensuring that appropriately treated wood is used and
+          properly marked (shown in the examples as “000”). The number and order
+          of digits and/or letters are assigned by the NPPO.
+        type: string
+      treatmentCode:
+        title: Treatment Code
+        description: >-
+          A treatment code using the appropriate abbreviation according to ISPM
+          15 (HT, DH, MB or SF).
+        type: string
+        enum:
+          - HT
+          - DH
+          - MB
+          - SF
+    additionalProperties: true
+    required:
+      - originCountry
+      - providerCode
+      - treatmentCode
+additionalProperties: true
+required:
+  - type
+  - packagingMaterial
+example: |-
+  {
+    "type": ["InstrumentOfTrade"],
+    "packagingMaterial": "wood",
+    "ippcStamp": {
+      "originCountry": "US",
+      "providerCode": "000",
+      "treatmentCode": "HT"
+    }
+  }