Skip to content

Commit 216c53e

Browse files
committed
CS 1.0: SD-2945: Add intermediateCalls to Legs
1 parent 4e9f734 commit 216c53e

1 file changed

Lines changed: 58 additions & 0 deletions

File tree

cs/v1/CS_v1.0.3.yaml

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1660,6 +1660,50 @@ components:
16601660
pattern: ^\S(?:.*\S)?$
16611661
description: The identifier of an export voyage. The carrier-specific identifier of the export Voyage.
16621662

1663+
IntermediateCall:
1664+
title: Intermediate Call
1665+
type: object
1666+
description: |
1667+
An intermediate call between `departure` and `arrival` in the current leg.
1668+
1669+
The cargo remains on the same planned transport, and no transhipment takes place at this location.
1670+
properties:
1671+
transportCallReference:
1672+
type: string
1673+
example: SR11111X-9321483-2107W-NLAMS-ACT-1-1
1674+
maxLength: 100
1675+
description: |
1676+
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.
1677+
facilityTypeCode:
1678+
description: |
1679+
The code to identify the specific type of facility. The code indicates which role the facility plays during the transportCall.
1680+
- `BORD` (Border)
1681+
- `CLOC` (Customer Location)
1682+
- `COFS` (Container Freight Station)
1683+
- `OFFD` (Off Dock Storage)
1684+
- `DEPO` (Depot)
1685+
- `INTE` (Inland Terminal)
1686+
- `POTE` (Port Terminal)
1687+
- `PBPL` (Pilot Boarding Place)
1688+
- `BRTH` (Berth)
1689+
- `RAMP` (Ramp)
1690+
- `WAYP` (Waypoint)
1691+
example: POTE
1692+
maxLength: 4
1693+
type: string
1694+
location:
1695+
$ref: '#/components/schemas/Location'
1696+
arrivalDateTime:
1697+
type: string
1698+
format: date-time
1699+
example: '2025-01-14T09:21:00+01:00'
1700+
description: The local date and time, when the arrival will take place.
1701+
departureDateTime:
1702+
type: string
1703+
format: date-time
1704+
example: '2025-01-14T09:21:00+01:00'
1705+
description: The local date and time, when the departure will take place.
1706+
16631707
Leg:
16641708
title: Leg
16651709
type: object
@@ -1681,6 +1725,20 @@ components:
16811725
- $ref: '#/components/schemas/OtherTransport'
16821726
departure:
16831727
$ref: '#/components/schemas/PlaceOfDeparture'
1728+
intermediateCalls:
1729+
type: array
1730+
description: |
1731+
The option to list all intermediate calls between `departure` and `arrival`.
1732+
1733+
Intermediate calls are calls where no transhipment and no change of mode of transport takes place.
1734+
1735+
This structure allows intermediate non-transhipment calls to be grouped under a single leg, enabling consumers to present them as collapsed or expanded elements in the user interface, instead of treating each call as a separate leg.
1736+
1737+
The list only includes calls taking place **between** the `departure` and `arrival` of the current leg.
1738+
1739+
The order of the list is the order of visits from `departure` to `arrival`.
1740+
items:
1741+
$ref: '#/components/schemas/IntermediateCall'
16841742
arrival:
16851743
$ref: '#/components/schemas/PlaceOfArrival'
16861744
footprint:

0 commit comments

Comments
 (0)