model.yaml

Operation:
  description: 'This data model is intended to provide information about commercial operations made in a stop of a ship during a PortCall (Berth entity). An Operation is defined as the activities related to commercial operations that take in place during the berth. Each Operation has an entity and some operations can be made in the same berth (docked or anchorage), and are distinguished by its sequence number on time (operationRank)'
  properties:
    address:
      description: The mailing address
      properties:
        addressCountry:
          description: 'The country. For example, Spain'
          type: string
          x-ngsi:
            model: https://schema.org/addressCountry
            type: Property
        addressLocality:
          description: 'The locality in which the street address is, and which is in the region'
          type: string
          x-ngsi:
            model: https://schema.org/addressLocality
            type: Property
        addressRegion:
          description: 'The region in which the locality is, and which is in the country'
          type: string
          x-ngsi:
            model: https://schema.org/addressRegion
            type: Property
        district:
          description: 'A district is a type of administrative division that, in some countries, is managed by the local government'
          type: string
          x-ngsi:
            type: Property
        postOfficeBoxNumber:
          description: 'The post office box number for PO box addresses. For example, 03578'
          type: string
          x-ngsi:
            model: https://schema.org/postOfficeBoxNumber
            type: Property
        postalCode:
          description: 'The postal code. For example, 24004'
          type: string
          x-ngsi:
            model: https://schema.org/https://schema.org/postalCode
            type: Property
        streetAddress:
          description: The street address
          type: string
          x-ngsi:
            model: https://schema.org/streetAddress
            type: Property
        streetNr:
          description: Number identifying a specific property on a public street
          type: string
          x-ngsi:
            type: Property
      type: object
      x-ngsi:
        model: https://schema.org/address
        type: Property
    alternateName:
      description: An alternative name for this item
      type: string
      x-ngsi:
        type: Property
    amount:
      description: Number of units loading/discharge
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
    areaServed:
      description: The geographic area where a service or offered item is provided
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    berthRef:
      description: 'Reference to parent MarineTransport:Berth entity'
      format: uri
      type: string
      x-ngsi:
        type: Relationship
    dataProvider:
      description: A sequence of characters identifying the provider of the harmonised data entity
      type: string
      x-ngsi:
        type: Property
    dateCreated:
      description: Entity creation timestamp. This will usually be allocated by the storage platform
      format: date-time
      type: string
      x-ngsi:
        type: Property
    dateModified:
      description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
      format: date-time
      type: string
      x-ngsi:
        type: Property
    description:
      description: A description of this item
      type: string
      x-ngsi:
        type: Property
    etc:
      description: 'Represented by an ISO 8601 UTC format, Date and time of Estimated Time of Arrival to Berth expected by Port Authority  (ISO 8601 UTC format). If this is the first berthing, the ETA-berth should be the same than ETA-PBP'
      format: date-time
      type: string
      x-ngsi:
        model: https://schema.org/DateTime
        type: Property
    ets:
      description: ""
      format: date-time
      type: string
      x-ngsi:
        model: 'https://schema.org/DateTime.Represented by an ISO 8601 UTC format, Date and time of Estimated Time of starting the operation.'
        type: Property
    id:
      anyOf:
        - description: Identifier format of any NGSI entity
          maxLength: 256
          minLength: 1
          pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
          type: string
          x-ngsi:
            type: Property
        - description: Identifier format of any NGSI entity
          format: uri
          type: string
          x-ngsi:
            type: Property
      description: Unique identifier of the entity
      x-ngsi:
        type: Relationship
    location:
      description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
      oneOf:
        - description: Geojson reference to the item. Point
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                type: number
              minItems: 2
              type: array
            type:
              enum:
                - Point
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON Point
          type: object
          x-ngsi:
            type: GeoProperty
        - description: Geojson reference to the item. LineString
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                items:
                  type: number
                minItems: 2
                type: array
              minItems: 2
              type: array
            type:
              enum:
                - LineString
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON LineString
          type: object
          x-ngsi:
            type: GeoProperty
        - description: Geojson reference to the item. Polygon
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                items:
                  items:
                    type: number
                  minItems: 2
                  type: array
                minItems: 4
                type: array
              type: array
            type:
              enum:
                - Polygon
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON Polygon
          type: object
          x-ngsi:
            type: GeoProperty
        - description: Geojson reference to the item. MultiPoint
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                items:
                  type: number
                minItems: 2
                type: array
              type: array
            type:
              enum:
                - MultiPoint
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON MultiPoint
          type: object
          x-ngsi:
            type: GeoProperty
        - description: Geojson reference to the item. MultiLineString
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                items:
                  items:
                    type: number
                  minItems: 2
                  type: array
                minItems: 2
                type: array
              type: array
            type:
              enum:
                - MultiLineString
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON MultiLineString
          type: object
          x-ngsi:
            type: GeoProperty
        - description: Geojson reference to the item. MultiLineString
          properties:
            bbox:
              items:
                type: number
              minItems: 4
              type: array
            coordinates:
              items:
                items:
                  items:
                    items:
                      type: number
                    minItems: 2
                    type: array
                  minItems: 4
                  type: array
                type: array
              type: array
            type:
              enum:
                - MultiPolygon
              type: string
          required:
            - type
            - coordinates
          title: GeoJSON MultiPolygon
          type: object
          x-ngsi:
            type: GeoProperty
      x-ngsi:
        type: GeoProperty
    manipulationMeansCode:
      description: 'Code identifying the manipulation means. Enum: 1=Vessel''s own resources, 2=Roll-on-roll-off ramp, 3=Dock cranes, 4=Automotive cranes, 5=Pipes, 6=Conveyor belts, 7=Pneumatic pumping installations, 8=Special installations, 9=Other means'''
      enum:
        - 1
        - 2
        - 3
        - 4
        - 5
        - 6
        - 7
        - 8
        - 9
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    manipulationMeansNumber:
      description: Number of manipulation means
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
    maxWeightPerUnit:
      description: Maximum Weight per unit loading/discharge
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
        units: Tm
    measureUnit:
      description: Unit type of load loading/discharge
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    name:
      description: The name of this item
      type: string
      x-ngsi:
        type: Property
    operationRank:
      description: 'Rank or Number of this Operation in all the commercial operations made in berth in the sequence of operations (discharge, charge, ...)'
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
    operationTypeCode:
      description: 'Code identifying the type of commercial operation. Enum: ''ZD=Disembarkation; ZE=Embarkation; ZT=Transshipment; ZR=Waste; AV=Victualling; DT=Disembarkation in transit; RE=Restow'''
      enum:
        - AV
        - DT
        - RE
        - ZD
        - ZE
        - ZR
        - ZT
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    owner:
      description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
      items:
        anyOf:
          - description: Identifier format of any NGSI entity
            maxLength: 256
            minLength: 1
            pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
            type: string
            x-ngsi:
              type: Property
          - description: Identifier format of any NGSI entity
            format: uri
            type: string
            x-ngsi:
              type: Property
        description: Unique identifier of the entity
        x-ngsi:
          type: Relationship
      type: array
      x-ngsi:
        type: Property
    portCallNumber:
      description: 'PortCall identifier in urn format. MarineTransport:PortCall:portCallNumber'
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    portCallRef:
      description: 'Reference to parent MarineTransport:PortCall entity'
      format: uri
      type: string
      x-ngsi:
        type: Relationship
    portCode:
      description: Code of the port of the call
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    position:
      description: Text specifying the position in the port where the operations has place
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    productCode:
      description: 'Code identifying the type of product of this operation. Enum: Z01=Crude oil; Z02=Fuel oil; Z03=Gas-oil; Z04=Gasoline; Z05=Asphalt; Z06=Other petroleum products; Z07=Petroleum energy gases; Z08=Iron ore; Z09=Pyrites; Z10=Other minerals; Z11=Iron scrap; Z12=Coals and petroleum coke; Z13=Steel products; Z14=Phosphates; Z15=Potasses; Z16=Natural and artificial fertilizers; Z17=Chemical products; Z18=Cement and clinker; Z19=Wood and cork; Z20=Construction materials; Z21=Cereals and their flour; Z22=Beans and soy flour; Z23=Fruits, vegetables and legumes; Z24=Wines, alcoholic beverages and derivatives; Z25=Common salt; Z26=Paper and pulp; Z27=Canned; Z28=Tobacco, cocoa, coffee and spices; Z29=Oils and fats; Z30=Other food products; Z31=Machinery, appliances, tools and spare parts; Z32=Automobiles and parts; Z33=Frozen fish; Z34=Rest of merchandise; Z35=Natural gas; Z36=Other metallurgical products; Z37=Feed and forage; Z38=Tare truck cargo platform; Z39=Container tare; Z40=Merchandise in transit containers; Z41=Containers full; Z42=Empty containers; Z43=Vehicles; Z44=Vehicle parts; Z91=Passengers; Z92=Cruise passengers; 1=Fresh fish; Z51=Biofuels; Z52=Other non-metallic minerals; ZR1=Dirty ballast; ZR2=Sludge and settling tanks; ZR3=Bilge oily water tanks; ZR4=Dirty waters; ZR5=Garbage;'
      enum:
        - Z01
        - Z02
        - Z03
        - Z04
        - Z05
        - Z06
        - Z07
        - Z08
        - Z09
        - Z10
        - Z11
        - Z12
        - Z13
        - Z14
        - Z15
        - Z16
        - Z17
        - Z18
        - Z19
        - Z20
        - Z21
        - Z22
        - Z23
        - Z24
        - Z25
        - Z26
        - Z27
        - Z28
        - Z29
        - Z30
        - Z31
        - Z32
        - Z33
        - Z34
        - Z35
        - Z36
        - Z37
        - Z38
        - Z39
        - Z40
        - Z41
        - Z42
        - Z43
        - Z44
        - Z91
        - Z92
        - Z51
        - Z52
        - ZR1
        - ZR2
        - ZR3
        - ZR4
        - ZR5
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    remarks:
      description: Remarks of the operation
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    seeAlso:
      description: list of uri pointing to additional resources about the item
      oneOf:
        - items:
            format: uri
            type: string
          minItems: 1
          type: array
        - format: uri
          type: string
      x-ngsi:
        type: Property
    source:
      description: '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'
      type: string
      x-ngsi:
        type: Property
    stevedoreRef:
      description: 'Id of the stevedore. Format urn:mrn:<oid>:portcalls:operation:stevedore:9999'
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    stopRank:
      description: Rank or Number of this stop in the stop (berth or anchor area) ordered by time sequence
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
    terminal:
      description: Terminal where the operation takes place
      type: string
      x-ngsi:
        model: https://schema.org/Text
        type: Property
    type:
      description: 'NGSI Entity type. It has to be Operation. In some international standards is also known as [Ship''s Stop]'
      enum:
        - Operation
      type: string
      x-ngsi:
        type: Property
    year:
      description: Year of the init of the berthing
      type: number
      x-ngsi:
        model: https://schema.org/Number
        type: Property
  required:
    - id
    - type
  type: object
  x-derived-from: ""
  x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted  provided that the license conditions are met. Copyleft (c) 2024 Contributors to Smart Data Models Program'
  x-license-url: https://github.com/smart-data-models/dataModel.MarineTransport/blob/master/Operation/LICENSE.md
  x-model-schema: https://raw.githubusercontent.com/smart-data-models/dataModel.MarineTransport/master/Berth/schema.json
  x-model-tags: ESHUV
  x-version: 0.0.1