Skip to content

CS 1.0: SD-2688: Add Departure and Arrival transportCallReference #585

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HenrikHL merged 3 commits into from
Jan 8, 2026
Merged

CS 1.0: SD-2688: Add Departure and Arrival transportCallReference #585

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a35db61
CS 1.0: SD-2688: Add Departure and Arrival transportCallReference
HenrikHL Jan 6, 2026
98b1f06
Fix bug
HenrikHL Jan 6, 2026
08631f8
Modified according to review comments
HenrikHL Jan 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .stoplight/styleguide.json
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 28 additions & 4 deletions cs/v1/CS_v1.0.2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -604,7 +604,7 @@ paths:

- b) `carrierServiceCode` **&** `carrierVoyageNumber`: Get a specific full voyage within a service

- c) `carrierServiceCode` **&** `vesselIMONumber`: Get a specific vessel’s full voyages within a service.
- c) `carrierServiceCode` **&** `vesselIMONumber`: Get a specific vessel's full voyages within a service.

- d) `vesselIMONumber`: Get all full voyages for a specific vessel across all the services in which it is involved.

Expand Down Expand Up @@ -706,6 +706,14 @@ components:
- location
- dateTime
properties:
transportCallReference:
type: string
example: SR11111X-9321483-2107W-NLAMS-ACT-1-1
maxLength: 100
description: |
The unique reference for the arrival transport call. It's the vessel operator's responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.

**Note:** This property takes precedence over the `transportCallReference` in the Vessel-Transport or Barge-Transport objects. If both this property and a `transportCallReference` in the Vessel-Transport or Barge-Transport objects are provided- the `transportCallReference` in those objects must be ignored.
facilityTypeCode:
description: |
The code to identify the specific type of facility. The code indicates which role the facility plays during the transportCall.
Expand Down Expand Up @@ -740,6 +748,14 @@ components:
- location
- dateTime
properties:
transportCallReference:
type: string
example: SR11111X-9321483-2107W-NLAMS-ACT-1-1
maxLength: 100
description: |
The unique reference for the departure transport call. It's the vessel operator's responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.

**Note:** This property takes precedence over the `transportCallReference` in the Vessel-Transport or Barge-Transport objects. If both this property and a `transportCallReference` in the Vessel-Transport or Barge-Transport objects are provided- the `transportCallReference` in those objects must be ignored.
facilityTypeCode:
description: |
The code to identify the specific type of facility. The code indicates which role the facility plays during the transportCall.
Expand Down Expand Up @@ -949,7 +965,7 @@ components:
transportCallReference:
type: string
maxLength: 100
description: The unique reference for a transport call. It’s the vessel operator’s responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.
description: The unique reference for a transport call. It's the vessel operator's responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.
example: SR11111X-9321483-2107W-NLRTM-HPD2-1-1
carrierImportVoyageNumber:
type: string
Expand Down Expand Up @@ -1357,9 +1373,13 @@ components:
description: The unique reference that can be used to link different `transportCallReferences` to the same port visit. The reference is provided by the port to uniquely identify a port call.
transportCallReference:
type: string
deprecated: true
example: SR11111X-9321483-2107W-NLAMS-ACT-1-1
maxLength: 100
description: The unique reference for a transport call. It’s the vessel operator’s responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.
description: |
The unique reference for a transport call. It's the vessel operator's responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.

**Deprecated:** Please use the `transportCallReference` (in **Departure** object) or `transportCallReference` (in **Arrival** object) in order to specify what the **TransportCall** is linked to. If provided in either `Arrival` or `Departure` object - this property must be ignored.
servicePartners:
type: array
items:
Expand Down Expand Up @@ -1420,9 +1440,13 @@ components:
description: The unique reference that can be used to link different `transportCallReferences` to the same port visit. The reference is provided by the port to uniquely identify a port call.
transportCallReference:
type: string
deprecated: true
example: SR11111X-9321483-2107W-NLAMS-ACT-1-1
maxLength: 100
description: The unique reference for a transport call. It’s the vessel operator’s responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.
description: |
The unique reference for a transport call. It's the vessel operator's responsibility to provide the Transport Call Reference, other parties are obliged to pick it up and use it. It can take the form of Port Call References as defined in OVS Definitions Document, or alternatively a reference as defined by the vessel operator.

**Deprecated:** Please use the `transportCallReference` (in **Departure** object) or `transportCallReference` (in **Arrival** object) in order to specify what the **TransportCall** is linked to. If provided in either `Arrival` or `Departure` object - this property must be ignored.
servicePartners:
type: array
items:
Expand Down