RatingType 

Usage: Rating information is used in, different cases, such as rating
for an accomodation or a card for instance. * For accomodations, it is used to express a
three star hotel for instance or a 2 epis for lodgings by Gîte de France * For Cards, it
can be used for levels such as Ivory, Silver and Titanium ofr the Air France Card * In
general it can be used to express a level of appreciation (such as for traveller
evaluation grids. A value can be used alone or in relation with a unit and possibly the
organism having provided the rating. It is also possible to use a more generic quantity
with a scale from 0 to 5). Description: Rating may correspond to a value or a
description. Rating information is currently free text, even for values and units
because there are many different scales for values and units. Derived Ratings could be
used to specifiy for certain types of ratings, for instance for certain organisations
for hotle accomodaitons or lodgings. Value is a string and corresponds to a numeric or
textual value. To have a true numeric value that can be used in search engines, the
Quantity should rather be used . For instance, a 3 star hotel should have @Quantity=3
(with @Value also = 3), a 3 star deluxe hotel could have either @Quantity=3, @Quantity=
4 or even @Quantity=3.5 and @Value=3

Complex Type Information

Model

ANY element from ANY namespace OTHER than 'http://www.exchangefortravel.org/xft/current' , (Style | Styles) , ResponseStyle{0,1} , (Date | Dates) , (Active | Actives) , (Code | Codes) , (Type | Types) , (Keyword | Keywords) , NameText{0,1} , (CustomField | CustomFields) , Extension , (Description | Descriptions) , (Price | Prices) , (Entity | Entities) , (Task | Tasks) , (History | Histories) , (Rating | Ratings{0,1})
Children: Active, Actives, Code, Codes, CustomField, CustomFields, Date, Dates, Description, Descriptions, Entities, Entity, Extension, Histories, History, Keyword, Keywords, NameText, Price, Prices, Rating, Ratings, ResponseStyle, Style, Styles, Task, Tasks, Type, Types

Attributes

