Freitagm: small change

2019-10-16T10:45:46Z

small change

Freitagm: first definition

2019-10-16T10:44:26Z

first definition

Neue Seite

== Overview ==
Cruise services extend the CommonService to carry cruise specific information.
The main element holds basic service information to give a brief overview about the main characteristics which are fully inherited by the CommonService Element. Cruise specific information are held using a List of categories elements and a list of transfer elements.

Available attributes slightly differ for the given direction of the message (Request/Response).

=== Request element ===
<syntaxhighlight lang="xml">
<Service>
<Details xsi:type="CruiseRequestType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...

<Categories>
<CruiseCategory>
<Identifier>01</Identifier>
<AssignedTraveller>
<Identifier>01</Identifier>
<Identifier>02</Identifier>
</AssignedTraveller>
<CruiseCategoryCode>
<Code>INAW2V</Code>
</CruiseCategoryCode>
<CustomerRequests>
<Description>
<Text>Veganes Essen</Text>
</Description>
</CustomerRequests>
<CabinDetails>
<CabinDetail>
<AssignedTraveller>
<Identifier>01</Identifier>
<Identifier>02</Identifier>
</AssignedTraveller>
<Cabin>
<Number>10058</Number>
</Cabin>
</CabinDetail>
</CabinDetails>
</CruiseCategory>
</Categories>
</Details>
</Service>
</syntaxhighlight>

=== Response Element ===
The Response on the other hand is meant to represent the view of the TourOperator on the request. The Response also carries more specific information about the requested cruise service like detailed route information.

<syntaxhighlight lang="xml">
<Service>
<Details xsi:type="CruiseResponseType" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...

<Categories>
<CruiseCategory>
<Identifier>01</Identifier>
<AssignedTraveller>
<Identifier>01</Identifier>
<Identifier>02</Identifier>
</AssignedTraveller>
<CruiseCategoryCode>
<Code>INAW2V</Code>
<Description>
<Text>Innenkabine Kategorie A</Text>
</Description>
</CruiseCategoryCode>
<CabinDetails>
<CabinDetail>
<Identifier>10058</Identifier>
<AssignedTraveller>
<Identifier>01</Identifier>
<Identifier>02</Identifier>
</AssignedTraveller>
<Attributes>
<Attribute>
<Code>2 Betten, zusammen oder trennbar</Code>
<AttributeSource>Touroperator</AttributeSource>
</Attribute>
<Attribute>
<Code>Bereich 4</Code>
<AttributeSource>Touroperator</AttributeSource>
</Attribute>
<Attribute>
<Code>Bett quer zur Fahrtrichtung</Code>
<AttributeSource>Touroperator</AttributeSource>
</Attribute>
</Attributes>
<Cabin>
<Number>10058</Number>
<Deck>Deck 10 - Perle</Deck>
</Cabin>
</CabinDetail>
</CabinDetails>
<State>OK</State>
</CruiseCategory>
</Categories>
<RouteDetails>
<RouteDetail>
<Date>2020-01-31</Date>
<ArrivalTime>T07:00Z</ArrivalTime>
<DepartureTime>T22:00Z</DepartureTime>
<Harbour>
<LanguageCode>DE</LanguageCode>
<Text>La Romana</Text>
</Harbour>
</RouteDetail>
<RouteDetail>
<Date>2020-02-01</Date>
<Harbour>
<LanguageCode>DE</LanguageCode>
<Text>Seetag</Text>
</Harbour>
</RouteDetail>
<RouteDetail>
<Date>2020-02-02</Date>
<ArrivalTime>T07:30Z</ArrivalTime>
<DepartureTime>T19:00Z</DepartureTime>
<Harbour>
<LanguageCode>DE</LanguageCode>
<Text>Fort-de-France</Text>
</Harbour>
</RouteDetail>
</RouteDetails>
</Details>
</Service>
</syntaxhighlight>

=== Room Element ===
A CruiseCategory-Element, as the name suggests, represents a guarantee or real category on theacruise facility. Each category has an (optional) List of assigned travellers, which can be used to directly assign the travellers to a specific category.

It is represented by a CruiseCategoryCode Element holding code and description of the category. Specific attributes of the category (like facilities). In addition to that, it holds the selected cabins and a List of included extra services, all represented by a code and a description.
Whereas the code in these elements is intended to be used mainly in a technical manner and the description to be used for presentation, the description is an optional element. If not set, the code has to be used to describe category or included extras.
<syntaxhighlight lang="xml">
<CruiseCategory>
<Identifier>01</Identifier>
<AssignedTraveller>
<Identifier>01</Identifier>
<Identifier>02</Identifier>
</AssignedTraveller>
<CruiseCategoryCode>
<Code>DS</Code>
<Description>
<LanguageCode>DE</LanguageCode>
<Text>Innenkabine Kategorie A</Text>
</Description>
</CruiseCategoryCode>
<Attributes>
<Attribute>
<Code>SAFE</Code>
<Description>Safe</Description>
<AttributeSource>Touroperator</AttributeSource>
</Attribute>
<Attribute>
<Code>DESK</Code>
<Description>Schreibtisch</Description>
<AttributeSource>Touroperator</AttributeSource>
</Attribute>
</Attributes>
<IncludedExtras>
<IncludedExtra>
<ExtraCode>
<Code>WIFI</Code>
<Description>Kostenfreies WLAN/Description>
</ExtraCode>
</IncludedExtra>
</IncludedExtras>
<State>OK</State>
</CruiseCategory>
</syntaxhighlight>

==== Available CruiseCategory-Element attributes ====

{| class="wikitable sortable"
|-
! Attribute!! Values / Explanation
|-
| '''@Identifier'''|| This is a unique identifier within one message, which can be used to reference on a concrete category
|-
| '''AssignedTraveller'''|| A list of traveller Ids, representing the traveller assigned to this specific category
|-
| '''CruiseCategoryCode'''|| The category code identifying this specific class of cruise. Can be enriched by textual desriptions of the room.
|-
| '''CruiseCategoryCode/Attributes'''|| A list of special attributes of the category structured in <br>a @Code, <br>a @Description (for display purposes) and <br>the @AttributeSource indicating the source/type of that attribute code
|-
| '''CustomerRequests''' (Request only)|| A List of texts holding customer specific request information
|-
| '''IncludedExtras'''|| A List of extras included for that category
|}

@@ Zeile 128: / Zeile 128: @@
 </syntaxhighlight>
-=== Room Element ===
+=== CruiseCategory Element ===
 A CruiseCategory-Element, as the name suggests, represents a guarantee or real category on theacruise facility. Each category has an (optional) List of assigned travellers, which can be used to directly assign the travellers to a specific category.
@@ Zeile 181: / Zeile 181: @@
 | '''AssignedTraveller'''|| A list of traveller Ids, representing the traveller assigned to this specific category
 |-
-| '''CruiseCategoryCode'''|| The category code identifying this specific class of cruise. Can be enriched by textual desriptions of the room.
+| '''CruiseCategoryCode'''|| The category code identifying this specific class of cruise. Can be enriched by textual desriptions of the category.
 |-
 | '''CruiseCategoryCode/Attributes'''|| A list of special attributes of the category structured in <br>a @Code, <br>a @Description (for display purposes) and <br>the @AttributeSource indicating the source/type of that attribute code

Cruise - Versionsgeschichte

Freitagm: small change

Freitagm: first definition