DCSA Reference Documentation / Standards / Standard Releases / Operational Vessel Schedules / Archive / Operational Vessel Schedules v3.0.2

DCSA OVS 3.0.2 - Conformance Scenarios

Archived copy: This immutable copy preserves Operational Vessel Schedules v3.0.2. View the current v3 documentation.

This page is republished as part of the complete documentation set for this version. No content changes were made compared to the 3.0.1 version.

Contents

• 1. What is Conformance?
• 2. Conformance Scenarios
  • • Service Schedules
    • Vessel Schedules
    • Location Schedules
    • Voyage Schedules
• 3. Conformance validations
  • • OVS message validations

1. What is Conformance?

Conformance refers to the validation process used to assess whether a carrier’s implementation of the Operational Vessel Schedules API adheres to the expected technical and business requirements defined by DCSA.

The objective is to ensure interoperability across carriers and systems by demonstrating that APIs behave correctly in realistic, standards-based scenarios.

2. Conformance Scenarios

This section lists scenarios used to assess a schedule publisher’s conformance with the OVS standard.

These scenarios measure the conformance of schedule publishers who implement the Service Schedules GET endpoint and return service schedules in response to requests from schedule consumers.

Any of these can be used to test and pass conformance. Conformance can be tested for all of them for the conformance report to include them all.

The scenarios are grouped by the supported filtering dimension.

Service Schedules

• SupplyScenarioParameters(carrierServiceName) - GetSchedules
• SupplyScenarioParameters(limit, carrierServiceName) - GetSchedules
• SupplyScenarioParameters(startDate, carrierServiceName) - GetSchedules
• SupplyScenarioParameters(endDate, carrierServiceName) - GetSchedules
• SupplyScenarioParameters(carrierServiceCode) - GetSchedules
• SupplyScenarioParameters(limit, carrierServiceCode) - GetSchedules
• SupplyScenarioParameters(universalServiceReference) - GetSchedules
• SupplyScenarioParameters(universalServiceReference, limit) - GetSchedules

Vessel Schedules

• SupplyScenarioParameters(vesselIMONumber) - GetSchedules
• SupplyScenarioParameters(vesselIMONumber, limit) - GetSchedules

Location Schedules

• SupplyScenarioParameters(UNLocationCode) - GetSchedules
• SupplyScenarioParameters(limit, UNLocationCode) - GetSchedules
• SupplyScenarioParameters(UNLocationCode, facilitySMDGCode) - GetSchedules
• SupplyScenarioParameters(UNLocationCode, facilitySMDGCode, limit) - GetSchedules

Voyage Schedules

• SupplyScenarioParameters(carrierServiceCode, carrierVoyageNumber) - GetSchedules
• SupplyScenarioParameters(limit, carrierVoyageNumber, carrierServiceCode) - GetSchedules
• SupplyScenarioParameters(universalServiceReference, carrierVoyageNumber) - GetSchedules
• SupplyScenarioParameters(limit, carrierVoyageNumber, universalServiceReference) - GetSchedules
• SupplyScenarioParameters(carrierServiceCode, universalVoyageReference) - GetSchedules
• SupplyScenarioParameters(limit, universalVoyageReference, carrierServiceCode) - GetSchedules
• SupplyScenarioParameters(universalServiceReference, universalVoyageReference) - GetSchedules
• SupplyScenarioParameters(limit, universalVoyageReference, universalServiceReference) - GetSchedules

3. Conformance validations

Conformance reports contain the text of each relevant custom validation below, either with a ✅ or with a 🚫 depending on whether the validation succeeded or failed.

• Default validations (URL, response code, schema) are included.
• Custom validations: user-defined rule that checks specific business or data requirements on top of the default technical validations during conformance testing.

OVS message validations

Every response received during a conformance test must not be empty.

The HTTP response status is correct.

The HTTP response matches the standard JSON schema.

Validate statusCodes in transportCalls