Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
WS
Web Service Documentation
Version 2.21
UPDATE / 13.05.2011
Optional compliance
Modules affected:
AIDA version:
GuestsCountType attributes: MinAge, MaxAge and Age are now of type PersonAgeType instead of
integer
Packages, Hotels
1.16.11.746
Packages, Hotels
Allows setting age 0 to passengers
1.16.11.746
Version 2.2
UPDATE / 10.06.2011
Mandatory compliance
Modules affected:
AIDA version:
Web service now returns an error if a book request is made without sending the passenger-services
associations
Packages, Hotels
1.16.22.754
Page | 2
Version 2.3
ADD / 08.08.2011
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.4
ADD / 14.10.2011
Optional compliance
Modules affected:
Details:
AIDA version:
Performed some modifications to the web service flow, regarding the catalog-type packages
publication.
Packages
Operations added: PackCatalogFile
Operations removed: PackFullList
Added attribute Code to Location element and attribute ISO3 to City element.
Changed the structure of PackEntryTransp and PackEntryTour types in pack catalog xml file.
Added City element to PackEntryAcc in pack catalog xml file.
The pack catalog file now includes the search dates used to retrieve the results.
1.18.26.852
Version 2.5
ADD / 28.11.2011
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.6
ADD / 15.12.2011
Optional compliance
Modules affected:
Details:
AIDA version:
Page | 3
AIDA version:
Version 2.8
ADD / 31.05.2012
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.9
ADD / 07.01.2013
Mandatory compliance
Modules affected:
Details:
AIDA version:
Version 2.10
ADD / 27.02.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Page | 4
AIDA version:
Version 2.12
ADD / 28.05.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.13
ADD / 19.06.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Added new WS methods for transfers, added some new elements to some structures
Transfers, Reservations
Implemented transfers
1.33.28.1536
Version 2.14
ADD / 21.08.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.15
ADD / 12.09.2013
Optional compliance
Modules affected:
Details:
Page | 5
1.35.0.1638
Version 2.16
ADD / 24.10.2013
Mandatory compliance
Modules affected:
Details:
AIDA version:
New field (PaxNumber) in transfer book request. Mandatory only for transfer feed.
Transfers
Added new mandatory attribute PaxNumber in transfer book request.
1.35.13.1651
Version 2.17
ADD / 19.11.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.18
ADD / 19.12.2013
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.19
ADD / 21.01.2014
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.20
ADD / 13.03.2014
Optional compliance
Modules affected:
Details:
AIDA version:
Version 2.21
ADD / 28.04.2014
Mandatory compliance
Modules affected:
Details:
Added rates structures to accommodation requests, and changed the way secondary services are
sent
Hotels
Rewrote accSearchRQ, accSearchRS, accAvailRQ, accAvailRS, accBookRQ, accBookRS
Added MainPicture attribute in AccUnitsRS
AIDA version:
Next release
Page | 6
TABLE OF CONTENTS
DESCRIPTION OF AIDA.WS ....................................................................................................................................................... 11
Introduction ......................................................................................................................................................................... 11
Enabling the web service ..................................................................................................................................................... 11
Object of communication .................................................................................................................................................... 11
Message exchange patterns ................................................................................................................................................ 11
Requirements ...................................................................................................................................................................... 11
SETTING UP THE WEB SERVICE CLIENT .................................................................................................................................... 13
AUTHENTICATION CREDENTIALS ............................................................................................................................................. 14
Reseller authentication ........................................................................................................................................................ 14
Distributor authentication ................................................................................................................................................... 15
MESSAGES................................................................................................................................................................................ 16
GLOBE MESSAGES ................................................................................................................................................................ 17
GlobeCountries ................................................................................................................................................................ 17
GlobeRegions ................................................................................................................................................................... 19
GlobeCities ....................................................................................................................................................................... 22
GlobeLocations ................................................................................................................................................................ 23
GetItineraryFull ................................................................................................................................................................ 25
PACK CATALOG MESSAGES .................................................................................................................................................. 28
PackSearch ....................................................................................................................................................................... 29
PackExtraServices ............................................................................................................................................................ 36
PackAvail .......................................................................................................................................................................... 40
PackBook.......................................................................................................................................................................... 45
PackCatalogFile ................................................................................................................................................................ 50
PackDetails ....................................................................................................................................................................... 57
SERVICE MESSAGES ............................................................................................................................................................. 59
AccUnits ........................................................................................................................................................................... 61
Page | 7
Page | 10
DESCRIPTION OF AIDA.WS
INTRODUCTION
AIDA web service enables the connectivity and interaction between AIDA system and third party travel distribution
systems. It creates a shared communication platform between a tour operators inventory and the distribution interfaces
of its resellers.
OBJECT OF COMMUNICATION
This document refers to AIDA.WS web service, which ensures interoperability for static packages(holiday and tour
packages), accommodation unitsand transfer services.
REQUIREMENTS
Technical details
To be able to access AIDA Web Service, the following information is needed:
-
Language
AIDA.WS is implemented using SOAP, which is an XML-based protocol. To enable this service, you need to have the ability
to:
-
Page | 11
W3C: http://www.w3.org/TR/soap/
Wikipedia: http://en.wikipedia.org/wiki/SOAP
PHP SOAP library: http://php.net/manual/en/book.soap.php
Others:
o Overview of SOAP: http://java.sun.com/developer/technicalArticles/xml/webservices/
o Understanding SOAP: http://msdn.microsoft.com/en-us/library/ms995800.aspx
Page | 12
Page | 13
AUTHENTICATION CREDENTIALS
The authentication credentials must be set within the <AuthHeader> element.
The language of the response can also be requested using the Lang attribute within the <AuthHeader> element.
The information required for authentication may vary, depending on whether the entity making the request is a reseller or
a distributor.
RESELLER AUTHENTICATION
Resellers must authenticate with the following information:
-
Username
Password
ResellerCode
We recommend using SOAP headers to set this information. Here is an example on how to do this, using PHPs built-in
SOAPClient class:
$SOAP_Client->__setSoapHeaders(
newSoapHeader([web service namespace], 'AuthHeader', array(
'Username'
=>[your username],
'Password'
=>[your password],
'ResellerCode'
=>[the reseller code you received from dcs],
))
);
The authentication credentials will be processed and the details of the reseller will be included in the <POS> element of
the response (see the example below):
<ns1:POS>
<ns1:Requestor>
<ns1:AgencyID="14"Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:UserUsername="dcstravel">Frincu Mirela</ns1:User>
</ns1:Requestor>
<ns1:BookingChannelType="WS"/>
</ns1:POS>
Page | 14
DISTRIBUTOR AUTHENTICATION
For distributors, the authentication information is sightly different. Each distributor must be entered in AIDA and have
assigned specific username and password. This information must be provided to the distributor and it will be used,
regardless of the reseller behind the distributor.
Therefore, the distributor must authenticate using:
-
Username
Password
Distributor information
The distributor information must include the reseller code within the distributors system. Distributor reseller codes must
be associated to resellers in AIDA, so that these can be identified when receiving a request by web service.
Optionally, the distributor information can also include the username (from the distributors system) of the reseller agent
performing the request. If a match against that username is found in AIDA, the system will associate the request to the
matched user.
Here is how the <AuthHeader>element should look like in a request performed by a distributor:
<SOAP-ENV:Header>
<ns1:AuthHeaderLang="en">
<ns1:Username>distrib_user</ns1:Username>
<ns1:Password>distrib_pass</ns1:Password>
<ns1:DistributorAgencyCode="distrib_code"AgentUsername="distrib_username" />
</ns1:AuthHeader>
</SOAP-ENV:Header>
The authentication credentials will be processed and the details of the reseller and distributor details will be included in
the <POS> element of the response (see the example below):
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="14" Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:User Username="dcstravel">Frincu Mirela</ns1:User>
<ns1:Distributor AgencyCode="distrib_code" AgentUsername="distrib_username">DISTRIBUTOR NAME</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
Page | 15
MESSAGES
AIDA.WS includes 2 modules:
-
AIDA.WS Packages
AIDA.WS Hotels
Each module includes specific messages, but also makes use of common structures and methods.
The AIDA.WS Packages specific messages are:
-
Package messages: These cover a wide range of operations, including: retrieve the list of packages, enquire about
a packages components, request availability and even book a specific package.
Service messages:These cover the operations related to the tailor-made bookings, where packages are not
predefined, but the user manally selects the services they want to reserve. These operations include: search
accommodation services, enquire upon availability and prices and, finally, book an accommodation service.
Globe messages: These cover communication of countries, cities, regions and locations.
Reservation messages: These cover operations related to the reservation: get details, cancel a reservation.
Tools messages: These provide a way to facilitate the export of information and configuration that are static in
AIDA .
Page | 16
GLOBE MESSAGES
The Globe is structured over 4 levels of depth:
-
Countries
Regions (one country has more than one region)
Cities (one region has more than one city)
Locations (one city has more than one location).
Usually, to identify a selling service, the country and city elements will be required.
All the globe messages have a common structure:
-
In the request message the list of globe elements can be filtered by various elements
The response message offers a list of requested globe elements
GlobeCountries
Message Pair Overview
The AIDA Globe Countries message pair includes the structure needed to inquire and response upon the countries
available in AIDA system.
The Globe Countries request message can also be used to get the details of a specific country, if the country ID or name
are provided.
The Globe Countries response message lists all the globe countries in AIDA, as entered by the tour operator.
Message Pair Elements and Attributes
AIDA_GlobeCountriesRQ
Message Structure
Element
SEQUENCE
Filters
SEQUENCE
Country
Type
Occurs
Description
anyType (restriction)
0..1
Complex Type:
CountryType
0..1
Page | 17
AIDA_GLOBECOUNTRIESRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Countries
SEQUENCE
Country
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Complex Type:
CountryType
0..*
Page | 18
GlobeRegions
Message Pair Overview
The AIDA Globe Regions message pair includes the structure needed to inquire and response upon the regions available in
AIDA system.
The Globe Regions request message can also be used to get the details of a specific region, if the region ID and/or name
are provided. In the same manner, all regions in a specific country can be retrieved if the country ID is added to the
request.
The Globe Regions response message lists all the globe regions in AIDA, as entered by the tour operator.
Message Pair Elements and Attributes
AIDA_GlobeRegionsRQ
Message Structure
Element
SEQUENCE
Filters
SEQUENCE
Region
Country
Type
Occurs
Description
anyType (restriction)
0..1
Complex Type:
RegionType
0..1
Complex Type:
CountryType
0..1
Page | 19
AIDA_GlobeRegionsRS
Page | 20
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Complex Type:
RegionType
0..*
Page | 21
GlobeCities
Message Pair Overview
The AIDA Globe Cities message pair includes the structure needed to inquire and response upon the cities available in
AIDA system.
The Globe Cities request message can also be used to get the details of a specific city, if the city ID and/or name are
provided. In the same manner, all cities in a specific country can be retrieved if the country ID is added to the request.
The Globe Cities response message lists all the globe cities in AIDA, as entered by the tour operator.
Message Pair Elements and Attributes
AIDA_GlobeCitiesRQ
Message Structure
Element
Type
Occurs
Description
SEQUENCE
Filters
anyType (restriction)
0..1
Collection of data that may filter the results list. The list
can be filtered by city and country.
Complex Type:
CityType
0..1
Complex Type:
CountryType
0..1
SEQUENCE
City
Country
Page | 22
AIDA_GlobeCitiesRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Cities
SEQUENCE
City
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Complex Type:
CityType
0..*
GlobeLocations
Page | 23
AIDA_GlobeLocationsRQ
Message Structure
Element
SEQUENCE
Filters
SEQUENCE
Location
City
Type
Occurs
Description
anyType (restriction)
0..1
Complex Type:
LocationType
Complex Type:
CityType
0..1
0..1
AIDA_GlobeLocationsRS
Page | 24
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Complex Type:
LocationType
0..*
GetItineraryFull
Page | 25
AIDA_GetItineraryFullRQ
Message Structure
Element
Type
Occurs
Description
SEQUENCE
PackEntry
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
Attribute
ID
Service
Attribute
ID
<soapenv:Envelopexmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ns="http:
//aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_GetItineraryFullRQ>
<ns:PackEntryID="22937"/>
<ns:ServiceID="4767"/>
</ns:AIDA_GetItineraryFullRQ>
</soapenv:Body>
</soapenv:Envelope>
AIDA_GetItineraryFullRS
Page | 26
Message Structure
Element
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
anyType (restriction)
1..1
anyType (restriction)
1..*
Complex Type:
ItinerarySegmentLoc
ationType
Complex Type:
ItinerarySegmentLoc
ationType
Type
string
string
string
float
0..1
0..1
Mandatory
Yes
Yes
Yes
Yes
Description
Identifies the flight number
Identifies the flight class
Identifies the carrier company
Identifies the maximum kilos per flight
Type
positiveInteger
string
Mandatory
Yes
Yes
Description
The ID of the transportation service
The name of the transportation service
Attribute
Type
Mandatory
ID
positiveInteger
Yes
DateStart
date
Yes
Description
Unique numerical identifier of the package
entry
Represents the checkin
DateEnd
date
Yes
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
PackEntry
SEQUENCE
Transportation
SEQUENCE
Segment
SEQUENCE
Departure
Arrival
Attribute
FlightNo
FlightClass
Carrier
MaxKilos
Attribute
ServiceID
Name
<SOAP-ENV:Envelopexmlns:SOAPENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ns1="http://aida.dcsplus.net/ws/2010">
<SOAP-ENV:Body>
<ns1:AIDA_GetItineraryFullRS>
<ns1:POS>
<ns1:Requestor>
<ns1:AgencyID="14"Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:UserUsername="dcstravel">Frincu Mirela</ns1:User>
</ns1:Requestor>
<ns1:BookingChannelType="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:PackEntryID="22937"DateStart="2013-11-19"DateEnd="2013-11-20">
<ns1:TransportationServiceID="4767"Name="Transport dus - [Bucuresti - ploiesti]">
<ns1:Segment>
<ns1:DepartureDate="2013-11-19"Time="10:00">
<ns1:CityID="3"Name="Bucharest"ISO3="BUH"CountryID="1"RegionID="1"/>
<ns1:CountryID="1"Name="Romania"ISO2="RO"/>
</ns1:Departure>
<ns1:ArrivalDate="2013-11-19"Time="11:00"Place="Malu Rosu">
<ns1:CityID="2"Name="Ploiesti"ISO3="PLO"CountryID="1"RegionID="1"/>
<ns1:CountryID="1"Name="Romania"ISO2="RO"/>
</ns1:Arrival>
</ns1:Segment>
</ns1:Transportation>
</ns1:PackEntry>
</ns1:AIDA_GetItineraryFullRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PackSearch
Returns a catalog-type list of packages, offering price and
availability info. Extra services are listed, but are not yet
configured, so they are not included in the price and availability
calculations
PackExtraServices
PackAvail
PackBook
Receives the same information as PackageAvail + Customers +
Service customers associations + comments and performs a
reservation in AIDA, returning basic details about the reservation
ReservationDetails
ReservationCancel
PackCatalogFile
Performs a request for the catalog file generation, which
will be received at a specified location (return URL).
PackSearch
Page | 29
AIDA_PackSearchRQ
Element
Type
Occurs
Description
SEQUENCE
SearchCriteria
anyType (restriction)
0..1
SEQUENCE
Destination
anyType (restriction)
0..1
Type
positiveInteger
anyType (restriction)
0..1
Mandatory
Yes
0..1
Mandatory
Yes
0..1
Mandatory
Yes
0..1
CHOICE
DateRange
anyType (restriction)
1..1
Attribute
DateStart
DateEnd
Months
Type
date
date
anyType (restriction)
SEQUENCE
Country
Attribute
ID
Region
Attribute
ID
City
Attribute
ID
Period
SEQUENCE
Month
Type
positiveInteger
Type
positiveInteger
Min value: 1
Max value: 12
anyType (restriction)
SEQUENCE
GuestCount
Attribute
AgeQualifyingCode
Count
Age
Package
Attribute
Type
Category
1..1
1..3
Type
Simple Type:
AgeQualifyingCodeTypeRQ
positiveInteger
Integer value between 0
and 120
anyType (restriction)
Type
Simple Type: PackageType
string
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>test</ns:Username>
<ns:Password>test</ns:Password>
<ns:ResellerCode>ROT</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_PackSearchRQ>
<ns:SearchCriteria>
<ns:Period>
<ns:DateRange DateStart="2011-08-05" DateEnd="2011-08-31" />
</ns:Period>
<ns:Room>
<ns:GuestCount AgeQualifyingCode="a" Count="1" />
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="7" />
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="16" />
</ns:Room>
</ns:SearchCriteria>
</ns:AIDA_PackSearchRQ>
</soapenv:Body>
</soapenv:Envelope>
AIDA_PackSearchRS
Page | 31
Element
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
0..1
anyType (restriction)
0..*
Mandatory
Yes
Yes
Description
The internal ID of the package.
The type of package.
Name
Currency
Code
Category
Type
positiveInteger
Simple Type:
PackageType
string
string
string
string
Yes
Yes
No
No
SEQUENCE
Description
PackEntries
string
anyType (restriction)
0..1
1..1
anyType (restriction)
1..*
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Packages
SEQUENCE
Package
Attribute
ID
Type
SEQUENCE
PackEntry
Attribute
ID
Type
positiveInteger
DateStart
DateEnd
SEQUENCE
ExtraServices
date
date
anyType (restriction)
0..1
anyType (restriction)
1..*
SEQUENCE
ExtraService
Attribute
ID
Type
positiveInteger
Name
Type
string
string
Mandatory
boolean
anyType
(restriction)
1..1
anyType
(restriction)
1..*
ComplexType:
PackEntryTour
0..1
Accommodation
ComplexType:
PackEntryAcc
1..*
Transportation
ComplexType:
PackEntryTran
sp
0..2
Price
Complex Type:
PriceType
ComplexType:
PackAvailType
1..1
SEQUENCE
Configuration
SEQUENCE
Tour
Availability
1.. 1
Page | 33
Page | 34
Page | 35
PackExtraServices
Message Pair Overview
The PackExtraServices provides a means to interrogate the system upon the configurations available for the secondary
services within a package.
The PackSearchRQ communicates to AIDA a specific package entry and configuration and expects the system to respond
with a list of the possible ways to purchase the secondary services within the package.
This message is necessary for packages that include extra services, because the next request, PackAvail, requires that all
mandatory extra services be configured.
Message Pair Elements and Attributes
AIDA_PackExtraServicesRQ
Element
Type
Occurs
SEQUENCE
Package
anyType (restriction)
1..1
Attribute
ID
Type
positiveInteger
Type
SEQUENCE
PackEntry
anyType (restriction)
Description
Attribute
ID
Type
positiveInteger
SEQUENCE
ExtraServices
anyType (restriction)
0..1
anyType (restriction)
1..*
Type
positiveInteger
Mand
Yes
SEQUENCE
ExtraService
Attribute
ID
Page | 36
AIDA_PackExtraServicesRS
Element
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Name
Currency
Code
Category
Type
positiveInteger
Simple Type:
PackageType
string
string
string
string
Yes
Yes
No
No
SEQUENCE
PackEntry
Attribute
ID
anyType (restriction
Type
positiveInteger
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Package
Attribute
ID
Type
1..1
Identifies the requested package entry
Mandatory
Description
Yes
Unique numerical identifier of the package
entry
Page | 37
SEQUENCE
Service
date
date
Yes
Yes
anyType (restriction)
1..1
anyType (restriction)
1..*
Type
boolean
Attribute
anyType
(restriction)
Type
ID
Name
Stars
positiveInteger
string
positiveInteger
Yes
Yes
No
DurationTimeUnit
Simple Type:
DurationTimeUnit
Type
Yes
Complex Type:
ServiceType
1..1
Description
ServiceEntries
string
Complex Type:
ServiceEntriesTyp
e
0..1
0..1
BookingRules
anyType
(restriction)
1..1
anyType
(restriction)
Type
Simple Type:
AgeQualifyingCod
eType
boolean
1..*
SEQUENCE
Type
SEQUENCE
PaxTypeAllowed
Attributes
Type
AllPaxBook
Mand.
Yes
1..1
Page | 38
Page | 39
PackAvail
Message Pair Overview
The PackAvailRQ message interrogates AIDA upon the availability of a specific package entry with a selected configuration.
If the package contains any mandatory extra services, they too must be configured to use this message.
The PackAvailRS includes information about all services specified in the request. It offers price and availability information,
as well as a collection of cancel penalties if they exist.
Message Pair Elements and Attributes
AIDA_PackAvailRQ
Element
Type
Occurs
Description
SEQUENCE
Package
anyType (restriction)
1..1
Attribute
ID
Type
positiveInteger
Mandatory
Yes
Type
Simple Type:
PackageType
Yes
anyType (restriction)
1..1
Attribute
ID
Type
positiveInteger
Mandatory
Yes
SEQUENCE
Rooms
anyType (restriction)
1..1
SEQUENCE
Room
anyType (restriction)
1..*
Attribute
ID
Rate
Type
string
anyType (restriction)
Mandatory
Yes
0..1
SEQUENCE
PackEntry
Page | 40
Atribute
ID
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
0..1
anyType (restriction)
1..*
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
anyType (restriction)
1..*
Type
string
Mandatory
Yes
Complex Type:
DateTimeRangeType
0..1
anyType (restriction)
1..1
anyType (restriction)
1..*
Mandatory
Yes
Count
Type
Simple Type:
AgeQualifyingCodeType
positiveInteger
Age
positiveInteger
No
ExtraServices
SEQUENCE
ExtraService
SEQUENCE
Service
Attribute
ID
ServiceEntries
SEQUENCE
ServiceEntry
Attribute
ID
SEQUENCE
DateRange
GuestsCount
SEQUENCE
GuestCount
Attribute
AgeQualifyingCode
Yes
Page | 41
Page | 42
AIDA_PackAvailRS
Element
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Name
Currency
Code
Category
Type
positiveInteger
Simple Type:
PackageType
string
string
string
string
Yes
Yes
No
No
SEQUENCE
PackEntry
Attribute
ID
anyType (restriction
Type
positiveInteger
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Package
Attribute
ID
Type
DateStart
DateEnd
SEQUENCE
ExtraServices
SEQUENCE
ExtraService
date
date
anyType (restriction)
1..1
anyType (restriction)
1..*
Type
positiveInteger
Name
Type
string
String
Mandatory
boolean
Accommodation
1..1
Identifies the requested package entry
Mandatory
Description
Yes
Unique numerical identifier of the package
entry
Yes
Represents the checkin
Yes
Represents the checkout
Attribute
ID
Configuration
SEQUENCE
Tour
anyType (restriction)
ComplexType:
PackEntryTour
0..1
ComplexType:
1..*
Transportation
ComplexType:
PackEntryTransp
1..2
Price
Complex Type:
PriceType
Complex Type:
PriceRateType
ComplexType:
PackAvailType
1..1
Complex Type:
CancelPenaltiesType
0..1
Rate
Availability
CancelPenalties
0..1
1..1
Page | 44
PackBook
Message Pair Overview
The PackBook message pair is used to perform a booking in AIDA system. It requires that all services within a package be
configured and associated with customers.
Message Pair Elements and Attributes
AIDA_PackBookRQ
Element
Type
Occurs
Description
SEQUENCE
AdditionalResellerInfo
anyType(restriction)
0..1
Type
string
Mandatory
Yes
string
anyType (restriction)
Yes
1..1
Attribute
ID
Type
positiveInteger
Mandatory
Yes
Type
Simple Type:
PackageType
Yes
anyType (restriction)
1..1
Attribute
ID
Type
positiveInteger
Mandatory
Yes
SEQUENCE
Rooms
anyType (restriction)
1..*
anyType (restriction)
1..*
Type
string
Mandatory
Yes
Attribute
OutsiderUsername
OutsiderCode
Package
SEQUENCE
PackEntry
SEQUENCE
Room
Attribute
ID
Description
Unique identifier of the room
Page | 45
anyType (restriction)
0..1
SEQUENCE
Customer
Attribute
CustomerIndex
Rate
anyType (restriction)
Type
positiveInteger
anyType (restriction)
1..*
Mandatory
Yes
0..1
Attribute
ID
ExtraServices
Type
positiveInteger
anyType (restriction)
Mandatory
Yes
0..1
SEQUENCE
ExtraService
anyType (restriction)
1..*
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
anyType (restriction)
1..*
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
anyType (restriction)
1..*
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
Complex Type:
CustomerElementType
1..*
anyType (restriction)
1..1
SEQUENCE
Service
Attribute
ID
ServiceEntries
SEQUENCE
ServiceEntry
Attribute
ID
Customers
SEQUENCE
Customer
Attribute
CustomerIndex
Customers
SEQUENCE
Customer
GlobalInfo
string
0..1
Remarks
string
0..1
Page | 47
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>test</ns:Username>
<ns:Password>test</ns:Password>
<ns:ResellerCode>ROT</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_PackBookRQ>
<ns:Package ID="115" Type="holiday">
<ns:PackEntry ID="49">
<ns:Rooms>
<ns:Room ID="DBL_442_2249"/>
<ns:Rate ID="885462"/>
</ns:Rooms>
<ns:ExtraServices>
<ns:ExtraService>
<ns:Service ID="449"/>
<ns:ServiceEntries>
<ns:ServiceEntry ID="2011-08-06_5"/>
</ns:ServiceEntries>
<ns:Customers>
<ns:Customer CustomerIndex="1"/>
<ns:Customer CustomerIndex="2"/>
</ns:Customers>
</ns:ExtraService>
<ns:ExtraService>
<ns:Service ID="459"/>
<ns:ServiceEntries>
<ns:ServiceEntry ID="2011-08-11_1"/>
</ns:ServiceEntries>
<ns:Customers>
<ns:Customer CustomerIndex="1"/>
</ns:Customers>
</ns:ExtraService>
</ns:ExtraServices>
</ns:PackEntry>
</ns:Package>
<ns:Customers>
<ns:Customer CustomerIndex="1" Owner="true" AgeQualifyingCode="a">
<ns:PersonName>
<ns:FirstName>Mirela</ns:FirstName>
<ns:LastName>Campan</ns:LastName>
</ns:PersonName>
</ns:Customer>
<ns:Customer CustomerIndex="2" AgeQualifyingCode="a">
<ns:PersonName>
<ns:FirstName>Laurean</ns:FirstName>
<ns:LastName>Campan</ns:LastName>
</ns:PersonName>
</ns:Customer>
</ns:Customers>
<ns:GlobalInfo>
<ns:Comments>comments</ns:Comments>
<ns:Remarks>remarks</ns:Remarks>
</ns:GlobalInfo>
</ns:AIDA_PackBookRQ>
</soapenv:Body>
</soapenv:Envelope>
Page | 48
AIDA_PackBookRS
This message returns basic information about the reservation, all included in the <Reservation> element:
-
ID
Code (a unique 6-character-long internal code assigned to reservations in AIDA)
Status (indicates if reservation is in request, cancelled or confirmed)
When the reservation is made in AIDA, the package is transformed into a separate reservation service entity. It has almost
the same properties as other reservation services and appears as a PackageComponent in the PackageBookRS and
ReservationDetailsRS messages.
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
BookingReference
Attribute
BookActionSts
SEQUENCE
Reservation
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Type
string
Complex Type:
ReservationDataType
Page | 49
PackCatalogFile
Message Pair Overview
The PackCatalogFile message pair is used to obtain a full catalog of all available packages in AIDA.
The PackCatalogFileRQ sends a notification to AIDA, informing that the reseller wishes to receive a fresh copy of the
package catalog file.
The PackCatalogFileRS message informs the reseller that their request has been recorded. A unique identification number,
called TOKEN, is generated for them and sent in PackCatalogFileRS. Requests for the catalog files are recorded once per
reseller. If the same reseller makes several requests, they will receive the same token each time.
At a specific time, configured in the system by the tour operator, AIDA generates catalog files for each request it has
received since the previous generation. The package catalog file is a ZIP archive, containing a variable number of XML files
(can be up to 365 XML files) and covering a one-year-long period. The starting time of this interval is always the day of
catalog generation.
Once generated, there are 2 possibilities to transfer the catalog files to the entities that requested them. The transfer
method is configured in the system for each reseller / distributor.
A. File push
If the file push method is selected, then in the PackCatalogFileRQ message, the requester must provide a
returnURL. This is an address where AIDA sends the catalog file after generation, via POST, using 2 parameters:
o
fileKey:
The archive itself is being sent to the return URL as a file resource, with the variable name catalogFile (can be
retrieved using $_FILES*catalogFile+).
In case the the file push is unsuccessful, the pack catalog file request record is not deleted. On the next
PackCatalogFileRQ message, the reseller will receive the same token as before.
B. Download
If the download method is selected, then the returnURL should not be specified in PackCatalogFileRQ message.
The requester will receive in PackCatalogFileRS message a download link (DownloadURL attribute), which they
should use to manually download the file at any time. A security code is generated specific of each request and
included in the download link.
Upon accessing the download link, several important headers can be received:
Page | 50
2.
3.
A custom header called AIDA-Catalog-Status is also sent to provide more information when necessary.
AIDA_PackCatalogFileRQ
PackCatalogFileRQ XML Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>test</ns:Username>
<ns:Password>test</ns:Password>
<ns:ResellerCode>ROT</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_PackCatalogFileRQ>
<ns:ReturnURL>http://someurl/receivePackCatalogFile.php</ns:ReturnURL>
</ns:AIDA_PackCatalogFileRQ>
</soapenv:Body>
</soapenv:Envelope>
AIDA_PackCatalogFileRS
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
PackCatalogFileRequest
Attribute
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
string (extension)
1..1
1..1
0..1
1..1
Type
Page | 51
boolean
Yes
Token
string
Yes
DownloadURL
anyURI
No
The content of the generated XML files is much similar to AIDA_PackSearchRS message. In addition, the pack catalog XML
file is indicating the overall occupancy for each configuration found.
For example: A tour package with 2 hotels is included in the response. The rooms found for each of these are as follows:
Hotel #1: room with 1*Adult+1*Child [2-10], where 2 is min age and 10 is max age of child
Hotel #2: room with 1*Adult + 1*Child[5-16], where 5 is min age and 16 is max age of child
For this configuration, AIDA will set the occupancy to: 1*Adult+1*Child[5-10], where 5 is min age and 10 is max age of
child. A child with age 4 cannot be accommodated in hotel #2 and a child with age 15 cannot be accommodated in hotel
#1.Therefore, AIDA sets a common interval that suites all rooms in the package.
Pack Catalog XML File Structure:
Page | 52
Element
Type
Occurs
Attribute
SearchStartDate
SearchEndDate
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Packages
SEQUENCE
Package
Type
date
date
Mandatory
Yes
Yes
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
0..1
anyType (restriction)
0..*
Mandatory
Yes
Yes
Description
The internal ID of the package.
The type of package.
Name
Currency
Code
Category
Type
positiveInteger
Simple Type:
PackageType
string
string
string
string
Yes
Yes
No
No
SEQUENCE
Description
Project
string
anyType(restriction)
0..1
1..1
Attribute
ID
Name
PackEntries
Type
positiveInteger
string
anyType (restriction)
Mand
Yes
Yes
1..1
anyType (restriction)
1..*
Attribute
ID
Type
SEQUENCE
PackEntry
Description
Description
The start date of the search period
The end date of the search period
Attribute
ID
Type
positiveInteger
DateStart
DateEnd
SEQUENCE
Duration
date
date
string (extension)
1..1
Attribute
Type
Mandatory
Description
Page | 53
Simple Type:
DurationTimeUnitType
Yes
anyType (restriction)
0..1
1..*
Attribute
ID
anyType
(restriction)
Type
positiveInteger
Name
Type
string
string
Mandatory
boolean
ExtraServices
SEQUENCE
ExtraService
PackConfigurations
SEQUENCE
Configuration
SEQUENCE
Occupancy
anyType
(restriction)
anyType
(restriction)
xsd:anyType
(restriction)
1..1
SEQUENCE
GuestCount
xsd:anyType
0..*
(restriction)
Attributes
Type
AgeQualifyingCode Simple Type:
AgeQualifyingCodeTypeRS
Count
xsd:positiveInteger
MinAge
PersonAgeType (0-120)
MaxAge
Tour
Accommodation
Mandatory
Yes
Description
Yes
No
Mandatory for
children
PersonAgeType (0-120)
No
Mandatory for
children
ComplexType: 0..1
Identifies a tour service within the package.
PackEntryTour
This appears only for tour package types and
only appears once
ComplexType:
PackEntryAcc
1..*
Page | 54
ComplexType:
PackEntryTran
sp
0..2
Price
Complex Type:
PriceType
anyType
(restriction)
1..1
Complex Type:
PriceRateType
1..*
ComplexType:
PackAvailType
1.. 1
Rates
SEQUENCE
Rate
Availability
1..1
[]
Page | 55
[]
</PackConfigurations>
</PackEntry>
</PackEntries>
</Package>
</Packages>
<Package ID="116" Type="tour" Name="CIRCUIT IN GRECIA" Currency="GR07" Category="adventure">
<Project ID="96" Name="GRECIA 2011" />
<Description>Un singur tinut: Grecia Antica.
Povesti cu zei, dealuri sacre, temple nepretuite, primele jocuri
olimpice, nasterea filosofiei occidentale si a democratiei
oricare ar fi pasiunea ta, este imposibil sa nu te simti legat
intr-un fel sau altul de Grecia si de bogata sa</Description>
<PackEntries>
<PackEntry ID="175" DateStart="2011-10-24" DateEnd="2011-10-31">
<ExtraServices>
<ExtraService ID="457" Name="Excursie la Cap Sounion" Type="Excursie pe zi" Mandatory="true"/>
<ExtraService ID="456" Name="Excursie in Peloponez" Type="Excursie pe zi" Mandatory="true"/>
<ExtraService ID="455" Name="Croaziera in insule" Type="Croaziera" Mandatory="true"/>
</ExtraServices>
<PackConfigurations>
<Configuration>
<Occupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
<GuestCount AgeQualifyingCode="c" Count="1" MinAge="13" MaxAge="14"/>
</Occupancy>
<Accommodation Name="Poseidon" Stars="3" RoomID="452_DBL_450_2276" RoomName="Cam. dubla,
classic (1*Adult+1*Copil [13-18])">
<RoomOccupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
<GuestCount AgeQualifyingCode="c" Count="1" MinAge="13" MaxAge="18"/>
</RoomOccupancy>
<City ID="40" Name="Salonic"/>
</Accommodation>
<Accommodation Name="Achillion" Stars="3" RoomID="453_DBL_452_2282" RoomName="Cam. dubla,
standard (1*Adult+1*Copil [2-18])">
<RoomOccupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
<GuestCount AgeQualifyingCode="c" Count="1" MinAge="2" MaxAge="18"/>
</RoomOccupancy>
<City ID="41" Name="Atena"/>
</Accommodation>
<Accommodation Name="Philoxenia Bungalows" Stars="3" RoomID="454_DBL_454_2288" RoomName="Cam.
dubla, dbl (1*Adult+1*Copil [2-14])">
<RoomOccupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
<GuestCount AgeQualifyingCode="c" Count="1" MinAge="2" MaxAge="14"/>
</RoomOccupancy>
<City ID="68" Name="Halkidiki"/>
</Accommodation>
<Price Ammount="782.31" CurrencyCode="EUR"/>
<Availability Status="OK"/>
</Configuration>
</PackConfigurations>
</PackEntry>
</PackEntries>
</Package>
</Packages>
</AIDA_PackFullListRS>
Page | 56
PackDetails
Message Pair Overview
The PackDetails message is used to gather all descriptive information regarding a package: name, description, image links
and more.
Message Pair Elements and Attributes
AIDA_PackDetailsRQ
Message structure
Element
Type
Occurs
Description
SEQUENCE
Package
Attribute
ID
anyType (restriction)
Type
positiveInteger
1..1
Includes information identifying the package
Mandatory Description
Yes
Unique numerical identifier of the package
AIDA_PackDetailsRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
1..1
1..1
0..1
1..1
Includes all information related to the package
Mandatory
Description
Yes
The internal ID of the package
Yes
The type of package.
Name
Currency
Code
Category
anyType (restriction)
Type
positiveInteger
Simple Type:
PackageType
string
string
string
string
SEQUENCE
Description
Picture
string
string (extension)
0..1
0..1
Attribute
URL
Project
Type
anyURI
anyType(restriction)
Attribute
ID
Name
DateStart
DateEnd
Code
Type
positiveInteger
string
date
date
string
SEQUENCE
Description
string
Yes
Yes
No
No
Page | 58
SERVICE MESSAGES
AIDA Hotels Web Service Logic
AccSearch
Returns list of services with their rooms (offering price and
availability info) and extra services
AccAvail
Receives several rooms of a single unit along with their linked
extra services (if these exist) and returns the overall availability
informatin + prices + cancel penalties, returns all the services in a
package with their service entries
AccBook
Receives the same information as PackageAvail + Customers +
Service customers associations + comments and performs a
reservation in AIDA, returning the reservation id and code
ReservationDetails
ReservationCancel
AccUnits
Returns all information about existing units in the system
(static/informative operation)
Page | 59
TransferSearch
Returns list of services, grouped by segments, with prices and
availability
TransferBook
Receives information regarding booking service, segment and
customers and performs a booking
ReservationDetails
ReservationCancel
Page | 60
AccUnits
Message Pair Overview
The AccUnits request message interrogates AIDA about the static information of one or multiple units in the system.
The AccUnits response message offerscomplete information about the requested units: name, location, descriptive
information, image gallery and more.
Message Pair Elements and Attributes
AIDA_AccUnitsRQ
The request is made either for a certain unit or for all the units in a certain city. The details of all units can also be
requested by not specifying any filters. However, we do not recommend this option, due to the high volume of provided
information.
Message Structure
Element
Type
Occurs
Description
SEQUENCE
Filters
anyType (restriction)
0..1
CHOICE
Unit
anyType (restriction)
0..1
Attribute
ID
City
Type
positiveInteger
Complex Type:
CityType
Page | 61
AIDA_AccUnitsRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccUnits
SEQUENCE
AccUnit
Attribute
ID
Name
Stars
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
anyType (restriction)
0..*
Latitude
Longitude
LastUpdated
Type
positiveInteger
string
SimpleType:
ServiceStarsType
StringLength1to16
StringLength1to16
string
ThemesIDS
string
SEQUENCE
Type
Category
Destination
Contact
SEQUENCE
Telephone
Fax
E-mail
WebAddress
Facilities
SEQUENCE
Facility
Attribute
Code
Complex Type:
ServiceType
Complex Type:
AccCategoryType
Complex Type:
LocalizationType
1..1
0..1
1..1
anyType (restriction)
0..1
string
string
string
anyURI
anyType (restriction)
0..1
0..1
0..1
0..1
0..1
string (extension)
Type
string
1..*
Mand
Yes
Category
Descriptions
string
anyType (restrictions)
No
0..1
SEQUENCE
ShortDescription
FullDescription
RoomsDescription
FacilitiesDescription
LocationDescription
DrivingDirections
string
string
string
string
string
string
0..1
0..1
0..1
0..1
0..1
0..1
TouristicAttractions
Policies
string
string
0..1
0..1
anyType (restrictions)
0..1
string (extension)
1..*
Gallery
SEQUENCE
GalleryImage
Attribute
URL
Type
anyURI
MainPicture
boolean
Page | 63
Page | 64
AccThemes
Message Pair Overview
The AccThemes request message interrogates AIDA about the accommodation themes existent in the system.
The AccThemes response message offers information about the all themes: id, code, name, moment when they were
added or edited last time.
Message Pair Elements and Attributes
AIDA_AccThemesRQ
The request is made for all accommodation themes in the system. The message is very simple, because no data is required
(except the auth data).
Message Structure
Element
Type
Occurs
Description
No data required
AccThemesRQ XML Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader Lang="?">
<ns:Username>dcstravel</ns:Username>
<ns:Password> dcstravel </ns:Password>
<!--You have a CHOICE of the next 2 items at this level-->
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_AccThemesRQ/>
</soapenv:Body>
</soapenv:Envelope>
Page | 65
AIDA_AccThemesRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccomodationThemesList
SEQUENCE
Theme
Attribute
ID
Code
Name
AddTime
LastUpdateTime
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
anyType (restriction)
0..*
Type
positiveInteger
string
string
positiveInteger
positiveInteger
Mandatory
Yes
Yes
Yes
Yes
Yes
Description
Unique identifier of the theme
The code of the theme
The theme name
Moment when theme was added
Moment when theme was last edited
Page | 66
AccSearch
Message Pair Overview
The AccSearch request message performs a search of all accommodation units within a period of time. It can also make
use of various filters that help narrow down the list of results.
The AccSearch response message offers full details about the accommodation units found. These details include
information about the unit, its rooms, price and also availability.
Message Pair Elements and Attributes
AIDA_AccSearchRQ
Mandatory information to send in this message:
-
Date interval of the search (the <DateRange> element; only the start and end date must be provided)
Destination (the citys internal ID must be provided; currently, a search by city name is not supported)
At least one room request
In the description of the room request, the desired structure of the room must be detailed. This is done using the
<GuestCount> element. The passenger types that can be provided in this structure and message are:
-
A room multiplier can be selected using the <Room>s attribute Count. Using this multiplier is mandatory if more than one
from the same room are desired. Different room requests must include different room structures. Otherwise, an error is
issued in this respect.
Other possible filters to use with this message are:
-
Unit name
Unit type (please see the list of codes for accommodation types)
The number of stars of the unit
A flag can also be sent to indicate whether the results should include accommodation units available in request or
not (by default, the request services are not included in the results list)
Message Structure
Element
Type
Occurs
SEQUENCE
SearchCriteria
anyType (restriction)
1..1
Attribute
ShowRequest
Type
boolean
SEQUENCE
DateRange
Complex Type:
Description
1..1
Complex Type:
CityType
anyType (restriction)
1..1
1..1
Attribute
Name
Type
Type
string
string
Mandatory
Description
No
Possibility to filter by unit name
No
Possibility to filter by unit type (please see list type
AccTypes for a list of possible values)
SEQUENCE
Stars
anyType (restriction)
0..1
Destination
SEQUENCE
City
Unit
Attribute
MaxStars
SEQUENCE
Star
Rooms
SEQUENCE
Room
Attribute
IndexNumber
Count
SEQUENCE
GuestsCount
DateTimeRangeType
anyType (restriction)
Type
SimpleType:
ServiceStarsType
SimpleType:
ServiceStarsType
anyType (restriction)
0..5
1..1
anyType (restriction)
Type
positiveInteger
1..3
Describes a single room request and its occupancy
Mandatory
Description
Yes
A number that identifies a single room request. It
must be unique per room request.
Yes
Numeric multiplier of current room.
positiveInteger
Complex Type:
GuestsCountType
1..1
Page | 68
/>
AIDA_AccSearchRS
The AccSearch method response searches for available accommodation rooms and returns their details, along with
information about their prices and availability statuses.
Accommodation services can have secondary services as subservices. In the AccSearch response, these are included within
the <ExtraServices> element. The subservices can be either optional (the client can chose to purchase the subservice or
not) or mandatory (the client must purchase the subservice). This property is expressed by the <Mandatory> attribute of
the <ExtraService> element.
As opposed to the accommodation rooms, for which prices and availability are offered in this step, the subservices need
extra configuration and their availability status & prices can be obtained by calling the AccAvail method.
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccUnits
SEQUENCE
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Page | 69
anyType (restriction)
Attribute
ID
Name
Stars
Type
positiveInteger
string
SimpleType:
ServiceStarsType
SEQUENCE
Type
0..*
Complex Type:
ServiceType
1..1
Destination
Complex Type:
LocalizationType
1..1
RoomStays
anyType (restriction)
1..1
anyType (restriction)
1..*
SEQUENCE
RoomStay
Attribute
IndexNumber
SEQUENCE
Service
Attribute
ID
Name
SEQUENCE
Supplier
Attribute
ID
Name
Rooms
SEQUENCE
Room
ExtraServices
SEQUENCE
ExtraService
Attribute
Mandatory
Type
positiveInteger
anyType (restriction)
Type
positiveInteger
string
1..*
Describes the service that the rooms belong to
Mandatory
Description
Yes
Unique numeric identifier of the service
Yes
The name of the service
anyType (restriction)
Type
positiveInteger
0..1
Identifies the real supplier of the offers
Mandatory
Description
Yes
Unique numerical identifier of the supplier
in AIDA
Yes
Describes the name of the supplier
1..1
Collection of rooms found for a specific request
string
anyType (restriction)
Element_Room_AccS
earchRS
anyType (restriction)
1..*
0..1
ExtendedComplex
Type:
SecondaryServiceCo
mponentType
with the attribute
below
Type
boolean
1..*
Mand
Yes
Description
Indicates if this service is mandatory or
optional to purchase with this room
Page | 70
Type
Occurs
Attribute
ID
Type
positiveInteger
Mandatory
Yes
Count
SEQUENCE
RoomType
positiveInteger
Yes
Complex Type:
RoomElementType
Complex Type:
FeatureElementType
Complex Type:
OccupancyElementType
string (extension)
Type
Simple Type:
AvailableStsType
positiveInteger
1..1
Feature
Occupancy
Availability
Attribute
Status
MinAvailable
Price
Rates
SEQUENCE
Rate
Attribute
RateId
RateName
RateTypeId
RateTypeName
SEQUENCE
Price
Description
ExtraServicesRef
SEQUENCE
ExtraServiceRef
Attribute
ID
Complex Type:
PriceType
anyType (restriction)
Description
Description
A string construct that uniquely identifies the
current room
Identifies the numeric quantity of the room
anyType (restriction)
1..*
Type
positiveInteger
string
integer
string
Mandatory
Yes
No
No
No
Complex Type:
PriceType
string
anyType (restriction)
1..1
0..1
0..1
anyType (restriction)
1..*
Type
positiveInteger
Description
Specifies the rate id
Specifies the rate name
Specifies the rate type id
Specifies the rate type name
Page | 71
Page | 72
AccAvail
Message Pair Overview
The AccAvail request messageenquires about the availability of a single accommodation unit and its respective subervices.
The AccAvail response message offers details about the requested unit, along with price and availability information. The
message also includes the cancellation policies for the selected rooms and extra services.
Message Pair Elements and Attributes
AIDA_AccAvailRQ
Message Structure
Element
Type
Occurs
Description
SEQUENCE
SearchCriteria
anyType (restriction)
1..1
Complex Type:
DateTimeRangeType
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
anyType (restrictions)
1..1
Attribute
Type
Mandatory
RateId
SEQUENCE
Room
Attribute
ID
Count
integer
No
anyType (restriction)
Type
string
positiveInteger
1..*
Mandatory
Yes
Yes
anyType (restriction)
0..1
anyType (restriction)
1..*
Type
string
date
Mandatory
Yes
Yes
SEQUENCE
DateRange
AccUnit
Attribute
ID
SEQUENCE
Rooms
SEQUENCE
ExtraServices
SEQUENCE
ExtraService
Attribute
ID
DateStart
1..1
Page | 73
date
integer
Yes
No
anyType (restriction)
1..1
anyType (restriction)
1..*
Attribute
AgeQualifyingCode
Type
Simple Type:
AgeQualifyingCodeType
Mandatory
Yes
Count
positiveInteger
Yes
Age
positiveInteger
Yes
Page | 74
AIDA_AccAvailRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccUnit
Attribute
ID
Name
Stars
SEQUENCE
Type
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Type
positiveInteger
string
SimpleType:
ServiceStarsType
Complex Type:
ServiceType
1..1
Destination
Complex Type:
LocalizationType
1..1
Availability
string (extension)
Attribute
Status
Rooms
Attribute
RateId
SEQUENCE
Room
Type
Simple Type:
AvailableStsType
anyType (restriction)
Type
integer
anyType (restriction)
Attribute
ID
Type
string
Count
SEQUENCE
RoomType
positiveInteger
Feature
Occupancy
Complex Type:
RoomElementType
Complex Type:
FeatureElementType
Complex Type:
OccupancyElementTy
pe
Description
Specifies the rate id
1..*
ExtraServices
SEQUENCE
ExtraService
Attribute
DateStart
DateEnd
Mandatory
SEQUENCE
Service
string (extension)
Type
Simple Type:
AvailableStsType
Complex Type:
PriceType
Complex Type:
CancelPenaltiesType
anyType (restriction)
anyType (restriction)
1..1
Describes the availability status of the room
Mandatory
Description
Yes
Describes a code that indicates the
availability of the room
1..1
Includes price information about the room. This
also includes the extra services prices.
0..1
Collection of cancel penalties specific of the
room. This also includes the extra services
penalties.
0..1
Collection of extra services that availability is
requested for
1..*
Type
date
date
integer
anyType (restriction)
1..1
SEQUENCE
string
0..1
Text representing service description
Attribute
Type
Mandatory
Description
ID
positiveInteger
Yes
Unique numerical identifier of the service
GuestsCount
anyType (restriction) 1..1
Collection of guests count
SEQUENCE
GuestCount
anyType (restriction) 1..* Information that identifies a guest
Attribute
Type
Mandatory Description
AgeQualifying Simple Type:
Yes
Reference to a specific passenger type
Code
AgeQualifyingCodeTy
based on a person's age
pe
Count
positiveInteger
Yes
Determines the number of the guests of
the type identified by
AgeQualifyingCode
Age
positiveInteger
Yes
Determines the age of the guest
Description
Price
Complex Type:
PriceType
0..1
Rates
anyType (restriction)
0..1
Type
integer
Mandatory
No
Attribute
SelectedRate
SEQUENCE
Rate
Attribute
RateId
RateName
anyType (restriction)
1..*
Type
integer
string
Mandatory
Yes
No
Description
Specifies the rate id
Specifies the rate name
SEQUENCE
Page | 76
Complex Type:
PriceType
Complex Type:
CancelPenaltiesType
0..1
0..1
Page | 77
Page | 78
AccBook
Message Pair Overview
The AccBook request message describes the intent to perform a reservation on a specific accommodation unit and its
linked subservices.
The AccBook response message offers details about the success of the booking process and includes some information
regarding the newly created reservation.
Message Pair Elements and Attributes
AIDA_AccBookRQ
MessageStructure
Element
Type
Occurs
Description
SEQUENCE
AdditionalResellerInfo
anyType(restriction)
0..1
Attribute
OutsiderUsername
OutsiderCode
SearchCriteria
Type
string
string
anyType (restriction)
Mandatory
Yes
Yes
1..1
Complex Type:
DateTimeRangeType
anyType (restriction)
1..1
Type
positiveInteger
Mandatory
Yes
anyType (restrictions)
1..1
anyType (restriction)
Type
string
positiveInteger
1..*
Mandatory
Yes
Yes
anyType (restriction)
1..*
Type
positiveInteger
Mandatory
Yes
SEQUENCE
DateRange
AccUnit
Attribute
ID
SEQUENCE
Rooms
SEQUENCE
Room
Attribute
ID
Count
SEQUENCE
Customers
Attribute
RoomIndex
1..1
SEQUENCE
Page | 79
anyType (restriction)
1..*
Type
positiveInteger
String
Mandatory
Yes
Yes
anyType (restriction)
0..1
anyType (restriction)
1..*
Attribute
Type
Mandatory
ID
string
Yes
DateStart
date
Yes
DateEnd
date
Yes
RateId
integer
No
anyType (restriction)
1..1
anyType (restriction)
Type
Simple Type:
AgeQualifyingCodeType
1..*
Mandatory
Yes
positiveInteger
Yes
anyType (restrictions)
1..1
anyType (restriction)
1..*
Type
positiveInteger
Mandatory
Yes
anyType (restriction)
1..1
Complex Type:
CustomerElementType
anyType (restriction)
1..*
SEQUENCE
Comments
string
0..1
Remarks
string
0..1
Attribute
CustomerIndex
AgeSegment
ExtraServices
SEQUENCE
ExtraService
SEQUENCE
GuestsCount
SEQUENCE
GuestCount
Attribute
AgeQualifyingCode
Count
Customers
SEQUENCE
Customer
Attribute
CustomerIndex
Customers
SEQUENCE
Customer
GlobalInfo
0..1
Page | 81
AIDA_AccBookRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
BookingReference
Attribute
BookActionSts
SEQUENCE
CHOICE
Reservation
ReservationList
SEQUENCE
Reservation
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Type
string
Complex Type:
ReservationDataType
1..1
anyType (restriction)
1..1
Complex Type:
ReservationDataType
1..*
Page | 82
Transfer Search
Message Pair Overview
The TransferSearch request message performs a search of all transfer services that are available at a specified moment
and have segments with certain data.
The TransferSearch method response searches for available transfer services and returns their details, grouped by
segments, along with information about their prices and availability statuses.
Message Pair Elements and Attributes
AIDA_TransferSearchRQ
Message Structure
Element
Type
Occurs
Description
anyType (restriction)
1..1
anyType (restriction)
1..1
anyType (restriction)
Type
positiveInteger
1..1
Identifies the city
Mandatory
Description
Yes
Unique numerical identifier of the city
anyType (restriction)
Type
Simple Type:
TransferLocationType
anyType (restriction)
1..1
Identifies the location type
Mandatory
Description
Yes
Location type
anyType (restriction)
Type
positiveInteger
1..1
Identifies the city
Mandatory
Description
Yes
Unique numerical identifier of the city
1..1
Identifies the location type
Mandatory
Description
Yes
Location type
Departure
anyType (restriction)
Type
Simple Type:
TransferLocationType
anyType (restriction)
Attribute
Date
Time
PaxNumber
LuggageNumber
Type
date
time
positiveInteger
positiveInteger
Mandatory
Description
Yes
Identifies the departure date
Yes
Identifies the departure time
1..1
Identifies the number of passengers
1..1
Identifies the number of luggage
SEQUENCE
Filters
SEQUENCE
PickUp
SEQUENCE
City
Attribute
ID
SEQUENCE
Location
Attribute
Type
DropOff
SEQUENCE
City
Attribute
ID
SEQUENCE
Location
Attribute
Type
1..1
1..1
Page | 83
Page | 84
AIDA_TransferSearchRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Transfers
SEQUENCE
Transfer
Attribute
ID
Name
Type
SEQUENCE
PickUp
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
0..1
anyType (restriction)
0..*
Type
string
String
String
1..1
Description
Complex Type:
TransferSegmentPart
Type
Complex Type:
TransferSegmentPart
Type
String
0..1
Durations
anyType (restriction)
1..1
SEQUENCE
TransferDuration
positiveInteger
1..1
WaitingDuration
positiveInteger
1..1
anyType (restriction)
1..*
Complex Type:
TransferVehicleType
1..*
Dropff
Vehicles
SEQUENCE
Vehicle
Page | 85
Page | 86
TransferBook
Message Pair Overview
The TransferBook request message describes the intent to perform a reservation segment from a specific transfer service.
The TransferBook response message offers details about the success of the booking process and includes some
information regarding the newly created reservation.
Message Pair Elements and Attributes
AIDA_TransferBookRQ
MessageStructure
Element
Type
Occurs
Description
SEQUENCE
Transfer
anyType (restriction)
1..1
Type
string
Mandatory
Yes
Attribute
ID
Description
The ID of the transfer (specified in the
search response)
SEQUENCE
PickUpLocationDetails
Complex Type:
BookTransferTypeDetai
lsType
string
DropOffLocationDetails
string
0..1
DropOffLocationTypeDetails
Complex Type:
BookTransferTypeDetai
lsType
anyType (restrictions)
0..1
PickUpLocationTypeDetails
Vehicle
0..1
0..1
anyType (restriction)
Attribute
LuggageNumber
Type
positiveInteger
Mandatory
Yes
PaxNumber
positiveInteger
Yes
SEQUENCE
Departure
anyType (restrictions)
1..1
Attribute
Code
TravelInfo
Type
string
1..1
Description
The number of booked luggage storage
space
Total number of passengers (including
reservation owner and specific pax sent)
Type
date
time
anyType (restriction)
Mandatory
Description
Yes
The departure date
Yes
The departure time
1..1
List of customers included in the book
Complex Type:
CustomerElementType
anyType (restriction)
1..*
SEQUENCE
Comments
string
0..1
Remarks
string
0..1
SEQUENCE
Customer
GlobalInfo
0..1
AIDA_TransferBookRS
Message Structure
Element
Type
Occurs
Description
CHOICE
Errors
SEQUENCE
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
Complex Type:
ReservationDataType
1..1
RESERVATION MESSAGES
ReservationDetails
Message Pair Overview
The Reservation Details request message requests all information regarding a previously made reservation.
The Reservation Details response message offers full details regarding a previously made reservation: services, passengers,
associations, price information and global details.
Message Pair Elements and Attributes
AIDA_ReservationDetailsRQ
The details are requested based on the <ID> of the reservation.
Message Structure
Element
Type
Occurs
SEQUENCE
Reservation
anyType (restriction)
1..1
Attribute
ID
Type
BigIntID
Description
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_ReservationDetailsRQ>
<ns:Reservation ID="1360000044"/>
</ns:AIDA_ReservationDetailsRQ>
</soapenv:Body>
</soapenv:Envelope>
Page | 89
AIDA_ReservationDetailsRS
A complete list with the reservation elements is offered. The association between services and customers, which was
before done through <CustomerIndex>, is now performed using the customer ids (<ResCustomerID>).
The service prices offered within the <ConfigurationData>element are dynamic. They do not represent the issue price, but
the current value of the service. Therefore, if the reservation is cancelled, the service price will be 0 or the value of the
cancellation penalty applied.
Message Structure
Element
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
anyType (restriction)
1..1
0..1
anyType (restriction)
0..1
Attribute
ID
Type
positiveInteger
Mandatory
Yes
Type
Simple Type:
PackageType
string
Yes
string
string
Complex Type:
ResServiceType
No
No
0..1
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
ReservationDetails
SEQUENCE
Components
SEQUENCE
PackageComponent
SEQUENCE
Package
Code
Name
Category
ResService
No
Description
Internal unique identifier for a specific
package
Identifies the package type
CancelPenalties
Complex Type:
CancelPenaltiesType
Extended
Complex Type:
TourServiceCompone
ntType
0..1
AccommodationComponent
Extended Complex
Type:
AccommodationCom
ponentType
0..*
TransportationComponent
Extended Complex
Type:
TransportationComp
onentType
Extended Complex
Type:
SecondaryServiceCo
mponentType
0..*
TourServiceComponent
SecondaryServiceComponent
TransferServiceComponent
SEQUENCE
Service
Attribute
ID
Name
SEQUENCE
Description
ResService
Customers
SEQUENCE
Customer
0..1
0..*
0..*
anyType (restriction)
1..1
Type
positiveInteger
String
Mandatory
Yes
Yes
String
0..1
Complex Type:
TransferResServiceTy
pe
1..1
anyType (restriction)
1..1
Complex Type:
CustomerElementTyp
e
1..*
Description
Unique identifier of the transfer
Name which describes the current
transfer
Page | 91
Complex Type:
ReservationDataType
1..1
Page | 92
[]
Page | 93
[]
<ns1:TransportationComponent>
<ns1:Service ID="406" Name="Bucuresti - Atena">
<ns1:Type Code="c">Charter</ns1:Type>
</ns1:Service>
<ns1:ConfigurationData>
<ns1:ServiceEntries>
<ns1:ServiceEntry ID="1370000018_1370000053">
<ns1:ItinerarySegment>
<ns1:Departure Date="2011-05-10" Time="07:00">
<ns1:City ID="3" Name="Bucharest"/>
</ns1:Departure>
<ns1:Arrival Date="2011-05-10" Time="10:42">
<ns1:City ID="41" Name="Atena"/>
</ns1:Arrival>
</ns1:ItinerarySegment>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:Price Ammount="699.20" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="440.00"/>
<ns1:Commission Ammount="79.20"/>
<ns1:Tax Ammount="180.00"/>
</ns1:Price>
</ns1:ConfigurationData>
<ns1:ResService ID="1360000098" Status="OK">
<ns1:Price Ammount="699.20" CurrencyCode="EUR"/>
</ns1:ResService>
</ns1:TransportationComponent>
<ns1:SecondaryServiceComponent>
<ns1:Service ID="408" Name="Supliment demipensiune Airstoteles" DurationTimeUnit="night">
<ns1:Type Code="m">Masa pe perioada</ns1:Type>
</ns1:Service>
<ns1:ConfigurationData>
<ns1:ServiceEntries>
<ns1:ServiceEntry ID="2011-05-07_3">
<ns1:DateRange DateStart="2011-05-07" DateEnd="2011-05-10"/>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:Price Ammount="174.00" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="150.00"/>
<ns1:Commission Ammount="24.00"/>
<ns1:Tax Ammount="0.00"/>
</ns1:Price>
<ns1:GuestsCount>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:GuestsCount>
</ns1:ConfigurationData>
<ns1:Customers>
<ns1:Customer ResCustomerID="1360000194"/>
<ns1:Customer ResCustomerID="1360000195"/>
</ns1:Customers>
<ns1:ResService ID="1360000099" Status="OK">
<ns1:Price Ammount="174.00" CurrencyCode="EUR"/>
</ns1:ResService>
</ns1:SecondaryServiceComponent>
</ns1:Components>
<ns1:Customers>
<ns1:Customer ResCustomerID="1360000194" CustomerIndex="1" CustomerType="Passenger" Owner="true">
<ns1:PersonName>
<ns1:FirstName>ION</ns1:FirstName>
<ns1:LastName>DAMIAN</ns1:LastName>
</ns1:PersonName>
</ns1:Customer>
<ns1:Customer ResCustomerID="1360000195" CustomerIndex="2" CustomerType="Passenger" Owner="false">
<ns1:PersonName>
<ns1:FirstName>ANDREEA</ns1:FirstName>
<ns1:LastName>DAMIAN</ns1:LastName>
</ns1:PersonName>
</ns1:Customer>
</ns1:Customers>
<ns1:Reservation ID="1360000044" Code="MHPIR0" Status="OK">
<ns1:Price Ammount="1536.08" CurrencyCode="EUR"/>
</ns1:Reservation>
</ns1:ReservationDetails>
</ns1:AIDA_ReservationDetailsRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Page | 94
ReservationCancel
Message Pair Overview
The Reservation Cancel request message requests the server to perform a cancellation of the element identified by the
reservation <ID>. It can also request just the details of a future cancellation by expressing the intent to cancel the element.
The Reservation Cancel response message process the request and either offers the details of a cancellation (cancel
penalties, other consequences etc) or actually performs a cancellation of the specified element.
Message Pair Elements and Attributes
AIDA_ReservationCancelRQ
The Reservation Cancel request message makes use of the <CancelType>attribute which identifies the cancellation type.
This attribute can acquire 2 values:
-
Initiate: the requestor expresses only its intention to cancel the reservation. In this case, AIDA returns the
conditions of this process (the current status of the reservation, the cancel penalties that apply for this operation
etc)
Cancel: the requestor expresses a firm wish to cancel the reservation. In this case, AIDA performs the cancellation
and returns the details of this operation (new status of the reservation, the cancel penalties that were applied
etc).
The requestor can use the Cancelvalue of <CancelType>right from the start, without requesting the cancel conditions with
Initiate beforehand.
Message Structure
Attribute
CancelType
SEQUENCE
Reservation
Remarks
Type
string (restriction)
can be:
Initiate
Cancel
Mandatory
Yes
Complex Type:
ReservationDataType
string
1..1
0..1
Description
Specifies the type of action requested when
more than one function could be handled by
the message
Page | 95
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_ReservationCancelRQ CancelType="Initiate">
<ns:Reservation ID="1360000038"/>
</ns:AIDA_ReservationCancelRQ>
</soapenv:Body>
</soapenv:Envelope>
AIDA_ReservationCancelRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Reservation
CancelPenalties
SEQUENCE
Penalty
Attribute
Ammount
CurrencyCode
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
Complex Type:
ReservationDataType
anyType (restriction)
1..1
1..1
0..1
1..1
0..1
anyType (restriction)
1..*
Type
decimal
CurrencyCodeTypes
Page | 96
ReservationRemarksList
Message Pair Overview
The ReservationRemarksList request message asks the server to provide a list with all the remarks on a given reservation,
identified by a unique <ID>.
The ReservationRemarksList response message processes the request and lists the remarks, if any exist on that specific
reservation.
Message Pair Elements and Attributes
AIDA_ReservationRemarksListRQ
Message Structure
SEQUENCE
Reservation
Attribute
ID
anyType (restriction)
1..1
Type
BigIntID
Mandatory
Yes
Page | 97
AIDA_ReservationRemarksListRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
RemarksList
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
Complex Type:
RemarksListType
1..1
1..1
0..1
1..1
ReservationRemarksListRS Sample
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://aida.dcsplus.net/ws/2010">
<SOAP-ENV:Body>
<ns1:AIDA_ReservationRemarksListRS TimeStamp="2013-04-25T10:22:05+03:00" Version="1.0" RequestHost="192.168.1.121">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="14" Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:User Username="dcstravel">Frincu Mirela</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success>true</ns1:Success>
<ns1:RemarksList>
<ns1:Reservation ID="1600000116"/>
<ns1:Remarks>
<ns1:Remark AddTime="2013-04-25T10:21:11" ReadByUser="">
<ns1:Sender Type="tourOperator" Name="Campan Mirela"/>
<ns1:RemarkText>am confirmat la hotel</ns1:RemarkText>
</ns1:Remark>
<ns1:Remark AddTime="2013-04-24T17:03:43" ReadByUser="">
<ns1:Sender Type="reseller" Name="Cazacu Catalin"/>
<ns1:RemarkText>posibil late checkin</ns1:RemarkText>
</ns1:Remark>
</ns1:Remarks>
</ns1:RemarksList>
</ns1:AIDA_ReservationRemarksListRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</SOAP-ENV:Envelope>
Page | 98
ReservationRemarkAdd
Message Pair Overview
The ReservationRemarkAdd request message asks the server to save a new text on a given reservation.
The ReservationRemarkAdd response message processes the request, saves the new remark and in return lists all the
remarks on the requested reservation.
Message Pair Elements and Attributes
AIDA_ReservationRemarkAddRQ
Message Structure
SEQUENCE
Reservation
Attribute
ID
SEQUENCE
Sender
RemarkText
anyType (restriction)
1..1
Type
BigIntID
Mandatory
Yes
ComplexType:
SenderType
0..1
string
1..1
ReservationRemarksAddRQ Sample
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns="http://aida.dcsplus.net/ws/2010">
<soapenv:Header>
<ns:AuthHeader>
<ns:Username>test</ns:Username>
<ns:Password>test</ns:Password>
<ns:ResellerCode>ROT</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_ReservationRemarkAddRQ>
<ns:Reservation ID="1600000116"/>
<ns:Sender Type="reseller" Name="Mirela Campan" />
<ns:RemarkText>am acordat promotie de honeymooners</ns:RemarkText>
</ns:AIDA_ReservationRemarkAddRQ>
</soapenv:Body>
</soapenv:Envelope>
Page | 99
AIDA_ReservationRemarkAddRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
RemarksList
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
Complex Type:
RemarksListType
1..1
1..1
0..1
1..1
ReservationRemarksListRS Sample
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://aida.dcsplus.net/ws/2010">
<SOAP-ENV:Body>
<ns1:AIDA_ReservationRemarkAddRS TimeStamp="2013-04-25T10:37:29+03:00" Version="1.0"
RequestHost="192.168.1.121">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="test">Campan Mirela</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success>true</ns1:Success>
<ns1:RemarksList>
<ns1:Reservation ID="1600000116"/>
<ns1:Remarks>
<ns1:Remark AddTime="2013-04-25T10:37:28" ReadByUser="">
<ns1:Sender Type="reseller" Name="Cazacu Catalin"/>
<ns1:RemarkText>am acordat promotie de honeymooners</ns1:RemarkText>
</ns1:Remark>
<ns1:Remark AddTime="2013-04-25T10:21:11" ReadByUser="">
<ns1:Sender Type="tourOperator" Name="Campan Mirela"/>
<ns1:RemarkText>am confirmat la hotel</ns1:RemarkText>
</ns1:Remark>
<ns1:Remark AddTime="2013-04-24T17:03:43" ReadByUser="Campan Mirela">
<ns1:Sender Type="reseller" Name="Cazacu Catalin"/>
<ns1:RemarkText>posibil late checkin</ns1:RemarkText>
</ns1:Remark>
</ns1:Remarks>
</ns1:RemarksList>
</ns1:AIDA_ReservationRemarkAddRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Page | 100
DOCUMENT MESSAGES
The document messages allow the transfer of travel documents through AIDA web service. Every document has an entity
that it describes, such as: reservation, reservation service etc. The documents list available for such an entity is the first
step in getting documents from AIDA. After receiving the list, the documents can be retrieved one by one using the
DocumentGetmethod.
DocumentsList
Message Pair Overview
The Documents List request message offers a way to inquire AIDA about the available documents regarding a specific
object.
The Documents List response message responds with a list of documents, each described by an ID and a title, in order to
allow the external system to build a document menu.
Message Pair Elements and Attributes
AIDA_DocumentsListRQ
Message Structure
Element
Type
Occurs
SEQUENCE
DocumentObject
anyType (restriction)
1..1
Type
SimpleType:
DocumentObjectType
String
string
Yes
Yes
Attribute
Type
Title
ID
Description
Page | 101
AIDA_DocumentsListRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Documents
SEQUENCE
Document
Attribute
ID
Type
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
1..1
1..1
0..1
1..1
anyType (restriction)
Type
string
SimpleType:
DocumentType
0..*
Identifies a single document in the list
Mandatory
Description
Yes
Unique identifier of the document
Yes
The name of the list element
Page | 102
DocumentGet
Message Pair Overview
The DocumentGet method is used to retrieve the actual content of a specific document.
Message Pair Elements and Attributes
AIDA_DocumentGetRQ
Message Structure
Element
Type
Occurs
SEQUENCE
Document
anyType (restriction)
1..1
Attribute
ID
Type
Type
string
SimpleType:
DocumentType
Description
AIDA_DocumentGetRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
1..1
1..1
WarningsType
base64Binary
(extension)
Type
string
0..1
1..1
Yes
Title
FileName
SimpleType:
DocumentType
string
string
FileSize
string
Yes
Attribute
ID
Type
Mandatory
Yes
No
Yes
Description
Indicates the unique identifier of this
document.
Identifies the document type.
Describes a title for the document.
Indicates the complete name (with
extension) of the document file.
Indicates the file size in bytes of the
document.
Page | 104
TOOLS MESSAGES
CodesList
Message Pair Overview
The Codes List messages offer a way to export the data from AIDA that rarely or never changes. These are usually
configurations and list of codes.
Message Pair Elements and Attributes
AIDA_CodesListRQ
Message Structure
Element
Type
Occurs
Description
SEQUENCE
List
anyType (restriction)
1..*
Type
Simple Type:
CodesListType
Mandatory
Yes
Attribute
Type
Description
The code of the list itself
Page | 105
AIDA_CodesListRQ
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
List
Attribute
Type
Name
SEQUENCE
ListItem
Attribute
ID
Name
Type
Occurs
Description
ErrorsType
1..1
POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
Type
Simple Type:
CodesListType
string
1..1
1..1
0..1
1..*
Mand
Yes
Yes
anyType (restriction)
Type
string
string
1..*
Identifies a single element in the list
Mandatory
Description
Yes
Unique identifier of the list element
Yes
The name of the list element
Page | 106
COMPLEX TYPES
Complex Type: CountryType
Description
Information that identifies a country.
Attributes
Attribute
Type
Required
Description
ID
Name
ISO2
Latitude
Longitude
positiveInteger
string
ISO2Code
StringLength1to16
StringLength1to16
No
No
No
No
No
Page | 107
Type
Required
Description
ID
Name
CountryID
Latitude
Longitude
positiveInteger
string
positiveInteger
StringLength1to16
StringLength1to16
No
No
No
No
No
Page | 108
Type
Required
Description
ID
Name
ISO3
CountryID
RegionID
Latitude
Longitude
positiveInteger
string
ISO3Code
positiveInteger
positiveInteger
StringLength1to16
StringLength1to16
No
No
No
No
No
No
No
Page | 109
Type
Required
Description
ID
Name
CityID
Type
positiveInteger
string
positiveInteger
string
No
No
No
No
Latitude
Longitude
StringLength1to16
StringLength1to16
No
No
Page | 110
Type
Required
DateStart
TimeStart
DateEnd
TimeEnd
Duration
date
time
date
time
string
No
No
No
No
No
Description
Page | 111
Type
Occurs
Description
Complex Type:
CityType
Complex Type:
CountryType
Complex Type:
RegionType
Complex Type:
LocationType
string
1..1
1..1
0..1
0..1
0..1
Page | 112
Type
Required
Description
Date
date
No
Time
time
No
Place
string
No
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
City
Country
Location
1..1
1..1
0..1
Page | 113
Type
Occurs
Count
anyType (restriction)
Type
Simple Type:
AgeQualifyingCodeType
positiveInteger
MinAge
nonNegativeInteger
0..*
Information that identifies a guest
Mandatory
Description
No
Reference to a specific passenger type based on
a person's age
No
Determines the number of the guests of the type
identified by AgeQualifyingCode
No
Determines the minimum age of the guest count.
MaxAge
nonNegativeInteger
No
Age
nonNegativeInteger
No
SEQUENCE
GuestCount
Attribute
AgeQualifyingCode
Description
Page | 114
Type
Required
Description
Code
string
No
Page | 115
Type
Required
Description
Code
RoomTypeCodes
Yes
AIDA internal code that identifies a single room type. Ex: DBL,
TWN etc (see Codes List Type AccRoomTypes).
Page | 116
Type
Required
Description
ID
positiveInteger
Yes
Page | 117
Type
Required
Description
ID
positiveInteger
Yes
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
GuestCount
anyType (restriction)
0..*
For the complete structure of the GuestCount element, see Complex Type: GuestsCountType
Page | 118
Type
Required
IndexNumber
positiveInteger
No
Description
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
Rooms
anyType (restriction)
1..1
Collection of rooms
anyType (restriction)
Type
string
positiveInteger
1..*
Mandatory
Yes
No
Complex Type:
RoomElementType
Complex Type:
FeatureElementType
Complex Type:
OccupancyElementType
0..1
anyType (restriction)
0..1
Complex Type:
CustomerElementType
1..*
SEQUENCE
Room
Attribute
ID
Count
SEQUENCE
RoomType
Feature
Occupancy
Customers
SEQUENCE
Customer
0..1
0..1
Description
Unique identifier for the room
Specifies how many rooms of this type are to be
purchased
Page | 119
Type
Required
Description
Ammount
CurrencyCode
decimal
CurrencyCodeType
Yes
Yes
Quantity
positiveInteger
No
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
SupplierPrice
Commission
Tax
Type
Occurs
Description
Complex Type:
PriceComponent
Complex Type:
PriceComponent
Complex Type:
PriceComponent
0..1
0..1
0..1
Page | 120
Type
Required
Description
Ammount
decimal
Yes
Page | 121
Attribute
Type
Required
Description
Code
string
Yes
Page | 122
Type
Occurs
Description
Complex Type:
CancelPenaltyType
1..*
Page | 123
Type
Required
Description
Start
date
Yes
Ammount
decimal
Yes
CurrencyCode
CurrencyCodeType
Yes
Page | 124
Type
Required
Description
ResCustomerID
BigIntID
No
CustomerIndex
positiveInteger
No
CustomerType
string
No
Owner
boolean
No
BirthDate
date
No
AgeQualifyingCode
No
Gender
PNC
Simple Type:
AgeQualifyingCodeType
string
string
Nationality
Telephone
Fax
Email
string
string
string
string
No
No
No
No
No
No
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
SEQUENCE
PersonName
PersonNameType
0..1
Attribute
NamePrefix
SEQUENCE
FirstName
LastName
MiddleName
IdentificationCard
Attribute
Series
Type
string
string
string
String
IDCardType
Type
string
Description
positiveInteger
string
ReleaseDate
Passport
date
PassportType
Attribute
Number
ExpireDate
Address
Country
City
Type
string
date
string
string
string
No
No
Page | 126
Type
Required
Description
ID
Name
Stars
string
string
SimpleType:
ServiceStarsType
Yes
No
No
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Type
Supplier
Type
Occurs
Description
Complex Type:
ServiceType
0..1
anyType (restriction)
0..1
Page | 127
Type
Required
Description
MultipleEntries
boolean
No
FlexibleEntryPeriod
boolean
No
If value is true, then only one entry from the list must be
selected. If value is false, all entries must be selected. For
tour transportation, this value will always be false,
because only one departure (entry) can be selected).
If the value is true, the period entered in DateRange
element can be shortened, but not expanded. For tour
transportation this element will always be false, because
tour transportation doesn't have DateRange element.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
ServiceEntry
Attribute
ID
CHOICE
Date
DateRange
Departure
ItinerarySegment
SEQUENCE
Departure
Arrival
Type
Occurs
ServiceEntryType
(defined below)
0..*
Type
string
Description
date
Complex Type:
DateTimeRangeType
Complex Type:
ItinerarySegmentLocationType
ItinerarySegmentType
(defined below)
1..1
1..1
1..1
Complex Type:
ItinerarySegmentLocationType
Complex Type:
ItinerarySegmentLocationType
1..1
1..1
1..1
Page | 128
SEQUENCE
Segment
Availability
Attribute
Status
Price
Type
Occurs
Description
Complex Type:
ServiceEntriesType
anyType (restriction)
1..1
0..1
Complex Type:
ItinerarySegmentLocationType
anyType (restriction)
1..*
0..1
Attribute
Simple Type: AvailableStsType
0..1
Page | 129
Type
Occurs
Description
Complex Type:
GuestsCountType
Complex Type:
GuestsCountType
0..1
0..1
Page | 130
Type
Occurs
Description
Complex Type:
ServiceElementType
Complex Type:
ServiceEntriesType
Complex Type:
ConfigurationDataType
1..1
0..1
0..1
Page | 131
SEQUENCE
Unit
Attribute
ID
Type
Occurs
Description
Extending
Complex Type:
ServiceElementType
with the elements
defined below
1..1
anyType (restriction)
0..1
Type
positiveInteger
Category
string (extension)
Attribute
Code
Telephone
E-mail
Localization
Type
string
string
string
Complex Type:
LocalizationType
Complex Type:
ServiceEntriesType
anyType (restriction)
ServiceEntries
RoomStays
SEQUENCE
RoomStay
ConfigurationData
SEQUENCE
RoomStays
Complex Type:
RoomStayType
1..*
Extending
Complex Type:
ConfigurationDataType
with the <RoomStays>
element defined below
0..1
anyType (restriction)
0..1
SEQUENCE
Page | 132
Complex Type:
RoomStayType
1..*
Page | 133
Type
Occurs
Description
Complex Type:
ServiceElementType
Complex Type:
ServiceEntriesType
Complex Type:
ConfigurationDataType
1..1
0..1
0..1
Page | 134
Attribute
DurationTimeUnit
SEQUENCE
Localization
ServiceEntries
GuestsCount
BookingRules
SEQUENCE
BookingRule
ConfigurationData
SEQUENCE
GuestsCount
Customers
SEQUENCE
Customer
Type
Occurs
Description
Complex Type:
ServiceElementType
Extended with the
elements below
Type
Simple Type:
DurationTimeUnitType
1..1
Complex Type:
LocalizationType
0..1
Complex Type:
ServiceEntriesType
Complex Type:
GuestsCountType
anyType (restriction)
0..1
0..1
0..1
Complex Type:
BookingRuleType
1..*
Complex Type:
ConfigurationDataType
Extended with the
elements below
0..1
Complex Type:
GuestsCountType
0..1
anyType (restriction)
0..1
Complex Type:
CustomerElementType
1..*
Mandatory
No
Description
The time unit that the duration of service is
measured in. E.g. day, night
Page | 135
Type
Required
Description
ID
Code
BigIntID
ReservationCodeType
(restricted to 6 char
length)
Simple Type:
ReservationStsType
Yes
No
Status
No
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Price
ResServices
SEQUENCE
PackageComponent
TourServiceComponent
AccommodationComponent
TransportationComponent
SecondaryServiceComponent
TransferComponent
Type
Occurs
Description
Complex Type:
PriceType
anyType (restriction)
0..1
0..1
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
0..1
0..1
0..*
0..*
0..*
0..*
Page | 136
Type
Required
Description
ID
Status
BigIntID
Simple Type:
ReservationStsType
String
Yes
No
ECN
No
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
DateRange
Price
CancelPenalties
Type
Occurs
Description
Complex Type:
DateTimeRangeType
0..1
Complex Type:
PriceType
Complex Type:
CancelPenaltiesType
0..1
0..1
Page | 137
Type
Required
Description
Vehicle
VehicleName
string
String
Yes
Yes
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
ExtendedComplex Type:
TransferSegmentPartType
with element below
String
1..1
0..1
1..1
anyType
1..1
Attributes
Date
Type
date
Mandatory
1..1
Time
time
1..1
anyType (restriction)
1..1
SEQUENCE
TransferDuration
duration
1..1
WaitingDuration
duration
1..1
SEQUENCE
PickUp
LocationDetails
DropOff
LocationDetails
Departure
Durations
0..1
ComplexType: PackEntryTour
Description
Describes the structure and contents of a tour service within a package entry
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Segment
SEQUENCE
Departure
Attributes
Date
Time
Place
SEQUENCE
City
Arrival
Attributes
Date
Time
Place
SEQUENCE
City
Type
Occurs
Description
anyType (restriction)
1..*
anyType (restriction)
1..1
Type
date
date
string
Complex Type:
CityType
anyType (restriction)
Type
date
date
string
Complex Type:
CityType
1..1
Page | 139
ComplexType: PackEntryAcc
Description
Desribes the structure and contents of an accommodation service within a package entry
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
RoomType
RoomFeature
RoomOccupancy
SEQUENCE
GuestCount
Attributes
AgeQualifyingCode
Count
MinAge
MaxAge
City
AccommodationDates
SEQUENCE
Date
Type
Occurs
Description
Complex Type:
RoomElementType
Complex Type:
FeatureElementType
anyType (restriction)
1..1
anyType(restriction)
1..*
Type
Simple Type:
AgeQualifyingCodeType
xsd:positiveInteger
PersonAgeType
(number between 0
and 120)
PersonAgeType
(number between 0
and 120)
Complex Type:
CityType
1..1
1..1
No
1..1
anyType(restriction)
0..1
string
1..*
Attributes
Attribute
Type
Required
Description
UnitID
positiveInteger
No
Name
Stars
string
positiveInteger
Yes
Yes
string
String
Yes
Yes
Page | 141
ComplexType: PackEntryTransp
Description
Describes the structure and contents of a transportation service within a package entry
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Attributes
ServiceID
Name
Code
Type
positiveInteger
string
string
Mandatory
Yes
Yes
Yes
Carrier
string
No
FlightNo
string
No
SEQUENCE
Departure
anyType (restriction)
1..1
Attributes
Date
Time
Carrier
SEQUENCE
City
Location
Arrival
Attributes
Date
Time
SEQUENCE
City
Location
Type
date
time
string
Complex Type:
CityType
Complex Type:
LocationType
anyType (restriction)
Type
date
time
Complex Type:
CityType
Complex Type:
LocationType
Description
Description
The ID of the transportation service.
The name of the transportation service.
The departure code of the transportation service.
The carrier of the first segment of the outbound
transportation service (appears only in the package
catalog).
The flight number of the first segment of the outbound
transportation service (appears only in the package
catalog).
0..1
1..1
0..1
Page | 142
ComplexType: PackAvailType
Description
Informs if there is enough availability to accommodate the requested guests in the specified period and rooms
Derived by
Extending xsd:string
Attributes
Attribute
Type
Required
Description
Status
Simple Type:
AvailableStsType
Yes
Page | 143
ComplexType: PriceRateType
Description
Describes a price rate with the corresponding amount and details
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Attributes
ID
Type
Name
DateStart
DateEnd
Type
positiveInteger
string
string
date
date
Mandatory
Yes
Yes
Yes
Yes
Yes
SpoType
string
No
Complex Type:
PriceType
String
1..1
0..1
SEQUENCE
Price
Description
Description
Description
Unique identifier of the rate
The type of the rate (can be standard or spo)
The name of the rate
The start date of the period when this rate is available
The end date of the period when this rate is available
If rate is special offer, this attribute contains special
offer type
Page | 144
Page | 145
ComplexType: RemarksListType
Description
Represents a list of reservation remarks
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
Reservation
anyType (restriction)
1..1
Type
BigIntID
Mandatory
Yes
anyType (restrictions)
0..1
anyType (restriction)
Type
dateTime
1..*
Mand
Yes
string
No
ComplexType:
SenderType
string
1..1
1..1
Attributes
ID
Remarks
SEQUENCE
Remark
Attribute
AddTime
ReadByUser
SEQUENCE
Sender
RemarkText
Description
Unique identifier of the reservation
Page | 146
ComplexType: SenderType
Description
Represents the type of sender of a reservation remark
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Attributes
Type
Possible values:
- reseller
- tourOperator
string
Mandatory
Description
Yes
Yes
Type
Name
Description
Page | 147
ComplexType: TransferSegmentPartType
Description
Defines a part of a transfer segment. Each part can either be a pick-up or a drop-off point
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Location
City
Country
Type
Occurs
Description
Complex Type:
LocationType
Complex Type:
CityType
Complex Type:
CountryType
1..1
1..1
1..1
Page | 148
ComplexType: TransferVehicleType
Description
Defines transfer vehicle details
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
Availability
anyType (restriction)
1..1
Mandatory
Yes
Attributes
MixPax
Type
Simple Type:
AvailableStsType
Complex Type:
PriceType
ComplexType:
CancelPenaltyType
Type
positiveInteger
MaxPax
positiveInteger
Yes
MaxLuggage
positiveInteger
Yes
Code
string
Yes
Name
string
Yes
Attributes
Status
Price
CancelPenalties
1..1
Description
Describes a code that indicates the availability of the
service
Includes details about the vehicle prices
1..0
Mandatory
Yes
Description
Identifies the minimum number of passangers that can
book this service
Identifies the maximum number of passangers that
can book this service
Identifies the maximum number of luggage supported
by this service
The code of the vehicle (acts as an unique identifier of
the vehicle)
The vehicle name
Page | 149
ComplexType: BookTransferTypeDetailsType
Description
Defines transfer type details.
Content Model
Contains elements as defined in the following table.
Element
Type
Occurs
Description
SEQUENCE
Name
string
0..1
Address
string
0..1
PostalCode
string
0..1
Airline
string
0..1
Flight
string
0..1
Terminal
string
0..1
Time
string
0..1
Route
string
0..1
Number
string
0..1
Page | 150
SIMPLE TYPES
Simple Type: PackageType
Description
Describes possible values of package type
Derived By
Restricting string
Enumeration
Value
Description
holiday
tour
Page | 151
Description
a
c
i
Describes an adult
Describes a child
Describes an infant
Page | 152
SimpleType: ServiceStarsType
Description
Describes the possible values of service number of stars.
Derived By
Restricting positiveInteger
Restrictions
The value must be greater than or equal to 1.
The value must be less than or equal to 5.
Page | 153
Description
OK
RQ
NA
Page | 154
Description
day
night
Page | 155
Description
RQ
OK
XX
AM
Page | 156
Description
AccTypes
AccRoomTypes
AccCategories
AccFacilities
TranspTypes
SecondServTypes
TourServTypes
PackageCategories
Page | 157
Description
a
c
Describes an adult
Describes a child
Page | 158
Description
a
c
i
Describes an adult
Describes a child
Describes an infant
Page | 159
SimpleType: DocumentObjectType
Description
Offers the possible document object types that documents can be requested for
Enumeration
Value
Description
Project
Package
Reservation
ReservationService
Page | 160
SimpleType: DocumentType
Description
Offers the possible document types that can be returned
Enumeration
Value
Description
Voucher
Identifies an operational document specific of the reservation service, asserting the fact
that the customers actually purchased the service
Identifies a descriptive document including all information there is about a reservation.
Identifies a descriptive document including various information about a package
Identifies a descriptive document including various information about a project.
ReservationDetails
PackageDocument
ProjectDocument
Page | 161
Description
accommodation
airport
station
port
other
Page | 162