2.2. RAIL SCHEDULE SEARCH RESPONSE

Success

For more information see Common Data Description section in Glossary.

Warnings

Errors

OriginDestinationInformation

Contains information about available trains or information about available stations (it's possible to get stations list in case when for one station name can be several stations, but with different codes).

0..99

OriginLocation

Contains information about available for passenger departure stations with the same name.

0..99

LocationCode

string

For more information see Common Data Description section in Glossary.

0..1

LocationName

string

0..1

LocationType*

1..1

CodeContext*

1..1

NetworkShortName

string (1-32)

Contains name of railway.

0..1

DestinationLocation

Contains information about available for passenger arrival stations with the same name. Attributes are the same as in OriginLocation element above.

0..99

AllowedDocumentTypes

Contains collection of document types for reservation.

0..3

PaxGroupCode

string (“ADT”, “CHD”, ”INF”)

Specifies pax type.

0..1

AllowedDocumentTypes/AllowedDocumentType*

Document type for reservation.

1..99

Code

string (1-16)

Code of the document type.

0..1

CodeContext

string (1-32)

Specifies the context of the Code.

0..1

PrefNameLanguage

string

Specifies preferred language of FIO on reservation.

0..1

AllowedNameLanguages

string

specifies allowed languages of FIO on reservation.

0..1

NeedMiddleName

boolean

Indicates if Middle Name is required to set on reservation.

0..1

AllowedDocumentTypes/AllowedDocumentType/Description

A short description of the document type.

0..1

Language

For more information see Common Data Description section in Glossary.

0..1

OriginDestinationOption

Information about train option with specified origin-destination pair.

0..999

OriginLocation

Specifies train origin location. The departure point of the train. в гайде мандатори

0..1

LocationCode

string

Contains code of location.

0..1

LocationName

string

Mandatory attribute in case no LocationCode, optional in other case; name of location.

0..1

LocationType*

For more information see Common Data Description section in Glossary.

CodeContext*

DestinationLocation

Specifies train destination location. The arrival point of the train. Attributes are the same as in OriginLocation element above.

0..1

JourneySegment*

Specifies information about requested journey.

1..1

JourneySegment/TrainSegment

Specifies information about the train.

0..1

DepartureDateTime*

DateTime (YYYY-MM-DDThh:mm:ss)

The departure date and time.

1..1

ArrivalDateTime*

DateTime (YYYY-MM-DDThh:mm:ss)

The arrival date and time.

1..1

JourneyDuration

Duration (PTnHnMnS)

Time duration of the journey from departure location to destination location.

0..1

JourneyDistance

string (1-16)

The distance in 'km' from departure location to destination location.

0..1

DepartureStation

Specifies the departure point of the passenger.

0..1

DepartureStation/Details

Specifies the departure station details.

TicketPrinterInd

boolean

Indicates if it is possible to print ticket on this station.

0..1

LocationCode

string

Contains code of location.

0..1

LocationName

string

Contains name of location.

0..1

LocationType*

For more information see Common Data Description section in Glossary.

CodeContext*

ArrivalStation

Specifies the arrival point of the passenger. Elements and attributes are the same as in DepartureStation element above.

0..1

CarCompany

Contais the pair of marketing and operating car company.

0..99

CompanyRPH*

integer

Specifies reference to pair of marketing and operating car company.

1..1

CarCompany/MarketingCompany

Indicates marketing train company.

0..1

Code

string (1-32)

Specifies marketing train company code.

0..1

CompanyShortName

string (1-32)

Specifies marketing train company name.

0..1

PreferLevel

string (“Required”, ”NoPreference” - default)

Indicates if this service can be removed from booking. Possible values: “Required” (service can't be removed) or “NoPreference”.

0..1

CarCompany/OperatingCompany

Attributes are the same as in CarCompany/MarketingCompany element above.

0..1

Code

string (1-32)

Specifies train owner company code.

0..1

CompanyShortName

string (1-32)

Specifies train owner company name.

0..1

PreferLevel

string (“Required”, ”NoPreference” - default)

Indicates if this service can be removed from booking. Possible values: “Required” (service can't be removed) or “NoPreference”.

0..1

ElRegPossible

Indicates if electronic registration is possible in current car.

0..1

Value*

boolean

1..1

TrainInfo*

Contains information about the specific train.

1..1

TrainInfo/Train

Contains specific train and train type.

0..1

TrainTypeCode

string

Supplier type of the train.

0..1

TrainInfo/Train/TrainNumber

string (1-8)

Unique number that identifies the train.

0..1

TrainInfo/Train/TrainName

string

Name of the train.

0..1

TrainInfo/Train/TrainBrand

string

Brand name of the train.

0..1

AvailabilityDetail

Contsins specific inventory-controlled service class code and detailed accommodation information, class and passenger type fares, and other service-related information. This information collectively represents one or more specific classes of service and a seat and berth accommodation.

0..99

VendorMessages/VendorMessage

Contains important comments about train and service.

0..99

Remarks/Remark

For more information see Common Data Description section in Glossary.

ElRegPossible

Indicates if electronic registration is possible in current car.

0..1

Value*

boolean

1..1

FareRules

Contains information about class and passenger type fares.

0..1

FareRules/FareRule

0..

SeatCarInfo

Contains information about seats of the particular service class in a particular car (or in all train if car number not specified).

0..1

SeatCarInfo/Car

Contains information about particular car.

0..99

Title

string

Refers to OTA code list information type (INF).

0..1

InfoType*

string

1..1

SubSection

Provides formatted textual information that a vendor wishes to make known. The type of information is indicated.

0..1

SubSection/Paragraph

0..1

Language

0..1

SubSection/Paragraph/Text

0..

CarCompanyRPH

integer

Reference to pair of marketing and operating car company.

0..1

DynamicPricing

boolean

Indicates that the price can increase in the case of the high demand for a specific date.

0..1

SeatsQuantity

integer

Specifies quantity of places mandatory to buy for this fare.

0..1

ClassCode

Contains information about service class.

0..99

DirectionContext

string (“Local”, “International”)

Specifies direction context.

0..1

Code

string

Specifies the class code.

0..1

CodeContext

string (1-32)

Specifies the context of the class code.

0..1

ClassCode/Description

string

Contains textual description of service class.

0..1

PriceRule*

Specific service type fare.

1..9

PaxGroupCode

string (“ADT”, “CHD”, “INF”)

Indicates pax age qualifying information for price.

0..1

Type

string (“PerPassenger”, “PerOrder”)

Posible values: “PerPassenger” - indicates that price value for one passenger, “PerOrder” - indicates that price value for some service order (VIP offers etc.).

0..1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1..1

Amount*

1..1

MaxAmount

0..1

PriceRule/PriceBreakDown

Contains details about the rail price, including basic fare, adjustments, discounts, ancillary charges, terms and conditions, fees and taxes.

0..1

PriceRule/PriceBreakDown/AccommodationAdjustment

Contains accommodation adjustments.

0..1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1..1

Amount*

1..1

MaxAmount

0..1

PriceRule/PriceBreakDown/FareQualifierAdjustment

Contains fare adjustments.

0..1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1..1

Amount*

1..1

MaxAmount

0..1

includeAccommodationAdjustment

boolean

Indicates if this amount include accommodation adjustment value.

0..1

PriceRule/PriceBreakDown/AncillaryCharge

Attributes are the same as in FareQualifierAdjustment element above.

0..1

PriceRule/PriceBreakDown/Tax

Attributes are the same as in AccommodationAdjustment element above.

0..1

TotalFare*

Attributes are the same as in AccommodationAdjustment element above.

1..1

Description

Contains textual description of tariff (specific class and passenger type fare).

0..1

DiscountApplied

Indicates that discount applied to price.

0..1

Value

boolean

0..1

AncillaryService

Contains information about ancillary service included.

0..9

Description

string

Contains textual description of ancillary service.

0..1

PreferLevel

string (“Required”, ”NoPreference” - default)

Indicates if this service can be removed from booking. Possible values: “Required” (service can't be removed) or “NoPreference”.

0..1

Code

string

Contains code of ancillary service.

0..1

CodeContext

string (1-32)

Specifies the context of ancillary service code.

0..1

Remarks/Remark

For more information see Common Data Description section in Glossary.

Number

integer

Indicates number of particular car.

0..1

Type*

string

Indicates type of particular car.

1..1

MultiTrainInd

boolean

Indicates (true or false) indicates if current car can be in different trains during journey.

0..1

TwoStoreyInd

boolean

Indicates if current car has two storey.

0..1

DepartureDateTime

Date or DateTime

The departure date and time of car (case of car in different trains during journey).

0..1

ArrivalDateTime

Date or DateTime

The arrival date and time of car (case of car in different trains during journey).

0..1

JourneyDuration

duration

The journey duration of car (case of car in different trains during journey).

0..1

JourneyDistance

string (1-16)

The journey distance of car (case of car in different trains during journey).

0..1

Seat

Contains information about seat.

0..10

SeatType

string(“Upper”, “Middle”, “Lower”, “UpperLateral”, “LowerLateral”, “Undefined”)

Contains seat type.

0..1

Count

integer

Count of seats of a particular type.

0..1

SeatNumbers

string

Numbers of available seats separated by comma.

0..1

ElRegPossible

Indicates if electronic registration is possible in current car.

0..1

Value*

boolean

1..1

Schema

Contains information about car schema.

0..1

GroupCode

string

Supplier direction group (can be useful for determining of correct car schemas).

0..1

Code

string

Specifies the schema code.

0..1

CodeContext

string (1-32)

Specifies the context of schema code.

0..1