BKG 2.0: SD-2733: Add Vessel-Voyage info per leg

bkg/v2/BKG_v2.0.4.yaml

@@ -5091,6 +5091,62 @@ components:
 
             **Note:** Use `ROU` when `routingReference` is used in order to comply with the need to add at least 1 `shipmentLocation` to a Booking request.
           example: PRE
+        departingVesselVoyage:
+          type: object
+          title: Vessel Voyage
+          description: |
+            Vessel and voyage details of a transport leg.
+
+            **Note:** This property is not to be used in combination with `locationTypeCode='ROU'`.
+          properties:
+            vesselName:
+              type: string
+              pattern: ^\S(?:.*\S)?$
+              maxLength: 50
+              description: |
+                The name of the Vessel given by the Vessel Operator and registered with IMO.
+              example: King of the Seas
+            vesselIMONumber:
+              type: string
+              pattern: ^\d{7,8}$
+              minLength: 7
+              maxLength: 8
+              description: |
+                The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel
+              example: '9321483'
+            carrierServiceCode:
+              type: string
+              pattern: ^\S(?:.*\S)?$
+              maxLength: 11
+              description: |
+                The carrier-specific code of the service for which the schedule details are published.
+              example: FE1
+            universalServiceReference:
+              type: string
+              pattern: ^SR\d{5}[A-Z]$
+              minLength: 8
+              maxLength: 8
+              description: |
+                A global unique service reference, as per DCSA standard, agreed by VSA partners for the service. The service reference must match the regular expression pattern: `SR\d{5}[A-Z]`. The letters `SR` followed by `5 digits`, followed by a checksum-character as a capital letter from `A to Z`.
+              example: SR12345A
+            carrierExportVoyageNumber:
+              type: string
+              pattern: ^\S(?:.*\S)?$
+              maxLength: 50
+              description: |
+                The identifier of an export voyage. The carrier-specific identifier of the export Voyage.
+              example: 2103S
+            universalExportVoyageReference:
+              type: string
+              pattern: ^\d{2}[0-9A-Z]{2}[NEWSR]$
+              minLength: 5
+              maxLength: 5
+              description: |
+                A global unique voyage reference for the export Voyage, as per DCSA standard, agreed by VSA partners for the voyage. The voyage reference must match the regular expression pattern: `\d{2}[0-9A-Z]{2}[NEWSR]`
+                - `2 digits` for the year
+                - `2 alphanumeric characters` for the sequence number of the voyage
+                - `1 character` for the direction/haul (`N`orth, `E`ast, `W`est, `S`outh or `R`oundtrip).
+              example: 2103N
       required:
         - location
         - locationTypeCode
@@ -6712,7 +6768,7 @@ components:
           minLength: 7
           maxLength: 8
           description: |
-            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel
+            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel
           example: '9321483'
         carrierServiceCode:
           type: string
@@ -7114,5 +7170,5 @@ components:
           minLength: 7
           maxLength: 8
           description: |
-            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel
+            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel
           example: '9321483'

cs/v1/CS_v1.0.2.yaml

@@ -494,7 +494,7 @@ paths:
             example: '9321483'
           in: query
           name: vesselIMONumber
-          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
+          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
         - schema:
             type: string
             maxLength: 50
@@ -1254,7 +1254,7 @@ components:
       properties:
         vesselIMONumber:
           type: string
-          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
+          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
           example: '9321483'
           pattern: ^\d{7,8}$
           minLength: 7
@@ -1308,7 +1308,7 @@ components:
       properties:
         vesselIMONumber:
           type: string
-          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
+          description: The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
           example: '9321483'
           pattern: ^\d{7,8}$
           minLength: 7

ovs_hub_ter/v1/OVS_HUB_TER_v1.0.0.yaml

@@ -395,7 +395,7 @@ components:
           minLength: 7
           maxLength: 8
           description: |
-            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
+            The unique reference for a registered Vessel. The reference is the International Maritime Organisation (IMO) number, also sometimes known as the Lloyd's register code, which does not change during the lifetime of the vessel.
           example: '9321483'
         MMSINumber:
           type: string