DCSA Standards Public Reference / Standards / Releases / Booking / Archive / Booking v2.0.4
DCSA BKG 2.0.4 - Use Cases
Archived release: Booking v2.0.4 has been superseded. View the current v2 documentation.
Use cases describe how a system responds to a request or interacts with an actor. Each use case identifies the actors, purpose, preconditions, postconditions, and principal flow. Together with the User Stories, these use cases define the functional requirements of the Booking standard.
| Use case | Name | Actors |
|---|---|---|
| UC1 | Submit Booking request | Shipper to Carrier |
| UC2 | Request to update Booking request | Carrier to Shipper |
| UC3 | Submit updated Booking request | Shipper to Carrier |
| UC4 | Reject Booking request | Carrier to Shipper |
| UC5 | Confirm Booking request | Carrier to Shipper |
| UC6 | Request to amend confirmed Booking | Carrier to Shipper |
| UC7 | Request amendment to confirmed Booking | Shipper, Consignee, or Endorsee to Carrier |
| UC8 | Process amendment to confirmed Booking | Carrier to Shipper, Consignee, or Endorsee |
| UC9 | Cancel amendment to confirmed Booking | Shipper, Consignee, or Endorsee to Carrier |
| UC10 | Decline Booking by Carrier | Carrier to Shipper |
| UC11 | Cancel Booking request by Shipper | Shipper to Carrier |
| UC12 | Confirm Booking completed | Carrier to Shipper |
| UC13 | Cancel confirmed Booking by Shipper | Shipper to Carrier |
| UC14 | Process Booking cancellation | Carrier to Shipper |
Contents
- UC1: Submit Booking request
- UC2: Request to update Booking request
- UC3: Submit updated Booking request
- UC4: Reject Booking request
- UC5: Confirm Booking request
- UC6: Request to amend confirmed Booking
- UC7: Request amendment to confirmed Booking
- UC8: Process amendment to confirmed Booking
- UC9: Cancel amendment to confirmed Booking
- UC10: Decline Booking by Carrier
- UC11: Cancel Booking request by Shipper
- UC12: Confirm Booking completed
- UC13: Cancel confirmed Booking by Shipper
- UC14: Process Booking cancellation
UC1: Submit Booking request
Actors: Shipper to Carrier
Description: The Shipper submits a Booking request for a shipment.
Preconditions: The Shipper has sufficient information to submit a Booking request.
Postconditions: The Booking is in state RECEIVED.
Flow: The Shipper submits the Booking request. The Carrier performs initial synchronous processing and responds with the appropriate HTTP status code. After accepting the request, the Carrier sets the Booking state to RECEIVED and asynchronously notifies the relevant registered counterparts with the Carrier Booking Request Reference and Booking state.
UC2: Request to update Booking request
Actors: Carrier to Shipper
Description: The Carrier requests that the Shipper update the Booking request.
Preconditions: The Booking is in RECEIVED, PENDING_UPDATE when an earlier update request remains unanswered, or UPDATE_RECEIVED when another update is required.
Postconditions: The Booking is in state PENDING_UPDATE.
Flow: The Carrier requests an update, sets the Booking state to PENDING_UPDATE, and notifies the relevant registered counterparts. The notification contains the Carrier Booking Request Reference, Booking state, and reason for requesting the update.
UC3: Submit updated Booking request
Actors: Shipper to Carrier
Description: The Shipper submits an updated Booking request.
Preconditions: The Booking is in RECEIVED, PENDING_UPDATE, or UPDATE_RECEIVED when the Shipper submits another update.
Postconditions: The Booking is in state UPDATE_RECEIVED.
Flow: Whether or not the Carrier requested it, the Shipper submits an updated Booking request. The Carrier performs initial synchronous processing and responds with the appropriate HTTP status code. The Carrier sets the Booking state to UPDATE_RECEIVED. A new update replaces the content and state of a previous unprocessed update. The Carrier asynchronously notifies the relevant registered counterparts with the Carrier Booking Request Reference and Booking state.
UC4: Reject Booking request
Actors: Carrier to Shipper
Description: The Carrier rejects the Booking request received from the Shipper.
Preconditions: The Booking is in RECEIVED, PENDING_UPDATE, or UPDATE_RECEIVED.
Postconditions: The Booking is in state REJECTED.
Flow: The Carrier rejects the Booking request, sets its state to REJECTED, and notifies the relevant registered counterparts with the Carrier Booking Request Reference, Booking state, and reason for rejection.
UC5: Confirm Booking request
Actors: Carrier to Shipper
Description: The Carrier confirms the Booking request.
Preconditions: The Booking is in RECEIVED, UPDATE_RECEIVED, or CONFIRMED when the Carrier is updating its content.
Postconditions: The Booking is in state CONFIRMED.
Flow: The Carrier confirms the Booking request, sets its state to CONFIRMED, and notifies the relevant registered counterparts with the Carrier Booking Request Reference, Carrier Booking Reference, and Booking state.
UC6: Request to amend confirmed Booking
Actors: Carrier to Shipper
Description: The Carrier requests that the Shipper amend a confirmed Booking.
Preconditions: The Booking is in CONFIRMED or PENDING_AMENDMENT when the Carrier requests additional changes.
Postconditions: The Booking is in state PENDING_AMENDMENT.
Flow: The Carrier requests changes to the confirmed Booking, sets its state to PENDING_AMENDMENT, and notifies the relevant registered counterparts with the Carrier Booking Reference, Booking state, and reason for the amendment request.
UC7: Request amendment to confirmed Booking
Actors: Shipper, Consignee, or Endorsee to Carrier
Description: This use case supports amendments to a confirmed Booking, a Draft Transport Document, or an issued Transport Document.
Preconditions: The Booking is in CONFIRMED or PENDING_AMENDMENT. If a Transport Document exists, it is in DRAFT, ISSUED, or PENDING_SURRENDER_FOR_AMENDMENT.
Postconditions: The original Booking remains in its current state. The Booking amendment is in state AMENDMENT_RECEIVED. An existing Transport Document remains in its current state.
Flow: The Shipper requests an amendment to the confirmed Booking or Draft Transport Document, or the Shipper, Consignee, or Endorsee requests an amendment to an issued Transport Document. The Carrier performs initial synchronous processing and responds with the appropriate HTTP status code. The Carrier keeps the original Booking unchanged and creates an amended copy in state AMENDMENT_RECEIVED, then asynchronously notifies the relevant registered counterparts of the original and amended states.
Only one amendment can be active. After an amendment reaches AMENDMENT_RECEIVED, it must be processed through UC8, cancelled through UC9, superseded by a Carrier decline through UC10, or accompany a Booking cancellation request through UC13 before another amendment is submitted.
UC8: Process amendment to confirmed Booking
Actors: Carrier to Shipper, Consignee, or Endorsee
Description: The Carrier reviews the Booking amendment and decides whether it can be confirmed.
Preconditions: The original Booking is in CONFIRMED or PENDING_AMENDMENT, and the amendment is in AMENDMENT_RECEIVED. If a Transport Document exists, it is in DRAFT, ISSUED, or PENDING_SURRENDER_FOR_AMENDMENT.
Postconditions: If confirmed, the original Booking is CONFIRMED and the amendment is AMENDMENT_CONFIRMED. If declined, the original Booking retains its prior state and the amendment is AMENDMENT_DECLINED. An existing Transport Document retains its prior state.
Flow: To confirm, the Carrier permanently replaces the original Booking content with the amended content, updates the states, and notifies the relevant registered counterparts. To decline, the Carrier leaves the original Booking unchanged, sets the amendment to AMENDMENT_DECLINED, and sends a notification that includes the reason.
UC9: Cancel amendment to confirmed Booking
Actors: Shipper, Consignee, or Endorsee to Carrier
Description: This use case cancels an amendment to a confirmed Booking, Draft Transport Document, or issued Transport Document.
Preconditions: The original Booking is in CONFIRMED or PENDING_AMENDMENT, and the amendment is in AMENDMENT_RECEIVED. If a Transport Document exists, it is in DRAFT, ISSUED, or PENDING_SURRENDER_FOR_AMENDMENT.
Postconditions: The original Booking and any Transport Document retain their previous states. The amendment is in state AMENDMENT_CANCELLED.
Flow: The requesting party cancels the amendment. The Carrier performs initial synchronous processing, keeps the original Booking unchanged, sets the amendment to AMENDMENT_CANCELLED, and asynchronously notifies the relevant registered counterparts.
UC10: Decline Booking by Carrier
Actors: Carrier to Shipper
Description: The Carrier declines a Booking after confirmation.
Preconditions: The Booking is in CONFIRMED or PENDING_AMENDMENT. An amendment, if present, is in AMENDMENT_RECEIVED, AMENDMENT_CONFIRMED, AMENDMENT_DECLINED, or AMENDMENT_CANCELLED.
Postconditions: The Booking is in state DECLINED. An existing amendment is in state AMENDMENT_DECLINED.
Flow: The Carrier declines the Booking and any existing amendment, updates their states, and notifies the relevant registered counterparts with the Carrier Booking Reference, applicable states, and reason for declining the Booking.
UC11: Cancel Booking request by Shipper
Actors: Shipper to Carrier
Description: The Shipper cancels a Booking request before confirmation.
Preconditions: The Booking is in RECEIVED, PENDING_UPDATE, or UPDATE_RECEIVED.
Postconditions: The Booking is in state CANCELLED.
Flow: The Shipper requests cancellation. The Carrier performs initial synchronous processing and responds with the appropriate HTTP status code. The Carrier sets the Booking to CANCELLED and asynchronously notifies the relevant registered counterparts with the Carrier Booking Request Reference and Booking state.
UC12: Confirm Booking completed
Actors: Carrier to Shipper
Description: The Carrier confirms that the Booking is completed.
Preconditions: The Booking is CONFIRMED. The Transport Document is SURRENDERED_FOR_DELIVERY, or ISSUED for a Sea Waybill.
Postconditions: The Booking is in state COMPLETED.
Flow: After the named Consignee presents the Sea Waybill to take delivery, or after the Transport Document is surrendered for delivery, the Carrier sets the Booking to COMPLETED and notifies the relevant registered counterparts with the Carrier Booking Reference and Booking state.
UC13: Cancel confirmed Booking by Shipper
Actors: Shipper to Carrier
Description: The Shipper asks to cancel a previously confirmed Booking.
Preconditions: The Booking is in CONFIRMED or PENDING_AMENDMENT. An amendment, if present, is in AMENDMENT_RECEIVED, AMENDMENT_CONFIRMED, AMENDMENT_DECLINED, or AMENDMENT_CANCELLED.
Postconditions: The original Booking and any amendment retain their prior states. The Booking cancellation status is CANCELLATION_RECEIVED.
Flow: The Shipper requests cancellation. The Carrier performs initial synchronous processing and responds with the appropriate HTTP status code. The Carrier sets the cancellation status on the original Booking to CANCELLATION_RECEIVED and asynchronously notifies the relevant registered counterparts of the Booking, amendment, and cancellation states.
UC14: Process Booking cancellation
Actors: Carrier to Shipper
Description: The Carrier reviews a Booking cancellation request and decides whether it can be confirmed.
Preconditions: The Booking is in CONFIRMED or PENDING_AMENDMENT; the cancellation status is CANCELLATION_RECEIVED. An amendment, if present, is in AMENDMENT_RECEIVED, AMENDMENT_CONFIRMED, AMENDMENT_DECLINED, or AMENDMENT_CANCELLED.
Postconditions: If confirmed, the Booking is CANCELLED, the cancellation status is CANCELLATION_CONFIRMED, and any amendment is AMENDMENT_CANCELLED. If declined, the Booking and amendment retain their prior states and the cancellation status is CANCELLATION_DECLINED.
Flow: To confirm, the Carrier cancels the Booking and any amendment, updates the cancellation status, and notifies the relevant registered counterparts. To decline, the Carrier leaves the Booking and amendment unchanged, sets the cancellation status to CANCELLATION_DECLINED, and notifies the relevant registered counterparts.
