README
¶
DCSA API's
Booking API
- Booking request
- Booking update
- Booking confirmation
- Booking amendment
- Booking cancellation
- Booking rejection
Use Cases
-
Submit Booking request
Shipper to Carrier -
Request to update Booking request
Carrier to Shipper -
Submit updated Booking request
Shipper to Carrier -
Reject Booking request
Carrier to Shipper -
Confirm Booking request
Carrier to Shipper -
Request to amend confirmed Booking
Carrier to Shipper -
Request amendment to confirmed Booking
Shipper, Consignee or Endorsee to Carrier -
Process amendment to confirmed Booking
Carrier to Shipper, Consignee or Endorsee -
Cancel amendment to confirmed Booking
Shipper, Consignee or Endorsee to Carrier -
Decline Booking by Carrier
Carrier to Shipper -
Cancel Booking request by Shipper
Shipper to Carrier -
Confirm Booking completed
Carrier to Shipper -
Cancel confirmed Booking by Shipper
Shipper to Carrier -
Process Booking cancellation
Carrier to Shipper
Resources
- DCSA BKG API: https://app.swaggerhub.com/apis/dcsaorg/DCSA_BKG/2.0.2
- DCSA BKG API Docs: https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_BKG/2.0.2
EBL (Electronic Bill of Lading/Transport Document) API
- Shipping Instructions submission
- Shipping Instructions update
- Draft Transport Document publication
- Draft Transport Document update
- Draft Transport Document approval
Use Cases
-
Submit Shipping Instructions
Shipper to Carrier -
Request to update Shipping Instructions
Carrier to Shipper -
Submit updated Shipping Instructions
Shipper, Consignee or Endorsee to Carrier -
Process updated Shipping Instructions
Carrier to Shipper, Consignee or Endorsee -
Cancel update to Shipping Instructions
Shipper, Consignee or Endorsee to Carrier -
Publish Draft Transport Document
Carrier to Shipper -
Approve Draft Transport Document
Shipper to Carrier -
Issue Transport Document
Carrier to Shipper -
Request surrender Transport Document (amendment)
Shipper, Consignee or Endorsee to Carrier -
Process Transport Document surrender request (amendment)
Carrier to Shipper, Consignee or Endorsee -
Void original Transport Document and issue amended Transport Document
Carrier to Shipper, Consignee or Endorsee -
Request surrender Transport Document (delivery)
Shipper, Consignee or Endorsee to Carrier -
Process Transport Document surrender request (delivery)
Carrier to Shipper, Consignee or Endorsee -
Confirm Shipping Instructions completed
Resources
- DCSA EBL API: https://app.swaggerhub.com/apis/dcsaorg/DCSA_EBL/3.0.1
- DCSA EBL API Docs: https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_EBL/3.0.1
Track and Trace API
- ShipmentEvents
- TransportEvents
- EquipmentEvents
Resources
- DCSA TNT API: https://app.swaggerhub.com/apis/dcsaorg/DCSA_TNT/3.0.0-Beta-2
- DCSA TNT API Docs: https://app.swaggerhub.com/apis-docs/dcsaorg/DCSA_TNT/3.0.0-Beta-2
Directories
¶
| Path | Synopsis |
|---|---|
|
backend
command
|
|
|
bkg/bkgserver
command
|
|
|
bkg/bkgworker
command
|
|
|
ebl/eblserver
command
|
|
|
ebl/eblworker
command
|
|
|
eventcore/eventcoreserver
command
|
|
|
jit/jitserver
command
|
|
|
jit/jitworker
command
|
|
|
ovs/ovsserver
command
|
|
|
ovs/ovsworker
command
|
|
|
party/partyserver
command
|
|
|
tnt/tntserver
command
|
|
|
tnt/tntworker
command
|
|
|
user/userserver
command
|
|
|
internal
|
|
|
controllers/eblcontrollers
https://github.com/dcsaorg/DCSA-EBL/blob/master/src/main/java/org/dcsa/ebl/controller/TransportDocumentSummariesController.java
|
https://github.com/dcsaorg/DCSA-EBL/blob/master/src/main/java/org/dcsa/ebl/controller/TransportDocumentSummariesController.java |
|
services/bkgservices
https://github.com/dcsaorg/DCSA-Edocumentation/blob/master/edocumentation-service/src/main/java/org/dcsa/edocumentation/service/BookingService.java https://github.com/dcsaorg/DCSA-BKG/blob/master/src/test/java/org/dcsa/bkg/service/impl/BKGServiceImplTest.java
|
https://github.com/dcsaorg/DCSA-Edocumentation/blob/master/edocumentation-service/src/main/java/org/dcsa/edocumentation/service/BookingService.java https://github.com/dcsaorg/DCSA-BKG/blob/master/src/test/java/org/dcsa/bkg/service/impl/BKGServiceImplTest.java |
|
roles
command
|