Booking API::Booking API (Consumer)

DCSA Repository / Interface Standards / Interface Standard Booking 2.0.0 and Bill of Lading 3.0.0 / Booking and eBL Application Components and APIs - Conceptual Model / Booking API / Booking API (Consumer)

Project:

Booking API

Booking API (Consumer) : Public abstract <<ArchiMate_ApplicationInterface>> ApplicationInterface

Created:	11/11/2024 11:17:44 AM
Modified:	1/9/2025 4:25:14 PM
Author:	DCSA
Version:	2024.4

Project:
Author:	DCSA
Version:	2024.4
Phase:	1.0
Status:	Published
Complexity:	Easy
Difficulty:
Priority:
Multiplicity:
Advanced:
UUID:	{A4FA5ABD-45DF-4d83-BA66-5B7066F64424}
Appears In:	Booking API - Conceptual Model REVIEW, Booking 2.0.0 - Generic - Sequence Model, Booking 2.0.0 - Poll Notifications - Sequence Model, Booking 2.0.0 - Send to all subscribers / Full Push Notifcations - Sequence Model, Booking 2.0.0 - Lightweight Notification - Sequence Model, Booking 2.0.0 - Use Case 3 Submit updated Booking Request - Sequence Model, Booking 2.0.0 - Use Case 1 Submit Booking Request - Sequence Model, Booking 2.0.0 - Use Case 5 Confirm Booking Request - Sequence Model, Booking 2.0.0 - Use Case 7 Request amendment to Confirmed Booking - Sequence Model, Booking 2.0.0 - Use Case 8 Process Amendment to Confirmed Booking - Sequence Model, eBL 3.0.0 - Use Case 1 Submit Shipping Instructions - Sequence Model, eBL 3.0.0 - Use Case 6 Publish Draft Transport Document - Sequence Model, eBL 3.0.0 - Use Case Shipper downloads copy of Transport Document - Sequence Model, eBL 3.0.0 - Use Case 7 Approve Draft Transport Document - Sequence Model, eBL 3.0.0 - Use Case 8 Issue Transport Document - Sequence Model, eBL 3.0.0 - Use Case 9 Request surrender Transport Document (Amendment) - Sequence Model, eBL 3.0.0 - Use Case 10 Process Transport Document surrender request (amendment)] - Sequence Model, eBL 3.0.0 - Use Case 11 Void original Transport Document and issue amended Transport Document - Sequence Model, eBL 3.0.0 - Use Case 12 Request surrender Transport Document (delivery) - Sequence Model, eBL 3.0.0 - Use Case 13 Process Transport Document surrender request (delivery) - Sequence Model, eBL 3.0.0 - Use Case 3 Submit updated Shipping Instructions - Sequence Model, eBL 3.0.0 - Use Case 2 Request to Update Shipping Instructions - Sequence Model, eBL 3.0.0 - Use Case 4 Process updated Shipping Instructions - Sequence Model, eBL 3.0.0 - Use Case 5 Cancel update to Shipping Instructions - Sequence Model, Booking 2.0.0 - Use Case 4 Reject Booking Request - Sequence Model, Booking 2.0.0 - Use Case 6 Request to amend Confirmed Booking - Sequence Model, Booking 2.0.0 - Use Case 9 Cancel Amendment to Confirmed Booking - Sequence Model, Booking 2.0.0 - Use Case 10 Decline Booking by Carrier - Sequence Model, Booking 2.0.0 - Use Case 11 Cancel Booking by Shipper - Sequence Model, Booking 2.0.0 - Use Case 12 Confirm Booking Completed - Sequence Model, Booking 2.0.0 - Use Case 2 Request to update Booking Request - Sequence Model, Booking 2.0.0 - Use Case 13 Cancel confirm Booking Completed by Shipper- Sequence Model, Booking 2.0.0 - Use Case 14 Process Booking cancellation - Sequence Model, eBL 3.0.0 - Send to all subscribers (SI) / Full Push Notifications - Sequence Model, eBL 3.0.0 - Send to all subscribers (TD) / Full Push Notifications - Sequence Model, eBL 3.0.0 - SI Poll Notifications - Sequence Model, eBL 3.0.0 - TD Poll Notifications - Sequence Model, eBL 3.0.0 - SI Lightweight Notification - Sequence Model, eBL 3.0.0 - TD Lightweight Notification - Sequence Model, Booking and eBL Application Components and APIs - Conceptual Model

Send a new Booking Notification. Creates a new Booking Notification. This endPoint is called whenever a Booking that a consumer has subscribed to changes state or is updated. This endPoint is to be implemented by a consumer of the Booking API in order to receive Notifications

Operations
Associations From
Messages To
Messages From
Advanced

Operation

Public
Post Booking Notifications () : void

Details:

Notes:

Creates a new Booking Notification. This endPoint is called whenever a Booking that a consumer has subscribed to changes state or is updated. This endPoint is to be implemented by a consumer of the Booking API in order to receive Notifications.

[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]

Element	Source Role	Target Role
«ArchiMate_ApplicationComponent» Carrier Internal System ApplicationComponent «ArchiMate_Association»	Name:	Name:
Details:
«ArchiMate_ApplicationComponent» Shipper Internal System ApplicationComponent «ArchiMate_Association»	Name:	Name:
Details:

Element	Message
«ArchiMate_ApplicationComponent» Shipper Internal System
Details: Type: Sequence Asynchronous Call
«ArchiMate_ApplicationComponent» Shipper Internal System
Details: Type: Sequence Asynchronous Call

Element	Message
«ArchiMate_ApplicationComponent» Carrier Internal System	Post Booking Notifications()
Details: Type: Sequence Synchronous Call
«ArchiMate_ApplicationComponent» Carrier Internal System	Post Booking Notifications()
Details: Type: Sequence Synchronous Call

Property	Value
_HideUmlLinks:	True
_defaultDiagramType:	ArchiMate3::Application
isFinalSpecialization:	0