DCSA Reference Documentation / Standards / Standard Releases / Commercial Schedules / Commercial Schedules v1

DCSA CS 1.0.3 - Implementation Guide

This is a guide to implementing the DCSA Commercial Schedules (CS) standard version 1.0, written for the technical teams of DCSA adopting organizations.

Contents

• Reference Documentation
• Implementing the Standard
  • Publisher (Producer) Implementation
  • Consumer Implementation

Reference Documentation

To get acquainted with the standard, refer to the Commercial Schedules Introduction.

To understand the key concepts, user stories, use cases, and data overview of the standard, refer to the Commercial Schedules documentation pages. For an overview of the business processes addressed by the standard, refer to the DCSA Industry Blueprint.

Implementing the Standard

The DCSA Commercial Schedules 1.0 standard is designed and is expected to be implemented following the DCSA API Design & Implementation Principles v2.0.

To review the reference implementation of the Commercial Schedules standard, created by DCSA to verify the standard and used for measuring the conformance of adopter implementations, consult the Commercial Schedules module of the DCSA conformance GitHub repository.

To ensure that your organization becomes a successful adopter in the DCSA Commercial Schedules standard API ecosystem, use the DCSA conformance framework periodically throughout your implementation project, to measure the conformance of your implementation and to improve it as needed.

You can use a DCSA conformance sandbox as a counterpart in your development, since it allows you to easily test the most relevant conformance scenarios that your application needs to support. The Commercial Schedules standard includes separate lists of conformance scenarios and validations for Point-to-Point Routings, Port Schedules, and Vessel Schedules that adopters are expected to support.

The DCSA Commercial Schedules OpenAPI specification is available with this distribution.

Publisher (Producer) Implementation

To implement the Commercial Schedules standard API as a publisher, use your organization’s technology stack to implement each of your needed “GET” endpoints of the DCSA Commercial Schedules OpenAPI specification.

Consumer Implementation

To consume schedules published by any provider through the DCSA Commercial Schedules standard API, use your organization’s technology stack to build a backend API client application using the DCSA Commercial Schedules OpenAPI specification page. As an alternative, you can also use directly the corresponding API specification page of one of the publishing organizations whose schedules you intend to retrieve through the DCSA standard API.