TransferEvent.yml

$linkedData:
  term: TransferEvent
  '@id': https://w3id.org/traceability#TransferEvent
title: Transfer Event
description: A transfer custody or ownership event, extending the Event schema.
type: object
properties:
  type:
    type: array
    readOnly: true
    const:
      - Event
      - TransferEvent
    default:
      - Event
      - TransferEvent
    items:
      type: string
      enum:
        - Event
        - TransferEvent
  eventType:
    type: string
    enum:
      - TransferOwnership
      - TransferCustody
  eventId:
    type: string
  eventTime:
    type: string
  place:
    title: Place
    description: Information on where the event took place.
    $ref: ./Place.yml
    $linkedData:
      term: place
      '@id': https://schema.org/Place
  price:
    title: Price
    description: >-
      The offer price of a product.
    type: number
    $linkedData:
      term: price
      '@id': https://schema.org/price
  products:
    title: Products
    description: The products referenced by the event in hashlinks.
    type: array
    items:
      type: string
      format: url
    $linkedData:
      term: products
      '@id': https://schema.org/Product
  actor:
    title: Event Actors
    description: >-
      List of organizations acted on the event, https://w3id.org/traceability#Organization
    type: array
    items:
      $ref: ./Organization.yml
    $linkedData:
      term: organization
      '@id': https://w3id.org/traceability#Organization
  initiator:
    title: Initiator Identifier
    description: Identifiers for the initiator of transfer.
    type: string
    $linkedData:
      term: identifier
      '@id': https://w3id.org/traceability#initiator
  receiver:
    title: Receiver Identifier
    description: Identifiers for the receiver of transfer.
    type: string
    $linkedData:
      term: identifier
      '@id': https://w3id.org/traceability#receiver
  portOfArrival:
    title: Port of Arrival
    description: Port of arrival to which the product(s) were transferred
    $ref: ./Place.yml
    $linkedData:
      term: place
      '@id': https://schema.org/Place
  portOfEntry:
    title: Port of Entry
    description: Port of entry to which the product(s) were transferred
    $ref: ./Place.yml
    $linkedData:
      term: place
      '@id': https://schema.org/Place
  portOfDestination:
    title: Port of Destination
    description: Port of destination to which the product[s) were transferred
    $ref: ./Place.yml
    $linkedData:
      term: place
      '@id': https://schema.org/Place
  countryOfDestination:
    title: Country of Destination
    description: Country to which the product(s) were transferred.
    type: string
    $linkedData:
      term: addressCountry
      '@id': https://schema.org/addressCountry
  receiptLocation:
    title: Receipt Location
    description: The address from which the commodity is being shipped
    $ref: ./Place.yml
    $linkedData:
      term: place
      '@id': https://schema.org/Place
additionalProperties: false
required:
  - type
example: |-
  {
    "type": [
      "Event",
      "TransferEvent"
    ],
    "eventType": "TransferOwnership",
    "eventId": "b9d46bb9-9c0f-48aa-8d7d-d115aa9b1121",
    "eventTime": "2022-04-01T19:13:48.305Z",
    "place": {
      "geo": {
        "type": [
          "GeoCoordinates"
        ],
        "latitude": "42.8864",
        "longitude": "-78.8784"
      },
      "type": [
        "Place"
      ],
      "address": {
        "type": [
          "PostalAddress"
        ],
        "postalCode": "",
        "addressRegion": "New York",
        "streetAddress": "",
        "addressCountry": "US",
        "addressLocality": "Buffalo"
      }
    },
    "price": 1200,
    "products": [
      "http://example.org/products/05b6867b-2211-4c8f-ae7a-2a770b9510af?hl=ZfqLwiBj3yidP7p344d71z8ybyjb2+YVfhckGGHHEzk="
    ],
    "actor": [
      {
        "name": "Fabricator Co.",
        "type": [
          "Organization"
        ]
      },
      {
        "name": "Steel Co.",
        "type": [
          "Organization"
        ]
      }
    ],
    "initiator": "did:key:z6MkiQ89X1yScaGBJ5sVS62wGFAhzyz1zPiwmK8GrchJ5EKX",
    "receiver": "did:key:z6Mko5QGjK56EwM59qdjn99TrJqQFvNcokxwwCTUJ8sfiG4Z",
    "portOfArrival": {
      "geo": {
        "type": [
          "GeoCoordinates"
        ],
        "latitude": "42.8864",
        "longitude": "-78.8784"
      },
      "type": [
        "Place"
      ],
      "address": {
        "type": [
          "PostalAddress"
        ],
        "postalCode": "",
        "addressRegion": "New York",
        "streetAddress": "",
        "addressCountry": "USA",
        "addressLocality": "Buffalo"
      }
    },
    "portOfEntry": {
      "geo": {
        "type": [
          "GeoCoordinates"
        ],
        "latitude": "42.8864",
        "longitude": "-78.8784"
      },
      "type": [
        "Place"
      ],
      "address": {
        "type": [
          "PostalAddress"
        ],
        "postalCode": "",
        "addressRegion": "New York",
        "streetAddress": "",
        "addressCountry": "USA",
        "addressLocality": "Buffalo"
      }
    },
    "portOfDestination": {
      "geo": {
        "type": [
          "GeoCoordinates"
        ],
        "latitude": "42.8864",
        "longitude": "-78.8784"
      },
      "type": [
        "Place"
      ],
      "address": {
        "type": [
          "PostalAddress"
        ],
        "postalCode": "",
        "addressRegion": "New York",
        "streetAddress": "",
        "addressCountry": "USA",
        "addressLocality": "Buffalo"
      }
    },
    "countryOfDestination": "CA"
  }