Project:
Issuance (Request) API : Public abstract <<ArchiMate_ApplicationInterface>> ApplicationInterface
Created:
10/14/2024 10:47:35 AM
Modified:
1/9/2025 4:29:09 PM
Author:
DCSA
Version:
2024.4
Author:
DCSA
Version:
2024.4
Phase:
1.0
Status:
Published
Complexity:
Easy
Difficulty:
Priority:
Multiplicity:
UUID:
{951D380C-B9E0-44b8-BB20-94F77988FEF3}
Appears In:
Issuance Request - Conceptual Model DRAFT, Issuance API - Conceptual Model DRAFT, Shipper Internal System DRAFT, eBL Solution Platform 1 DRAFT, eBL Solution Platform 2 DRAFT, 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
EBL (Implemented by provider)<br/><br/>It is possible to use the eBL API as a standalone API. In that case use one of the poll endPoints:<br/><br/>GET /v3/shipping-instructions/{documentReference} # For Shipping Instructions status<br/>GET /v3/transport-documents/{transportDocumentReference} # For Transport Document status<br/><br/>in order to poll information about status changes.<br/><br/>Note: All /v3/shipping-instructions and /v3/transport-documents endPoints must be implmented by the provider.<br/>
Operations
Associations To
Associations From
Messages To
Messages From
Advanced
Other Links
Operation
Public Put eBL Issuance Request () : void
Details:
Notes:
Submit a transport document (EBL) for issuance.<br/><br/><b>This endPoint is to be implemented by an EBL Solution Provider for the carrier to call.</b><br/>
[ Is static False. Is abstract False. Is return array False. Is query False. Is synchronized False. ]
Element
Source Role
Target Role
«ArchiMate_Contract» Transport document (TD)
Name:
Name:
Details:
«ArchiMate_BusinessActor» PARTY
Name:
Name:
Details:
«ArchiMate_BusinessObject» Issuance Manifest Signed Content
Name:
Name:
Details:
«ArchiMate_Contract» Supporting Document
Name:
Name:
Details:
Element
Source Role
Target Role
«ArchiMate_ApplicationComponent» Carrier Internal System
Name:
Name:
Details:
«ArchiMate_ApplicationComponent» Solution Provider System
Name:
Name:
Details:
«ArchiMate_ApplicationComponent» eBL Solution Platform
Name:
Name:
Details:
«ArchiMate_BusinessInteraction» Issuance API
Name:
Name:
Details:
Property
Value
_HideUmlLinks:
True
_defaultDiagramType:
ArchiMate3::Application
isFinalSpecialization:
0
Object
Type
Connection
Direction
Notes
Issuance (Request) eBL SP1
ApplicationInterface
Generalization
From
Issuance (Request) eBL SP3
ApplicationInterface
Generalization
From
Issuance (Request) eBL SP2
ApplicationInterface
Generalization
From
