Booking 2.0 Beta 2

Standard documentation

Standard Documentation Page | Booking 2.0 beta 2
Overview1. Introduction2. User stories3. Use cases4. Data overview5. Booking and Bill of Lading | State Transition Diagrams

3.1 Overview

In line with the techniques used in software development, 永利皇宫app下载注册已将用户故事和用例纳入标准开发过程，以支持航运业的数字化工作. 用户描述和用例都服务于捕获和记录需求的目的, but they differ in granularity, level of detail, 以及它们在开发过程中最重要的使用阶段. 它们是互补的(一个用户故事可能由一个或多个用例支持，反之亦然)，并且可以一起使用以提供对软件需求的全面理解. In this section we will focus on use cases.用例通常是对系统如何响应特定请求或与用户交互的描述，并且是一种以技术和非技术涉众都易于理解的方式捕获和定义功能需求的有价值的技术. 本标准中定义的用例包括以下组件:Actors: Actors are external entities, which could be users or other systems, interacting with the software. 他们发起用例，并且是系统为其提供价值的人.描述:总结用例目的的简短解释.先决条件:在执行用例之前需要完成的先决条件或必须完成的任务.后置条件:成功完成用例后系统的状态.Flow: The primary steps of the use case, 概述参与者和系统之间预期的交互顺序.异常流程描述了系统应如何处理意外或异常情况，请参见运营商异常处理部分.

Use cases

永利皇宫app下载注册定义了以下用例来支持预订请求, amendment, and confirmation process. 支持预订流程的用例的完整列表如下所示. 用户故事在专用的预订用户故事页面中定义.

1

Submit Booking request

Shipper to Carrier

2

Request to update Booking request

Carrier to Shipper

3

Submit updated Booking request

Shipper to Carrier

4

Reject Booking request

Carrier to Shipper

5

Confirm Booking request

Carrier to Shipper

6

Request to amend confirmed Booking

Carrier to Shipper

7

Request amendment to confirmed Booking

Shipper to Carrier

8

Process amendment to confirmed Booking

Carrier to Shipper

9

Cancel amendment to confirmed Booking

Shipper to Carrier

10

Decline Booking by Carrier

Carrier to Shipper

11

Cancel Booking by Shipper

Shipper to Carrier

12

Confirm Booking completed

Carrier to Shipper

3.1 General use case considerations

