The correlation token is used within the SubmitCruiseTransaction. The correlation token identifies transactions within the cruise system. Some requests require a cruise correlation token. Some responses return a correlation token. If a cruise transaction returns a correlation token, that token should be used in the next request. If no correlation token is returned, then no correlation token is required in the next request. Correlation tokens should not be cached or retained.
In the request, if a correlation token is not required, the <CorrelationToken> element should be empty.
|
Cruise Transaction |
Correlation Token Required in Request? |
Correlation Token Returned in Response? |
|
No |
No | |
|
No |
No | |
|
No |
No | |
|
No |
*Yes, returns a new token | |
|
Yes |
No | |
|
No |
No | |
|
No |
No | |
|
Yes |
Yes | |
|
No |
No | |
|
No |
No | |
|
Yes |
Yes | |
|
No |
No | |
|
Yes |
Yes | |
|
No |
No | |
|
Yes |
Yes |
*If the CruiseCabinHold request fails, meaning that a <TransactionErrorCode> element is returned as the first child element, no correlation token is returned.
The following diagram explains the order in which transactions occur: