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

DCSA CS 1.0.3 - Endpoint Overview

Archived copy: This immutable copy preserves Commercial Schedules v1.0.3. View the current v1 documentation.

Contents

• Introduction
  • OpenAPI specifications
  • Endpoints overview

Introduction

The following table provides a clear mapping between the use cases defined in the Commercial Schedules standard and the corresponding API endpoints specified in the CS API. Its purpose is to ensure a shared understanding of how each use case is supported by the API and which party has implemented the endpoint: Producer, typically an ocean carrier exposing commercial schedule data, or Consumer, typically a BCO, LSP, Solution Platform, or another party requesting and using commercial schedule data.

OpenAPI specifications

Commercial Schedules: OpenAPI specification

Endpoints overview

	Implemented by	UC1: Retrieve point-to-point routing alternatives	UC2: Retrieve port schedule	UC3: Retrieve vessel schedule
CS Consumer Endpoints	Consumer
CS Producer Endpoints	Producer	GET /v1/point-to-point-routes	GET /v1/port-schedules	GET /v1/vessel-schedules

All three CS endpoints are implemented by the Commercial Schedules Producer. The Commercial Schedules Consumer calls these endpoints to retrieve schedule information. There are no Consumer-implemented endpoints in the current CS endpoint overview.

Each Commercial Schedules endpoint can be implemented independently.