Lightweight notifications
In technical terms, API(应用程序编程接口)中的轻量级通知指的是一种消息传递模式，在这种模式中，API发送简明而集中的消息，通知客户机或订阅者有关特定事件或更改的信息. 这些通知在数据负载方面被设计得非常简单，通常只包含基本信息，如标识符或与事件相关的关键数据元素, 允许接收方了解上下文并采取适当的操作，而不需要大量的数据传输.轻量级通知已经跨基于永利皇宫app下载注册标准的api应用, 取代装运事件作为实时更新的推送机制. 所有各方都可以独立地、可选地订阅支持本标准中定义的预订过程的轻量级通知. If subscribed, the API consumer (e.g. 当订舱或订舱修改的状态或内容发生变化时，通知托运人, 消除了主动轮询GET端点以获取更新的需要. With the transition from polling to lightweight notifications, Carriers benefit from reduced load on their systems, 各方都受益于减少的网络流量和改进的业务流程延迟, facilitating efficient interaction between different systems.当运营商发送轻量级通知时，以下内容适用:承运商独立地将通知发送给已注册接收本标准用例API通知的每个相关对应方. 注册机制、生命周期和任何过滤都不在本标准的范围之内. The Carrier sends the lightweight notifications asynchronously, 在自己的系统中更新文档的状态和/或内容之后. If sending the lightweight notification fails, 不构成用例异常，且承运商不得恢复其自身系统中已执行的任何更改:相关对应方可能会被通知出通道，或在对同一文档的相同API调用后续GET请求时接收更新.
Carrier exception handling
如果承运商不能或不希望接受API请求(e.g. 当托运人要求取消已经在处理中的预订变更时), 它使用适当的错误消息和HTTP状态码进行响应. 承运人不得变更单证的状态或者内容, 并且它不会发送关于被拒绝的API请求的轻量级通知.

3.2 Use cases

下面用例的完整概述在永利皇宫app下载注册预订和BL状态转换图中进行了说明. 永利皇宫app下载注册 Booking 2中提供了与每个用例相关的数据属性的完整列表.0 Beta 2 Data overview.

State Diagram with all use cases

UC1: Submit booking request
Actors Shipper to CarrierDescription The Shipper submits the booking request for a shipment.Preconditions 托运人有足够的信息来提交预订请求.Postconditions The booking is in state RECEIVED.Flow
  • The Shipper submits the booking request.
  • Carrier以一个成功的HTTP状态码同步响应.
  • 承运商异步地向相关的已注册对应物发送轻量级通知，其中包含承运商预订请求引用和预订状态.
UC2: Request to update booking request
Actors: Carrier to ShipperDescription: 承运人要求托运人提交预订请求的更新.Preconditions:The Booking is in one of the following states:
  • RECEIVED
  • 待定更新(如果承运人已经要求托运人在未收到更新的情况下更新预订请求)
  • 收到的更新(如果承运人已经从托运人那里收到预订更新，但正在请求额外的更新)
Postconditions: The Booking is in state PENDING UPDATE.Flow
  • 承运商决定请求更新预订请求，并将其状态更新为PENDING update.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking request reference, 预订的状态，并说明请求更新的原因.
UC3: Submit updated Booking request
Actors: Shipper to CarrierDescription: The Shipper submits the updated Booking request.PreconditionsThe Booking is in one of the following states:
  • RECEIVED
  • 待定更新(如果承运人要求对预订请求进行更新)
  • 收到更新(如果发货人已经提交了更新的预订请求，但正在提交新的预订请求)
Postconditions: The Booking is in state UPDATE RECEIVED.Flow:
  • 无论承运人是否要求，托运人提交更新的订舱请求.
  • Carrier以一个成功的HTTP状态码同步响应.
  • 承运商异步地向相关的已注册对应物发送轻量级通知，其中包含承运商预订请求引用和预订状态.
UC4: Reject Booking request
Actors:Carrier to ShipperDescription: 承运人拒绝从托运人收到的订舱请求.Preconditions:The Booking is in one of the following states:
  • RECEIVED
  • PENDING UPDATE
  • UPDATE RECEIVED
Postconditions: The Booking is in state REJECTED.Flow:
  • 承运商决定拒绝预订请求并将其状态更新为已拒绝.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking request reference, 预订的状态，并注明拒收的理由.
UC5: Confirm Booking request
Actors: Carrier to ShipperDescription: The Carrier confirms the Booking request.PreconditionsThe Booking is in one of the following states:
  • RECEIVED
  • UPDATE RECEIVED
  • 已确认(如果承运商已经确认预订，但正在更新预订内容)
PostconditionsThe Booking is in state CONFIRMED.Flow
  • 承运商确认预订请求并将其状态更新为已确认.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking request reference, the Carrier Booking reference and the state of the Booking.
UC6: Request to amend confirmed Booking
Actors: Carrier to ShipperDescription: 承运人要求托运人对已确认的订舱提交修改.PreconditionsThe Booking is in one of the following states:
  • CONFIRMED
  • 待修改(如果承运人已经要求提交修改，但要求进行额外更改)
Postconditions: The Booking is in state PENDING AMENDMENT.Flow:
  • 承运商决定要求更改已确认的预订，并将其状态更新为PENDING AMENDMENT.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking reference, 预订的状态，并说明要求更改已确认的预订的原因.
UC7: Request amendment to confirmed Booking
Actors: Shipper to CarrierDescription: The Shipper requests an amendment to the confirmed Booking.PreconditionsThe Booking is in one of the following states:
  • CONFIRMED
  • 待修改(如果承运人要求提交修改)
  • 如运输单据(草拟本/)已签发，则该运输单据须属下列其中一种:
  • DRAFT
  • ISSUED
Postconditions:
  • 原始预订处于与先决条件相同的状态.
  • The Booking amendment is in state AMENDMENT RECEIVED.
  • If a (Draft/) Transport Document has already been issued, it is in the same state as in the preconditions.
Flow:
  • 无论承运人是否要求，托运人都要求对已确认的订舱进行修改.
  • 承运人保持原始预订不变(包括其状态)，并根据托运人的要求创建一份预订副本, setting its state to AMENDMENT RECEIVED.
  • Carrier以一个成功的HTTP状态码同步响应.
  • 承运商异步地向包含承运商预订引用的相关已注册对应物发送轻量级通知, the state of the original Booking and of the Booking amendment.
UC8: Process amendment to confirmed Booking
Actors: Carrier to ShipperDescription: 承运商审查预订修改，并决定是否可以确认提议的更改.Preconditions: The original Booking is in one of the following states:
  • CONFIRMED
  • 待修改(如果承运人要求提交修改)
  • The Booking amendment is in state AMENDMENT RECEIVED.
Postconditions:There are two possible scenarios:If the amendment is confirmed:
  • The original Booking is in state CONFIRMED.
  • The Booking amendment is in state AMENDMENT CONFIRMED.
If the amendment is declined:
  • 原始预订处于与先决条件相同的状态.
  • The Booking amendment is in state AMENDMENT DECLINED.
Flow:承运商对修改已确认预订的请求执行初始同步处理. Whether or not the Carrier will accept the proposed changes, 承运商可以按照承运商异常处理一节中描述的异常流程接受或拒绝请求.There are two possible scenarios:Confirm
  • 承运人确认所要求的预订修改，并将其完全永久地替换为原始预订.
  • 承运人将原始预订状态更新为已确认，将预订修改状态更新为已确认的修改.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking reference, the state of the original Booking and of the Booking amendment.
Decline
  • 承运人拒绝请求的预订修改，并将其状态更新为“已拒绝修改”. 原始的Booking保持其状态和内容不变.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking reference, the state of the original Booking and of the Booking amendment, indicating the reason for declining the amendment.
UC9: Cancel amendment to confirmed Booking
Actors: Shipper to CarrierDescription: The Shipper cancels the amendment to the confirmed Booking.Preconditions:The original Booking is in one of the following states:
  • CONFIRMED
  • 待修改(如果承运人要求托运人提交修改)
  • The Booking amendment is in state AMENDMENT RECEIVED.
Postconditions:
  • 原始预订处于与先决条件相同的状态.
  • The Booking amendment is in state AMENDMENT CANCELLED.
Flow:
  • The Shipper cancels the amendment to the confirmed Booking.
  • 承运商对取消预订修改的请求执行初始同步处理. 承运商可以按照承运商异常处理一节中描述的异常流程接受或拒绝请求.
  • 承运商保持原始预订不变(包括其状态)，并取消预订修改, setting its state to AMENDMENT CANCELLED.
  • Carrier以一个成功的HTTP状态码同步响应.
  • 承运商异步地向包含承运商预订引用的相关已注册对应物发送轻量级通知, the state of the original Booking and of the Booking amendment.
UC10: Decline Booking by Carrier
Actors: Carrier to ShipperDescription: The Carrier declines the Booking after it was confirmed.Preconditions:The Booking is in one of the following states:
  • CONFIRMED
  • PENDING AMENDMENT
如果存在预订修改，则它处于以下状态之一:
  • AMENDMENT RECEIVED
  • AMENDMENT CONFIRMED
  • AMENDMENT DECLINED
  • AMENDMENT CANCELLED
Postconditions:
  • The Booking is in state DECLINED.
  • 如果存在预订修改，则处于“已拒绝修改”状态.
Flow:
  • 承运商决定拒绝预订并将其状态更新为已拒绝. If a Booking amendment exists, 它与原始预订一起被拒绝，承运人将其状态更新为“已拒绝修改”.
  • 承运商向相关的注册对应物发送轻量级通知, containing the Carrier Booking reference, the state of the Booking and of the Booking amendment, when applicable, indicating the reason for declining it.
UC11: Cancel Booking by Shipper
Actors: Shipper to CarrierDescription: The Shipper cancels the Booking.Preconditions:The Booking is in one of the following states:
  • RECEIVED
  • PENDING UPDATE
  • UPDATE RECEIVED
  • CONFIRMED
  • PENDING AMENDMENT
如果存在预订修改，则它处于以下状态之一:
  • AMENDMENT RECEIVED
  • AMENDMENT CONFIRMED
  • AMENDMENT DECLINED
  • AMENDMENT CANCELLED
Postconditions:
  • The Booking is in state CANCELLED.
  • 如果存在预订修改，则其状态为“修改取消”.
Flow:
  • The Shipper cancels the Booking. 如果存在预订更改，则该预订将与原始预订一起被取消.
  • 承运商对取消预订的请求执行初始同步处理. 承运商可以按照承运商异常处理一节中描述的异常流程接受或拒绝请求.
  • Carrier以一个成功的HTTP状态码同步响应.
  • 承运商异步地向相关的已注册对应方发送轻量级通知，其中包含承运商预订请求引用和/或承运商预订引用, the state of the Booking and of the Booking amendment, when applicable.

UC12: Confirm Booking completed
Actors: Carrier to ShipperDescription: 承运人确认在交付运输单据后订舱完成.Preconditions:
  • The Booking is in state CONFIRMED.
  • The Transport Document is in state SURRENDERED FOR DELIVERY.
Postconditions: The Booking is in state COMPLETED.Flow
  • 承运人确认预订已完成，并将其状态更新为“已完成”.
  • 承运商向相关的注册对应物发送轻量级通知, 包含承运人预订参考和预订状态.

Standard documentation chapters

Introduction
User stories
Data overview