-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #653 from UnionInternationalCheminsdeFer/528-split…
…-model-page #528 Separate model and state model pages
- Loading branch information
Showing
3 changed files
with
52 additions
and
45 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
layout: page | ||
title: State Models | ||
hide_hero: true | ||
permalink: /spec/state-models/ | ||
--- | ||
|
||
## State Models <a name="stateModels"> | ||
|
||
### Trip State Model | ||
|
||
The state `PLANNED` is relevant for trips on touristic trains or if trains only | ||
run if a certain amount of bookings have been made. If the the trip is | ||
confirmed, the purchaser can be informed using the webhook API. | ||
|
||
![Trip State Model](../images/models/trip-state-model.png) | ||
|
||
### Booking State Model | ||
|
||
The status applies to the booking parts, no booking state exists. | ||
|
||
### Booking Part State Model | ||
|
||
![Booking State Model](../images/models/booking-state-model.png) | ||
|
||
### Fulfillment State Model | ||
|
||
![Fulfillment State Model](../images/models/fulfillment-state-model.png) | ||
|
||
### Fulfillment State Model with Activation | ||
|
||
In case of multi-journey products, a fulfillment needs to be activated before, | ||
thus it changes from `AVAILABLE` to `FULFILLED`. | ||
|
||
![Fulfillment State Model](../images/models/fulfillment-state-model-with-activation.png) | ||
|
||
### Refund State Model | ||
|
||
![Refund State Data Model](../images/models/refund-state-model.png) | ||
|
||
### Exchange State Model | ||
|
||
Values are a subset of the booking status values (see before). | ||
![Exchange State Data Model](../images/models/exchangeOperation-state-model.png) | ||
|
||
### Complaint State Model | ||
|
||
![Complaint State Model](../images/models/complaint-state-model.png) |