Implementing the DCSA Operational Vessel Schedules Standard

This is a guide to implementing the DCSA Operational Vessel Schedules (OVS) standard version 3.0.0, written for the technical teams of DCSA adopting organizations.

Reference Documentation

To get acquainted with the standard, refer to the introductory Operational Vessel Schedules standard page.To understand the key concepts, user stories, use cases and data overview of the standard, refer to the Operational Vessel Schedules documentation page.For an overview of the business processes addressed by the standard, refer to the DCSA Industry Blueprint.To understand the data structures used by the standard and how they can be mapped to your own organization's data types, consult the DCSA Information Model.

Implementing the Standard

To get acquainted with the general principles applicable when implementing any DCSA standard, consult the DCSA API Design and Implementation Principles.To review the reference implementation of the Operational Vessel Schedules standard, created by DCSA to verify the standard and used for measuring the conformance of adopter implementations, consult the Operational Vessel Schedules module of the DCSA conformance GitHub repository.
Schedule Publisher Implementation
To implement the Operational Vessel Schedules standard API as a schedule publisher, use your organization's technology stack to implement each endpoint of the DCSA Operational Vessel Schedules OpenAPI specification page.To ensure that your organization becomes a successful adopter in the DCSA Bill of Lading 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.
Schedule Consumer Implementation
To consume schedules published by any provider through the DCSA Operational Vessel Schedules standard API, use your organization's technology stack to build a backend API client application using the DCSA Operational Vessel Schedules OpenAPI specification page.You can use a DCSA conformance sandbox as a counterpart in your development, since it allows you to easily test the most relevant scenarios that your application needs to support.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.