diff --git a/cs/v1/CS_v1.0.4.yaml b/cs/v1/CS_v1.0.4.yaml index 4c28d8f3..d5b0af11 100644 --- a/cs/v1/CS_v1.0.4.yaml +++ b/cs/v1/CS_v1.0.4.yaml @@ -1051,6 +1051,21 @@ components: $ref: '#/components/schemas/CutOffTime' location: $ref: '#/components/schemas/TransportCallLocation' + isCargoOperationalCall: + type: boolean + default: true + description: | + Indicates whether cargo loading and/or discharge is applicable at the transport call. + - `true`: cargo loading and/or discharge is applicable. + - `false`: cargo loading and/or discharge are not applicable. + - If omitted, the value **MUST** be interpreted as `true`. + + The property is independent of whether the associated timestamps are Planned (`PLN`), Estimated (`EST`) or Actual (`ACT`). It does not indicate whether cargo was actually loaded or discharged. + + Other activities, such as bunkering, do not change this classification when cargo operations are also applicable. + + Consumers requiring only cargo-operational calls can filter out calls where this property is `false`. + example: false timestamps: type: array minItems: 1 diff --git a/cs/v1/README.md b/cs/v1/README.md index f027d5b1..4ac424c5 100644 --- a/cs/v1/README.md +++ b/cs/v1/README.md @@ -3,6 +3,14 @@ The DCSA Commercial Schedules API is specified on [**SwaggerHub**](https://app.swaggerhub.com/apis/dcsaorg/DCSA_CS). [Release v1.0.4](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_CS/1.0.4) +--- +Identify cargo-operational calls in Vessel Schedules. + +- Added optional `isCargoOperationalCall` to `TransportCall` in Vessel Schedules to indicate whether cargo loading and/or discharge is applicable at the call. + - If omitted, the value **MUST** be interpreted as `true`. + - `false` indicates that neither cargo loading nor cargo discharge is applicable, allowing consumers to filter these calls while retaining access to the complete published vessel rotation. + - The classification is independent of Planned (`PLN`), Estimated (`EST`) or Actual (`ACT`) timestamps and does not indicate whether cargo was actually loaded or discharged. + - Calls combining cargo operations with other activities, such as bunkering, remain cargo-operational. [Release v1.0.3 (12 June 2026)](https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_CS/1.0.3) ---