DCSA Reference Documentation / Standards / Standard Releases / Commercial Schedules / Archive / Commercial Schedules v1.0.0

DCSA CS 1.0.0 - Conformance Scenarios

Archived release: Commercial Schedules v1.0.0 has been superseded. View the current v1 documentation.

This page is republished as part of the complete documentation set for this version. No content changes have been made from the 1.0.0 version.

Contents

1. What is Conformance?

Conformance refers to the validation process used to assess whether a carrier’s implementation of the Commercial Schedules APIs 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 the scenarios that are mandatory for a schedule publisher to be considered fully conformant with each module of the Commercial Schedules standard.

Pagination scenarios are optional for every standard module.

2.1. Point to Point Routings – GET Scenarios

These scenarios measure the conformance of routing publishers who implement the Point to Point Routings GET endpoint and return routings in response to requests from routing consumers.

Mandatory scenarios

SupplyScenarioParameters(placeOfDelivery, placeOfReceipt) + GET Routings

  • The publisher must support filtering by both placeOfDelivery and placeOfReceipt

2.2. Port Schedules – GET Scenarios

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

Mandatory scenarios

SupplyScenarioParameters(UNLocationCode, date) + GET Port Schedules

  • The publisher must support filtering by UNLocationCode and date

2.3. Vessel Schedules – GET Scenarios

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

The scenarios are grouped by the supported filtering dimension.

Vessel Schedules – Service

Mandatory scenarios

SupplyScenarioParameters(carrierServiceCode) + GET Vessel Schedules

  • The publisher must support filtering by carrierServiceCode

Vessel Schedules – Vessel

Mandatory scenarios

SupplyScenarioParameters(vesselIMONumber) + GET Vessel Schedules

  • The publisher must support filtering by vesselIMONumber

Vessel Schedules – Voyage

Mandatory scenarios

SupplyScenarioParameters(carrierVoyageNumber, carrierServiceCode) + GET Vessel Schedules

  • The publisher must support filtering by both carrierVoyageNumber and carrierServiceCode

Vessel Schedules – Location

Mandatory scenarios

SupplyScenarioParameters(UNLocationCode) + GET Vessel Schedules

  • The publisher must support filtering by UNLocationCode

SupplyScenarioParameters(UNLocationCode, facilitySMDGCode) + GET Vessel Schedules

  • The publisher must support filtering by both UNLocationCode and facilitySMDGCode

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.

Commercial Schedules message validations

  • For each endpoint:

    • 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 of the relevant Commercial Schedules schema
    • Validate allowed cut-off codes (if applicable)

  • CS - Point to Point Routings only: Validate ‘cutOffDateTimeCode’ and ‘receiptTypeAtOrigin’: LCO (LCL delivery cut-off) Condition: only when the Receipt Type at Origin is CFS