QName Type Fixed Default Use Inheritable Annotation
Apply ApplyType optional 
**************************************- This is used to qualify
whether elements can apply in certain circumstances (Restrictions Apply, VTA
apply ...) or to know how something should apply (Excursion apply but is
optional, Taxes apply and are mandatory, Surcharge apply but only if a condition
is true... The roles can therefore either be a Boolean (Apply/do not Apply) or
qualified by one of the Apply Codes. **************************************-
**> True: the element applies, without any other detail. In some cases, true
and Optional could be used in the same way. If no information on how an Add-on
applies (true) it should be considered as Optional. This use of true should be
avoided. **> False: the element does not apply **> Conditional: a Rule is
attached to the elements with Me.Apply='Conditional'. In that case, if the rule
is validated, the element should apply (add the price, use the segment ...)
otherwise, it does not. **> Included: The element is already included in the
main element (included in price, duration ...) **> Mandatory: The element
must be used, but is not included in the parent element (price must be added,
duration may be added ...) **> Optional: The element can be used. Usually
Add-ons are provided as a list of optional segments. Fees could be listed in the
same way, Included, Mandatory, Optional or Conditional. Can be used both in
requests and responses **************************************-
 
**************************************- Maintenance:
DF/2003-11-13: Comment copied from type definition
**************************************-
As AsCodeType optional 
This attribute is used to express the fact that the
associated element is either en envelope or an item. If omitted, the element is
considered an item (default behaviour). *An item contains the information
directly in itself. *An envelope would group items of the same nature, but the
informaton would in fact be in the child items.
Category RatingCategoryCodeType optional
Debug xs:string optional 
This attribute is used to hold any information that would be relevant for debug purposes
It should not be present in regular exchanges, except when debug flags are positioned.
Default DefaultType optional 
If specified, this value corresponds to the default/optimum number
of units (default number of passengers in a Vehicle, default occupancy in a
room, ...)
DeliveredBy RatingDeliveredByType optional
Encrypted xs:string optional 
To store the name value, but encrypted in a format and alogrithm
to be known by both extremities
EncryptionKey EncryptionKeyCodeType optional
Extremity ExtremityCodeType optional 
**************************************- When a range is provided
with a Min - Max, boundaries may or may not be included in the range. How
extremities should be handled is provided here:
**************************************- **> None: ]Min,Max[ **> Left:
]Min,Max] **> Right: [Min,Max[ **> Both: [Min,Max] Default or omitted =
Both **************************************-
 
**************************************- Maintenance:
DF/2003-11-13: Comment copied from type definition
**************************************-
Filter FilterCodeType optional 
**************************************-
***************************************** In a request :
***************************************** used in conjunction with Match. **>
If Match is omitted, or Match=false and Filter is used, Filter does not need to
be enforced, but MAY be and is rather considered as a preference. The Match
attribute in the response may indicate whether the filter has been applied or
not. **> if Match=true, the Filter and the Rules MUST be applied
*****************************************
***************************************** In a response :
***************************************** The associated information corresponds
to data that should (Include) or should not (Exclude) be used (flight number
restrictions, black out dates, ...) **> Omitted : Filter=Include
*****************************************
**************************************-
 
**************************************- Maintenance:
DF/2003-11-13: Comment copied from type definition
**************************************-
Group xs:string optional 
This is non validated free text. ==>Composite Data : Used in
conjunction with Indexes to create composite Ids. ==>Naming groups of data :
Used to name groups of individual data such as to group the differnt memebers of
a family, different sub-trips within a trip,...
Guaranteed GuaranteedCodeType optional 
§Description: This attribute can be used to define that the corresponding parent element is Guaranteed. It may hold three values:
* true (xs:boolean)
* false (xs:boolean)
* Unknown (xft:UnknownCodeType, therefore the uppercase)

§Usage: Up to now, the usage correpsonds to  th epossibility to express taht a given departure is guaranteed for a given date.
If Guaranteed is false, it may be associated to a guarantee rule that explains how the guarantee may be optianed (like a minimum number of persons.
A guaranteed that is not provided does not correspond to a false value, but to an Unknown value.
ID xs:ID optional 
A unique ID within an XML file. That ID can exist outside the xml
file or not.
Implementation xs:string optional 
The version for the server application. This version is different
from the XFT versin (@Version). The same XFT version may be used in different
implementations.
Index xs:nonNegativeInteger optional 
==>Composite Data : to order the data with the group. In that
case, Group should be used to actual define the group, except if all the items
are used to define the group. ==>A list of items : Index is used to order
them.
Key optional 
Contains a technical identifier (like a database primary key, a GUID
...) by opposition to a business oriented value, like a booking reference or a
product code, which are in @Value.
Local xs:boolean optional
Match xs:boolean optional 
***************************************** In a request :
***************************************** **> true : response MUST match
input parameters exactly. Otherwise it should not be present. **> false :
response MAY match input parameters. **> omitted : Accuracy is left at the
disposal of the hosts. Match criteria can be further defined through limits and
rules. *****************************************
***************************************** In a response :
***************************************** **> true : response matches input
parameters exactly. true can be present in a response whatever the value in the
request. **> false : response does not match input parameters. false can only
be present if Match was false or omitted in the request. **> omitted:no
information is provided by host *****************************************
Max QuantityCodeType optional 
Maximum number of units .
Min QuantityCodeType optional 
Minimum number of units associated with the
quantity
Name xs:string optional 
A value for the associated entity, usually more technically
oriented. Free text should be in a CDATA section
Override OverrideType optional
Parent ReferenceType optional 
A reference to a parent object in case of hierarchical trees. This
is used to create complex tree like hierarchies
Preferred xs:boolean optional 
**************************************-
***************************************** In a request :
***************************************** mentions that the associated element
is the preferred choice. This can also be achieved through the Index
attribute.*****************************************
***************************************** In a response :
***************************************** information only : preferred choice
has been returned. This is for easier parsing purposes
*****************************************
**************************************-
 
**************************************- Maintenance:
DF/2003-11-13: Comment copied from type definition
**************************************-
Quantity QuantityCodeType optional 
Request: the requested quantity Response: the actual quantity
associated with the component This value can be used in complement with the
other attributes to provided additional information (min, max, preference,
...)
Rank RankCodeType optional 
To define a position within a list without providing the extact
value. Currently it can be Left, Right or Mean. For a value, use the @Index
instead.
Ref ReferenceType optional 
A reference to a valid ID within an XML file. External links are
not supported. Usually the referenced object is of the same type or the type is
obvious within the context. If several references are required, other attributed
with Ref suffix will be present. xxxcould investigate xLinks
Status StatusCodeType optional 
**>A = Available **>C = Confirm / Confirmed **>N = Not
applicable / no action **> O = Option **> R = Request **> U = Unable to
confirm **> W = Waitlist **> X = Closed If there is a quantity, Status can
be omitted. If Quantity is positive Status = A If Quantity is negative or null
Status = X
Step xs:decimal optional
Unit RatingUnitCodeType optional
Value xs:string optional
Version xs:string optional 
EN: = Usage = This version attribute corresponds to
the version of the associated element. * For a transaction element, it
corresponds to the xft version that can be used to validate the schema. This
field being free text, it can contain either minor or major versions. Actual
schema reference can be passed in the xml stream directly to help validation.
However, the XFT schema can always be validated against the current version
available on the http://www.ExchangeForTravel.org site * When present on other
elements, it corresponds to the version of the associated element, in case the
system allows saving succesive versions. As a consequence, a version associated
to a booking would correspond to the booking version (and may even be used to
retrieve a previous version if the host allows it. = Description = This
attribute contains free text but should be a valid version (usual format is
%number%.%Number[.%Number%] but versions of different types may be used by
different service providers. = Warning = @Version vs @Implementation: * @Version
is the version of the element itself * @Implementation is the version of the
implementation of the program on the host, used to provide the
service.
XPath xs:string optional
Wildcard: ANY attribute from namespace(s) 'http://www.w3.org/XML/1998/namespace http://www.afidium.com/dx http://www.afidium.com/namespaces/test'

Used By

Element Rating

Source 

<xs:complexType name="RatingType" mixed="true">
  <xs:annotation>
    <xs:documentation>Usage: Rating information is used in, different cases, such as rating for an accomodation or a card for instance. * For accomodations, it is used to express a three star hotel for instance or a 2 epis for lodgings by Gîte de France * For Cards, it can be used for levels such as Ivory, Silver and Titanium ofr the Air France Card * In general it can be used to express a level of appreciation (such as for traveller evaluation grids. A value can be used alone or in relation with a unit and possibly the organism having provided the rating. It is also possible to use a more generic quantity with a scale from 0 to 5). Description: Rating may correspond to a value or a description. Rating information is currently free text, even for values and units because there are many different scales for values and units. Derived Ratings could be used to specifiy for certain types of ratings, for instance for certain organisations for hotle accomodaitons or lodgings. Value is a string and corresponds to a numeric or textual value. To have a true numeric value that can be used in search engines, the Quantity should rather be used . For instance, a 3 star hotel should have @Quantity=3 (with @Value also = 3), a 3 star deluxe hotel could have either @Quantity=3, @Quantity= 4 or even @Quantity=3.5 and @Value=3</xs:documentation>
  </xs:annotation>
  <xs:complexContent mixed="true">
    <xs:extension base="EntityQualifiedType">
      <xs:sequence minOccurs="0">
        <xs:group ref="RatingGroup" minOccurs="0"/>
      </xs:sequence>
      <xs:attribute name="Local" type="xs:boolean" use="optional"/>
      <xs:attribute name="Value" type="xs:string" use="optional"/>
      <xs:attribute name="DeliveredBy" type="RatingDeliveredByType" use="optional"/>
      <xs:attribute name="Unit" type="RatingUnitCodeType" use="optional"/>
      <xs:attribute name="Category" type="RatingCategoryCodeType" use="optional"/>
    </xs:extension>
  </xs:complexContent>
</xs:complexType>