Sei sulla pagina 1di 162

AIDA.

WS
Web Service Documentation

Version 2.21

AIDA.WS Static Packages - Documentation


Version 1.0
Documentation for AIDA.WS Static Packages
Version 1.1
Documented the changes in the web service message structures, as a direct result of refactoring and optimizing AIDA.WS.
The images with structure details have been replaced with references to the technical documentation.
Version 1.2
Described the authentication process.
Version 1.3
Added details about setting up the web service endpoint.
Added details about specific structures and how they should be used within the request messages.
Version 2.0
Documented the integration with AIDA accommodation units using the web service.United the documentation and the
technical references into a single document.
Version 2.1
UPDATE / 13.05.2011
Optional compliance
Modules affected:
Details:
AIDA version:

PersonAgeType now extends nonNegativeInteger instead of positiveInteger type

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

NEW FEATURE / 13.05.2011


Mandatory compliance
Modules affected:
AIDA version:

Packages, Hotels
Allows setting age 0 to passengers
1.16.11.746

inAccBookRQ.xsd, the element AccUnit->Rooms->Room->Customers->Customer can have a new


attribute: AgeSegment (Identifies the age limits of the segment that this customer is associated
with. Example: AgeSegment="2-18". It is mandatory for children)
Hotels
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

AIDA.WS Static Packages - Documentation


UPDATE / 10.06.2011
Mandatory compliance
Modules affected:
Details:
AIDA version:

Added value i for infant to AgeQualifyingCodeType


Packages, Hotels
Although the web service can no longer be interrogated using infant (this is now done using child
type and specifying age), the WS responses may include rooms with infants.
1.16.22.754

Version 2.3
ADD / 08.08.2011
Optional compliance
Modules affected:
Details:
AIDA version:

Added a series of operations to aid in a catalog-type packages publication.


Packages
New operations: PackSearch, PackExtraServices, PackAvail, PackBook, PackFullList
1.17.34.810

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:

Added new elements to some structures in PackCatalog messages.


Packages
Added AccommodationDates element to PackEntryAccin pack catalog xml file.
Added BookingRules element to ExtraService element in PackExtraService method response.
Added DateRange element to ExtraService element in PackAvail request message
1.20.0.909

Version 2.6
ADD / 15.12.2011
Optional compliance
Modules affected:
Details:

AIDA version:

Added new elements to some structures.


Packages, Hotels
Added support for multi-room booking (AIDA_PackBookRQ/Package/PackEntry/Rooms element can
now appear multiple times and customers must be associated with each room)
Added DateRange element to ResServiceType element in ReservationDetails response message,
indicating the overall duration of the package.
Added CancelPenalties element to ResAccommodationComponentType.
Added Location element and Place attribute to ItinerarySegmentLocationType
Added Itinerary element to ConfigurationDataType
Changed the way the pack catalog file is pushed back to reseller.
Changed the value of service prices in ReservationDetails (see explanations)
>1.20.12.924

Page | 3

AIDA.WS Static Packages - Documentation


Version 2.7
ADD / 09.01.2012
Optional compliance
Modules affected:
Details:

AIDA version:

Added new elements to some structures.


Packages, Hotels
Added support for distributor accounts (the authentication method varies)
Added UnitID attribute to PackEntryAcc element type.
Added Duration element to PackEntry element in the package catalog.
New method: PackDetails
Added supplier information to hotels search response (AccSearchRS). It is displayed for every
service within the room stays.
New document methods (possiblity to get travel documents through the web service).
Added transportation service name to PackEntryTransp.
Added room details to PackEntryAcc
1.22.0.995

Version 2.8
ADD / 31.05.2012
Optional compliance
Modules affected:
Details:

AIDA version:

Added new elements to some structures.


Packages, Hotels
Added document title when retrieving the documents list for an entity.
Added ServiceIDattribute to PackEntryTransp.
Added Projectelement to PackDetailsRS method response
Added Project element to PackCatalog structure
Added Name attribute to Service element within the AccSearchRS message
Added ECN attribute to ResServiceType structure within the ReservationDetailsRS message
ReturnURL element is now optional in PackCatalogFileRQ message.
Added DownloadURL attribute to PackCatalogFileRS message.
Added new package catalog transfer type: download
1.24.16.1116

Version 2.9
ADD / 07.01.2013
Mandatory compliance
Modules affected:
Details:

AIDA version:

Added new elements to some structures.


Packages, Hotels
Added possibility to specify the language of the response.
Added Fax element to AccUnit RS message.
Added FacilitiesDescription element to AccUnitRS message.
Added Carrier and FlightNo attributes to the PackEntryTransp structure.
*Age is now mandatory for children guests associated with extra services in PackAvailRQ message.
*The GuestsCount element is no longer required nor parsed in PackBookRQ message.
1.30.0.1376

Version 2.10
ADD / 27.02.2013
Optional compliance
Modules affected:
Details:
AIDA version:

Added new elements to some structures


Packages
Added multiple rates in PackCatalog.
Added possibility to select specific rates in PackAvailRQ and PackBookRQ.
1.31.27.1407

Page | 4

AIDA.WS Static Packages - Documentation


Version 2.11
ADD / 03.04.2013
Optional compliance
Modules affected:
Details:

AIDA version:

Added new WS methods and new elements to some structures


Packages, Hotels
Added project documents as available documents to request via AIDA.WS. See the changes in
types: DocumentType and DocumentObjectType.
Added reservation remarks syncronization methods.
Added WebAdress element to AccUnitsRS.
1.31.52.1432

Version 2.12
ADD / 28.05.2013
Optional compliance
Modules affected:
Details:
AIDA version:

Added new WS methods for transfers


N/A
Added transfer module
1.33.0.1508

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:

Added new WS methods for GetItineraryFull


Added new WS methods for accommodation themes
GetItineraryFull
Added GetItineraryFull module.
Implemented accommodation themes, added ThemesIDS attribute to AccUnitsRS.
1.34.82.1618

Version 2.15
ADD / 12.09.2013
Optional compliance
Modules affected:
Details:

Added special offer type to rates that contain special offers


Added description field for extra services
Added optional reseller extra data at packBookRQ and accBookRQ
N/A
Changed Complex Type: PriceRateType to include special offer type
Added Description field to ExtraServices in AccAvailRS and PackExtraServicesRS
Added possibility to send reseller username and reseller code in packBookRQ and
accBookRQ

Page | 5

AIDA.WS Static Packages - Documentation


AIDA version:

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:

Added some new elements to some structures.


Transfers
Added new PickUpLocationTypeDetails element in transfer book request.
Added new DropOffLocationTypeDetails element in transfer book request.
1.36.0.1694

Version 2.18
ADD / 19.12.2013
Optional compliance
Modules affected:
Details:
AIDA version:

Added some new attribute to some elements.


PackCatalogFile
Added new code attribute to PackEntryTransp complex type.
1.36.17.1711

Version 2.19
ADD / 21.01.2014
Optional compliance
Modules affected:
Details:

AIDA version:

Added some new elements to some structures.


Added some new attribute to some elements.
Transfers , Package
Added new Carrier attribute to the PackEntryTransp structure available only for PackAvailRS.
Added new Type attribute to TransferSearchRS complex type.
Added new Type attribute to ResTransferComponentType complex type.
Added new VehicleName attribute to TransferResServiceType complex type.
Added new Departure element to TransferResServiceType complex type.
1.37.17.1740

Version 2.20
ADD / 13.03.2014
Optional compliance
Modules affected:
Details:
AIDA version:

Added some complex type to some structures.


Transfers
Added CancelPenaltyType to TransferVehicleType.
1.38.21.1794

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

AIDA.WS Static Packages - Documentation

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

AIDA.WS Static Packages - Documentation


AccThemes ....................................................................................................................................................................... 65
AccSearch......................................................................................................................................................................... 67
AccAvail ............................................................................................................................................................................ 73
AccBook ........................................................................................................................................................................... 79
Transfer Search ................................................................................................................................................................ 83
TransferBook.................................................................................................................................................................... 87
RESERVATION MESSAGES .................................................................................................................................................... 89
ReservationDetails ........................................................................................................................................................... 89
ReservationCancel ........................................................................................................................................................... 95
ReservationRemarksList................................................................................................................................................... 97
ReservationRemarkAdd ................................................................................................................................................... 99
DOCUMENT MESSAGES .....................................................................................................................................................101
DocumentsList ...............................................................................................................................................................101
DocumentGet ................................................................................................................................................................103
TOOLS MESSAGES ..............................................................................................................................................................105
CodesList ........................................................................................................................................................................105
COMPLEX TYPES .....................................................................................................................................................................107
Complex Type: CountryType ..............................................................................................................................................107
Complex Type: RegionType................................................................................................................................................108
Complex Type: CityType ....................................................................................................................................................109
Complex Type: LocationType .............................................................................................................................................110
Complex Type: DateTimeRangeType .................................................................................................................................111
Complex Type: LocalizationType........................................................................................................................................112
Complex Type: ItinerarySegmentLocationType .................................................................................................................113
Complex Type: GuestsCountType ......................................................................................................................................114
Complex Type: ServiceType ...............................................................................................................................................115
Complex Type: RoomElementType ....................................................................................................................................116
Complex Type: FeatureElementType .................................................................................................................................117
Page | 8

AIDA.WS Static Packages - Documentation


Complex Type: OccupancyElementType ............................................................................................................................118
Complex Type: RoomStayType ..........................................................................................................................................119
Complex Type: PriceType...................................................................................................................................................120
Complex Type: PriceComponent .......................................................................................................................................121
Complex Type: AccCategoryType ......................................................................................................................................122
Complex Type: CancelPenaltiesType .................................................................................................................................123
Complex Type: CancelPenaltyType ....................................................................................................................................124
Complex Type: CustomerElementType .............................................................................................................................125
Complex Type: ServiceElementType ..................................................................................................................................127
Complex Type: ServiceEntriesType ....................................................................................................................................128
Complex Type: ConfigurationDataType .............................................................................................................................129
Complex Type: BookingRuleType ......................................................................................................................................130
Complex Type: TourServiceComponentType.....................................................................................................................131
Complex Type: AccommodationComponentType .............................................................................................................132
Complex Type: TransportationComponentType ...............................................................................................................134
Complex Type: SecondaryServiceComponentType ...........................................................................................................135
Complex Type: ReservationDataType ................................................................................................................................136
Complex Type: ResServiceType .........................................................................................................................................137
Complex Type: TransferResServiceType ............................................................................................................................138
ComplexType: PackEntryTour ............................................................................................................................................139
ComplexType: PackEntryAcc ..............................................................................................................................................140
ComplexType: PackEntryTransp ........................................................................................................................................142
ComplexType: PackAvailType ............................................................................................................................................143
ComplexType: PriceRateType ............................................................................................................................................144
ComplexType: RemarksListType ........................................................................................................................................146
ComplexType: SenderType ................................................................................................................................................147
ComplexType: TransferSegmentPartType .........................................................................................................................148
ComplexType: TransferVehicleType ..................................................................................................................................149
Page | 9

AIDA.WS Static Packages - Documentation


ComplexType: BookTransferTypeDetailsType ...................................................................................................................150
SIMPLE TYPES .........................................................................................................................................................................151
Simple Type: PackageType .................................................................................................................................................151
Simple Type: AgeQualifyingCodeType ...............................................................................................................................152
SimpleType: ServiceStarsType ...........................................................................................................................................153
Simple Type: AvailableStsType ..........................................................................................................................................154
Simple Type: DurationTimeUnitType .................................................................................................................................155
Simple Type: ReservationStsType ......................................................................................................................................156
Simple Type: CodesListType...............................................................................................................................................157
Simple Type: AgeQualifyingCodeTypeRQ ..........................................................................................................................158
SimpleType: AgeQualifyingCodeTypeRS ............................................................................................................................159
SimpleType: DocumentObjectType ...................................................................................................................................160
SimpleType: DocumentType ..............................................................................................................................................161
Simple Type: TransferLocationType ...................................................................................................................................162

Page | 10

AIDA.WS Static Packages - Documentation

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.

ENABLING THE WEB SERVICE


To be able to develop based on AIDA.WS, the Tour Operator must activate the web service for a specific reseller account
and communicate those accounts details to the developers. Those account details constitute the credentials for the web
service.

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.

MESSAGE EXCHANGE PATTERNS


AIDA.WS currently makes use of the Request/Response message pattern. This means that any transaction that conforms
to this pattern can be invoked by one of the communicating parties requesting information from another party. This is the
request part. In return, the inquired party processes the message and returns a response with the requested information.
This is the response part of the transaction.

REQUIREMENTS
Technical details
To be able to access AIDA Web Service, the following information is needed:
-

The authentication credentials:


o Reseller code (the agency code entered in AIDA Tour Operator Module for each reseller)
o Username and password (the AIDA username and password of the reseller user)
URL of the Web Service Description Language
Web Service Endpoint
o The location for HTTP requests

Language
AIDA.WS is implemented using SOAP, which is an XML-based protocol. To enable this service, you need to have the ability
to:
-

Communicate via Internet protocols (most commonly HTTP)


Send and receive formatted data as XML documents

Page | 11

AIDA.WS Static Packages - Documentation


References
-

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

AIDA.WS Static Packages - Documentation

SETTING UP THE WEB SERVICE CLIENT


The web service namespace
The AIDA.WS web service namespace is http://aida.dcsplus.net/ws/2010. The namespace represents a piece of
information that is unique for AIDA web service and doesnt change with server information. It takes the form of an URI.
Note: the web service namespace is not used to look up information!

Page | 13

AIDA.WS Static Packages - Documentation

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],
))
);

Here is how the <AuthHeader>element should look like in a request:


<SOAP-ENV:Header>
<ns1:AuthHeaderLang="en">
<ns1:Username>dcstravel</ns1:Username>
<ns1:Password>dcstravel</ns1:Password>
<ns1:ResellerCode>DCST</ns1:ResellerCode>
</ns1:AuthHeader>
</SOAP-ENV:Header>

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

AIDA.WS Static Packages - Documentation

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

AIDA.WS Static Packages - Documentation

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.

The AIDA.WS Hotels specific messages are:


-

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.

The messages common to both modules are:


-

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

AIDA.WS Static Packages - Documentation

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

Collection of data that may filter the results list

Complex Type:
CountryType

0..1

Allows to filter by a certain country. The country ID or


Name attributes can be used.

GlobeCountriesRQ XML Sample

Page | 17

AIDA.WS Static Packages - Documentation


<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_GlobeCountriesRQ>
<ns:Filters>
<ns:Country ID="6" />
</ns:Filters>
</ns:AIDA_GlobeCountriesRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_GLOBECOUNTRIESRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Countries
SEQUENCE
Country

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
List of system countries

Complex Type:
CountryType

0..*

Identifies a single country in the system

GlobeCountriesRS XML 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_GlobeCountriesRS TimeStamp="2011-04-05T12:08:53+03:00" Version="1.0" RequestHost="192.168.1.107">
<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/>
<ns1:Countries>
<ns1:Country ID="6" Name="Italia"/>
</ns1:Countries>
</ns1:AIDA_GlobeCountriesRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 18

AIDA.WS Static Packages - Documentation

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

Collection of data that may filter the results list

Complex Type:
RegionType

0..1

Complex Type:
CountryType

0..1

Allows to filter the results list by a specific region ID or


name (if the name is specified, a search for an exact
match is performed)
Allows to filter the results list by a specific country ID or
name (if the name is specified, a search for an exact
match is performed)

Page | 19

AIDA.WS Static Packages - Documentation


GlobeRegionRS XML Sample 1
<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_GlobeRegionsRQ>
<ns:Filters>
<ns:Country Name="Romania" />
</ns:Filters>
</ns:AIDA_GlobeRegionsRQ>
</soapenv:Body>
</soapenv:Envelope>

GlobeRegionRS XML Sample 2


<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_GlobeRegionsRQ>
<ns:Filters>
<ns:Country ID="1" />
</ns:Filters>
</ns:AIDA_GlobeRegionsRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_GlobeRegionsRS
Page | 20

AIDA.WS Static Packages - Documentation


Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Regions
SEQUENCE
Region

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
List of system regions

Complex Type:
RegionType

0..*

Information that identifies a region. If the region has a


text description, it will be offered as the region
element's content.

GlobeCountriesRS XML 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_GlobeRegionsRS TimeStamp="2011-04-05T13:02:43+03:00" Version="1.0"
RequestHost="192.168.1.107">
<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/>
<ns1:Regions>
<ns1:Region ID="5" Name="Arges" CountryID="1"/>
<ns1:Region ID="10" Name="Litoral" CountryID="1"/>
<ns1:Region ID="2" Name="Moldova" CountryID="1"/>
<ns1:Region ID="1" Name="Muntenia" CountryID="1"/>
<ns1:Region ID="6" Name="Transilvania" CountryID="1"/>
</ns1:Regions>
</ns1:AIDA_GlobeRegionsRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 21

AIDA.WS Static Packages - Documentation

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

Allows to filter the list by a certain city ID or name (if


the name is specified, a search for an exact match is
performed).
Allows to filter the results list by a specific country ID or
name (if the name is specified, a search for an exact
match is performed).

SEQUENCE
City

Country

GlobeCitiesRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_GlobeCitiesRQ>
<ns:Filters>
<ns:Country ID="14" />
</ns:Filters>
</ns:AIDA_GlobeCitiesRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 22

AIDA.WS Static Packages - Documentation

AIDA_GlobeCitiesRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Cities
SEQUENCE
City

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
List of system cities

Complex Type:
CityType

0..*

Information that identifies a city. If the city has a text


description, it will be offered as the city element's
content.

GlobeCitiesRS XML 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_GlobeCitiesRS TimeStamp="2011-04-05T13:16:19+03:00" Version="1.0"
RequestHost="192.168.1.107">
<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/>
<ns1:Cities>
<ns1:City ID="60" Name="Dusseldorf" CountryID="14"/>
<ns1:City ID="61" Name="Frankfurt" CountryID="14"/>
<ns1:City ID="50" Name="Nuremberg" CountryID="14">descriere oras</ns1:City>
</ns1:Cities>
</ns1:AIDA_GlobeCitiesRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GlobeLocations
Page | 23

AIDA.WS Static Packages - Documentation


Message Pair Overview
The AIDA Globe Locations message pair includes the structure needed to inquire and response upon the locations
available in AIDA system.
The Globe Locations request message can also be used to get the details of a specific location, if the location ID and/or
name are provided. In the same manner, all locations in a specific city can be retrieved if the city ID is added to the
request.
The Globe Locations response message lists all the globe locations in AIDA, as entered by the tour operator.
Message Pair Elements and Attributes

AIDA_GlobeLocationsRQ
Message Structure
Element
SEQUENCE
Filters
SEQUENCE
Location
City

Type

Occurs

Description

anyType (restriction)

0..1

Collection of data that may filter the results list.

Complex Type:
LocationType
Complex Type:
CityType

0..1

Allows to filter the results by location id or name.

0..1

Allows to filter the results by city id or name.

GlobeLocationsRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_GlobeLocationsRQ>
<ns:Filters>
<ns:City ID="7" />
</ns:Filters>
</ns:AIDA_GlobeLocationsRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_GlobeLocationsRS
Page | 24

AIDA.WS Static Packages - Documentation


Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Locations
SEQUENCE
Location

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
List of system locations

Complex Type:
LocationType

0..*

Information that describes a location. If the location


has a description, it will be included as the location's
element content.

GlobeLocationsRS XML 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_GlobeLocationsRS TimeStamp="2011-04-05T13:31:16+03:00" Version="1.0"
RequestHost="192.168.1.107">
<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/>
<ns1:Locations>
<ns1:Location ID="9" Name="Donaustadt" CityID="7"/>
<ns1:Location ID="7" Name="Innere Stadt" CityID="7"/>
<ns1:Location ID="8" Name="Josefstadt" CityID="7"/>
<ns1:Location ID="4" Name="Ringstrasse" CityID="7"/>
</ns1:Locations>
</ns1:AIDA_GlobeLocationsRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

GetItineraryFull
Page | 25

AIDA.WS Static Packages - Documentation


Message Pair Overview
The GetItineraryFull message pair includes the structure needed to inquire and response upon the itinerary available on a
package entry.
The GetItineraryFullrequest message can be used to get complete information itinerary for all the segments on a package
entry.
The GetItineraryFull response message lists all the segments for a specific transportation service on a package entry.

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

Identifies the package entry that the


request is made for.
Description
Unique numerical identifier of the package
entry.
Identifies the transportation service that
the request is made for.
Description
Unique numerical identifier of the
transportation service.

Attribute
ID
Service
Attribute
ID

GetItineraryFullRQ XML Sample

<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

AIDA.WS Static Packages - Documentation

Message Structure
Element

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
List of system locations

anyType (restriction)

1..1

Identifies a transportation service within the


package. Can only appear for holiday packages
(and even there, it is optional)

anyType (restriction)

1..*

Identifies a single itinerary segment.

Complex Type:
ItinerarySegmentLoc
ationType
Complex Type:
ItinerarySegmentLoc
ationType
Type
string
string
string
float

0..1

Defines the departure location that is part of an


itinerary segment

0..1

Defines the arrival location that is part of an


itinerary segment

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

Represents the checkout

CHOICE
Errors
SEQUENCE
POS
Success
Warnings
PackEntry
SEQUENCE
Transportation

SEQUENCE
Segment
SEQUENCE
Departure

Arrival

Attribute
FlightNo
FlightClass
Carrier
MaxKilos
Attribute
ServiceID
Name

GetItineraryFullRS XML Sample


Page | 27

AIDA.WS Static Packages - Documentation

<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>

PACK CATALOG MESSAGES


Page | 28

AIDA.WS Static Packages - Documentation


AIDA Pack Catalog Web Service Logics

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

Requests possible configurations for the extra


services of a package

Receives the list of selected rooms and


configured extra services and returns the overall
availability informatin + prices + cancel penalties

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

Receives a reservation ID and returns all of its details

Receives a reservation ID and either returns the


information specific of the cancellation or actually cancels
the resevation

PackCatalogFile
Performs a request for the catalog file generation, which
will be received at a specified location (return URL).

PackSearch
Page | 29

AIDA.WS Static Packages - Documentation


Message Pair Overview
The PackSearchRQ message interrogates AIDA about the packages that satisfy a specific room request. Only 1 room
request per message can be made. Therefore, to search for 1 room with occupancy 2A+1C and 1 room with occupancy
1A+1C, 2 separate requests have to be made.
The PackSearchRS offers a catalog-type list with the packages that satisfy the room request.
Message Pair Elements and Attributes

AIDA_PackSearchRQ
Element

Type

Occurs

Description

SEQUENCE
SearchCriteria

anyType (restriction)

0..1

Filters that may be sent when searching


packages

SEQUENCE
Destination

anyType (restriction)

0..1

Identifies the desired destination for travel.


At least one of the destination elements
(country, city, region) must be provided

Type
positiveInteger
anyType (restriction)

0..1
Mandatory
Yes
0..1
Mandatory
Yes
0..1
Mandatory
Yes
0..1

Describes the desired country for travel


Description
Unique internal identifier of the country
Describes the desired region for travel
Description
Unique internal identifier of the region
Describes the desired city for travel
Description
Unique internal identifier of the city
Selects the time interval to search for
packages. The WS provides two means of
specifying the desired period: either by
entering the desired months or by entering
a specific interval defined by start and end
dates.

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

Describes a specific time interval to search


for packages.
Mandatory
Description
Yes
The start date of the date range
Yes
The end date of the date range
1..1
Describes specific months in which to
search for packages.
1..12

Numerical representation of the


calendaristic month. Ex: 1 for January, 2 for
February etc
Page | 30

AIDA.WS Static Packages - Documentation


Room

anyType (restriction)

SEQUENCE
GuestCount

Attribute
AgeQualifyingCode
Count
Age
Package
Attribute
Type
Category

1..1

Describes the occupancy of the desired


room, structured by passenger types. The
GuestCount element can appear max 3
times, because you can specify the number
of adults and 2 children of different ages.
For multiple persons of the same age and
type, the Count attribute should be used.

1..3

Type
Simple Type:
AgeQualifyingCodeTypeRQ
positiveInteger
Integer value between 0
and 120
anyType (restriction)
Type
Simple Type: PackageType
string

Describes the structure of a room guest


count within the request for package
search. The WS allows for a maximum of
5 adults and 2 children per room.
Mandatory
Description
Yes
Reference to a specific passenger type
based on a person's age
Yes
Determines the number of the guests of
the type identified by AgeQualifyingCode
No
Specifies the age of the guest. It is
mandatory only for children.
0..1
Collection of filters that apply directly to the
package
Mandatory
Description
No
Describes the type of desired package
No
The code of the package category. For a
complete list of package category codes,
use method CodesList

PackSearchRQ 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_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

AIDA.WS Static Packages - Documentation

Element

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
0..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of found packs

anyType (restriction)

0..*

Information that defines the base package, as it


is defined in AIDA

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

The name of package.


A 3 letter code for the package currency.
The code of package
The code of the package category. For a
complete list of package category codes,
please use the CodesList method.

SEQUENCE
Description
PackEntries

string
anyType (restriction)

0..1
1..1

Short description of the package


A pack entry is a prebuild configuration of the
package. It includes details about
checkin/checkout and departure/arrival info.

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

Identifies a single package entry for holiday


packages
Mandatory
Description
Yes
Unique numerical identifier of the package
entry
Yes
Represents the checkin
Yes
Represents the checkout

anyType (restriction)

0..1

anyType (restriction)

1..*

SEQUENCE
ExtraService
Attribute
ID

Type
positiveInteger

Name
Type

string
string

Mandatory

boolean

Collection of secondary services that the


current package contains.

Describes a secondary service that may be


included in the pacakge.
Mandatory
Description
Yes
Unique numerical identifier of the extra
service within the system
Yes
Describes the name of the service
Yes
Describes the type of the service (e.g.
meal, transfer etc)
Yes
Indicates whether the extra service must
be purchased along with the other services
Page | 32

AIDA.WS Static Packages - Documentation


in package
PackConfigurations

anyType
(restriction)

1..1

Collection of package configurations that


are valid for a particular package entry.

anyType
(restriction)

1..*

A package entry configuration contains


specific details about the rooms and
itinerary included when purchasing a
package. It also offers information
regarding price and availability.

ComplexType:
PackEntryTour

0..1

Accommodation

ComplexType:
PackEntryAcc

1..*

Transportation

ComplexType:
PackEntryTran
sp

0..2

Price

Complex Type:
PriceType
ComplexType:
PackAvailType

1..1

Identifies a tour service within the


package. This appears only for tour
package types and only appears once
Identifies an accommodations service
within the package. For holiday packages,
this appears only once. For tour packages,
there can be multiple accommodation
services.
Identifies a transportation service within
the package. Can only appear for holiday
packages (and even there, it is optional).
There can be only 1 outbound
transportation and only 1 inbound.
Describes the price of the current package
entry and configuration
Informs if there is enough availability to
accommodate the requested guests in the
specified period and rooms

SEQUENCE
Configuration

SEQUENCE
Tour

Availability

1.. 1

Page | 33

AIDA.WS Static Packages - Documentation


PackSearchRS XML Sample part 1

<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_PackSearchRS TimeStamp="2011-10-17T14:44:02+03:00" Version="1.0" RequestHost="192.168.1.104">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="test">Campan Mirela (test)</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:Packages>
<ns1:Package ID="128" Type="holiday" Name="Budapest - Bohem Art Hotel 4* (fara transport)" Currency="EUR" Code="BOHWOTR">
<ns1:PackEntries>
<ns1:PackEntry ID="455" DateStart="2011-10-01" DateEnd="2011-10-08">
<ns1:ExtraServices>
<ns1:ExtraService ID="494" Name="Supliment demipensiune - Bohem Art" Type="Masa pe perioada"
Mandatory="true"/>
</ns1:ExtraServices>
<ns1:PackConfigurations>
<ns1:Configuration>
<ns1:Accommodation Name="Bohem Art Hotel" Stars="4" RoomID="DBL_479_2487" RoomName="Cam. dubla, standard
(2*Adult)">
<ns1:RoomOccupancy>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:RoomOccupancy>
<ns1:City ID="10" Name="Budapest"/>
</ns1:Accommodation>
<ns1:Price Ammount="140.00" CurrencyCode="EUR"/>
<ns1:Availability Status="RQ"/>
</ns1:Configuration>
</ns1:PackConfigurations>
</ns1:PackEntry>
</ns1:PackEntries>
</ns1:Package>
<ns1:Package ID="129" Type="holiday" Name="Budapest - Bohem Art Hotel 4* (transport si masa)" Currency="EUR"
Code="BOHWITR">
<ns1:PackEntries>
<ns1:PackEntry ID="494" DateStart="2011-10-09" DateEnd="2011-10-13">
<ns1:ExtraServices>
<ns1:ExtraService ID="494" Name="Supliment demipensiune - Bohem Art" Type="Masa pe perioada"
Mandatory="false"/>
<ns1:ExtraService ID="497" Name="Transfer aero-hotel-aero" Type="Transfer" Mandatory="false"/>
</ns1:ExtraServices>
<ns1:PackConfigurations>
<ns1:Configuration>
<ns1:Accommodation Name="Bohem Art Hotel" Stars="4" RoomID="DBL_479_2487" RoomName="Cam. dubla, standard
(2*Adult)">
<ns1:RoomOccupancy>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:RoomOccupancy>
<ns1:City ID="10" Name="Budapest"/>
</ns1:Accommodation>
<ns1:Transportation>
<ns1:Departure Date="2011-10-09" Time="05:00">
<ns1:City ID="3" Name="Bucharest" ISO3="BUH"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-09" Time="06:00">
<ns1:City ID="10" Name="Budapest"/>
</ns1:Arrival>
</ns1:Transportation>
<ns1:Transportation>
<ns1:Departure Date="2011-10-13" Time="16:00">
<ns1:City ID="10" Name="Budapest"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-13" Time="17:00">
<ns1:City ID="3" Name="Bucharest" ISO3="BUH"/>
</ns1:Arrival>
</ns1:Transportation>
<ns1:Price Ammount="1220.00" CurrencyCode="EUR"/>
<ns1:Availability Status="OK"/>
</ns1:Configuration>
</ns1:PackConfigurations>
</ns1:PackEntry>
</ns1:PackEntries>
</ns1:Package>
[]

Page | 34

AIDA.WS Static Packages - Documentation


PackSearchRS XML Sample part 2
[]
<ns1:Package ID="116" Type="tour" Name="CIRCUIT IN GRECIA" Currency="EUR" Code="GR07">
<ns1:PackEntries>
<ns1:PackEntry ID="174" DateStart="2011-10-04" DateEnd="2011-10-11">
<ns1:ExtraServices>
<ns1:ExtraService ID="457" Name="Excursie la Cap Sounion" Type="Excursie pe zi" Mandatory="true"/>
<ns1:ExtraService ID="456" Name="Excursie in Peloponez" Type="Excursie pe zi" Mandatory="true"/>
<ns1:ExtraService ID="455" Name="Croaziera in insule" Type="Croaziera" Mandatory="true"/>
</ns1:ExtraServices>
<ns1:PackConfigurations>
<ns1:Configuration>
<ns1:Tour>
<ns1:Segment>
<ns1:Departure Date="2011-10-04" Time="07:20" Place="pta victoriei2">
<ns1:City ID="36" Name="Giurgiu"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-04" Time="20:45" Place="pta victoriei3">
<ns1:City ID="40" Name="Salonic"/>
</ns1:Arrival>
</ns1:Segment>
<ns1:Segment>
<ns1:Departure Date="2011-10-05" Time="08:00" Place="pta victoriei4">
<ns1:City ID="40" Name="Salonic"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-05" Time="16:20" Place="pta victoriei5">
<ns1:City ID="41" Name="Atena"/>
</ns1:Arrival>
</ns1:Segment>
<ns1:Segment>
<ns1:Departure Date="2011-10-09" Time="08:00" Place="location6">
<ns1:City ID="41" Name="Atena"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-09" Time="17:50" Place="location7">
<ns1:City ID="68" Name="Halkidiki"/>
</ns1:Arrival>
</ns1:Segment>
<ns1:Segment>
<ns1:Departure Date="2011-10-10" Time="07:00" Place="location7">
<ns1:City ID="68" Name="Halkidiki"/>
</ns1:Departure>
<ns1:Arrival Date="2011-10-10" Time="21:20" Place="location8">
<ns1:City ID="36" Name="Giurgiu"/>
</ns1:Arrival>
</ns1:Segment>
</ns1:Tour>
<ns1:Accommodation Name="Poseidon" Stars="3" RoomID="452_DBL_450_2277" RoomName="Cam. dubla, classic
(2*Adult)">
<ns1:RoomOccupancy>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:RoomOccupancy>
<ns1:City ID="40" Name="Salonic"/>
</ns1:Accommodation>
<ns1:Accommodation Name="Achillion" Stars="3" RoomID="453_DBL_452_2283" RoomName="Cam. dubla, standard
(2*Adult)">
<ns1:RoomOccupancy>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:RoomOccupancy>
<ns1:City ID="41" Name="Atena"/>
</ns1:Accommodation>
<ns1:Accommodation Name="Philoxenia Bungalows" Stars="3" RoomID="454_DBL_454_2290" RoomName="Cam.
dubla, dbl (2*Adult)">
<ns1:RoomOccupancy>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:RoomOccupancy>
<ns1:City ID="68" Name="Halkidiki"/>
</ns1:Accommodation>
<ns1:Price Ammount="648.00" CurrencyCode="EUR"/>
<ns1:Availability Status="OK"/>
</ns1:Configuration>
</ns1:PackConfigurations>
</ns1:PackEntry>
</ns1:PackEntries>
</ns1:Package>
</ns1:Packages>
</ns1:AIDA_PackSearchRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 35

AIDA.WS Static Packages - Documentation

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

Simple Type: PackageType

SEQUENCE
PackEntry

anyType (restriction)

Description

Collection of information that identify the


desired package
Mandatory
Description
Yes
Unique numerical identifier of the
desired package
Yes
Identifies the type of the package
(holiday, tour).
1..1

Identifies the package entry that the


request is made for
Mandatory
Description
Yes
Unique numerical identifier of the
package entry

Attribute
ID

Type
positiveInteger

SEQUENCE
ExtraServices

anyType (restriction)

0..1

Collection of extra services that the request


is made for. If no extra service is specified,
all extra services included on this package
and entry will be listed.

anyType (restriction)

1..*

Type
positiveInteger

Mand
Yes

Identifies a single extra service within the


package
Description
Unique numerical identifier of the service

SEQUENCE
ExtraService
Attribute
ID

Page | 36

AIDA.WS Static Packages - Documentation


PackExtraServicesRQ 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_PackExtraServicesRQ>
<ns:Package ID="111" Type="tour">
<ns:PackEntry ID="229">
<ns:ExtraServices>
<ns:ExtraService ID="439" />
<ns:ExtraService ID="438" />
<ns:ExtraService ID="440" />
</ns:ExtraServices>
</ns:PackEntry>
</ns:Package>
</ns:AIDA_PackExtraServicesRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_PackExtraServicesRS
Element

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

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

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information that defines the package, as it is
defined in AIDA.
Mandatory
Description
Yes
The internal ID of the package.
Yes
The type of package.
The name of package.
A 3 letter code for the package currency.
The code of package
The code of the package category. For a
complete list of package category codes,
please use the CodesList method.

1..1
Identifies the requested package entry
Mandatory
Description
Yes
Unique numerical identifier of the package
entry
Page | 37

AIDA.WS Static Packages - Documentation


DateStart
DateEnd
SEQUENCE
ExtraServices
SEQUENCE
ExtraService
Attribute
Mandatory

SEQUENCE
Service

date
date

Yes
Yes

anyType (restriction)

1..1

anyType (restriction)

1..*

Type
boolean

Represents the checkin


Represents the checkout
Collection of extra services found

Identifies a single extra service with its


properties and entries
Mandatory
Description
Yes
Indicates whether the extra service must
be purchased along with the other services
in package
1..1

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

Collection of booking rules. Booking rules are


restrictions imposed on the reservation of a
package component

anyType
(restriction)
Type
Simple Type:
AgeQualifyingCod
eType
boolean

1..*

Describes the passenger types that are allowed


to book the service.
Description
Describes the passenger types that are allowed
to book the service.

SEQUENCE
Type

SEQUENCE
PaxTypeAllowed
Attributes
Type

AllPaxBook

General information regarding the service:


name, type etc
Mandatory
Description

Mand.
Yes

1..1

Unique identifier of service


Name of service
Number of stars associated with the
service
The time unit that the duration of service
is measured in. E.g. day, night

Type of service - varies depending on service


group. Construct is formed from code and
name of service type.
Text representing service description
Collection of service entries

If this rule is set to true, then all the passengers


that request to book the package, if they are of
an allowed type, must also book the current
extra service.

Page | 38

AIDA.WS Static Packages - Documentation


PackExtraServicesRS XML 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_PackExtraServicesRS TimeStamp="2011-08-08T14:31:30+03:00" Version="1.0" RequestHost="192.168.1.108">
<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/>
<ns1:Package ID="111" Type="tour" Name="CEHIA-GERMANIA AVION" Currency="EUR" Code="CEHGERA" Category="City
break">
<ns1:PackEntry ID="229" DateStart="2011-08-14">
<ns1:ExtraServices>
<ns1:ExtraService Mandatory="true">
<ns1:Service ID="439" Name="Supliment demipensiune - Olympic Prague" DurationTimeUnit="night">
<ns1:Type Code="m">Masa pe perioada</ns1:Type>
</ns1:Service>
<ns1:ServiceEntries MultipleEntries="true" FlexibleEntryPeriod="false">
<ns1:ServiceEntry ID="2011-08-14_2">
<ns1:DateRange DateStart="2011-08-14" DateEnd="2011-08-16"/>
</ns1:ServiceEntry>
<ns1:ServiceEntry ID="2011-08-17_1">
<ns1:DateRange DateStart="2011-08-17" DateEnd="2011-08-18"/>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:BookingRules>
<ns1:PaxTypeAllowed Type="a"/>
<ns1:PaxTypeAllowed Type="c"/>
<ns1:PaxTypeAllowed Type="i"/>
<ns1:AllPaxBook>false</ns1:AllPaxBook>
</ns1:BookingRules>
</ns1:ExtraService>
<ns1:ExtraService Mandatory="true">
<ns1:Service ID="438" Name="Tur oras Praga (ziua 2)" DurationTimeUnit="day">
<ns1:Type Code="o">Tur oras</ns1:Type>
</ns1:Service>
<ns1:ServiceEntries MultipleEntries="true" FlexibleEntryPeriod="false">
<ns1:ServiceEntry ID="2011-08-15_1">
<ns1:DateRange DateStart="2011-08-15" DateEnd="2011-08-15"/>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:BookingRules>
<ns1:PaxTypeAllowed Type="a"/>
<ns1:AllPaxBook>true</ns1:AllPaxBook>
</ns1:BookingRules>
</ns1:ExtraService>
<ns1:ExtraService Mandatory="true">
<ns1:Service ID="440" Name="Cina romantica de adio (ziua 4)" DurationTimeUnit="day">
<ns1:Type Code="p">Masa pe zi</ns1:Type>
</ns1:Service>
<ns1:ServiceEntries MultipleEntries="true" FlexibleEntryPeriod="false">
<ns1:ServiceEntry ID="2011-08-17_1">
<ns1:DateRange DateStart="2011-08-17" DateEnd="2011-08-17"/>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:BookingRules>
<ns1:PaxTypeAllowed Type="a"/>
<ns1:PaxTypeAllowed Type="c"/>
<ns1:PaxTypeAllowed Type="i"/>
<ns1:AllPaxBook>true</ns1:AllPaxBook>
</ns1:BookingRules>
</ns1:ExtraService>
</ns1:ExtraServices>
</ns1:PackEntry>
</ns1:Package>
</ns1:AIDA_PackExtraServicesRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 39

AIDA.WS Static Packages - Documentation

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

Collection of information that identify


the desired package
Description
Unique numerical identifier of the
desired package
Identifies the type of the package
(holiday, tour).

anyType (restriction)

1..1

Attribute
ID

Type
positiveInteger

Mandatory
Yes

SEQUENCE
Rooms

anyType (restriction)

1..1

Collection of selected rooms for this


configuration. The system allows more
rooms to be entered to account for
tour packages, where a room must be
selected for each accommodation.
However, for holiday packages there
can be only 1 room, because there is
only 1 accommodation service. If
several rooms are specified in the case
of a holiday package, only the first
room is taken into consideration

SEQUENCE
Room

anyType (restriction)

1..*

Attribute
ID
Rate

Type
string
anyType (restriction)

Mandatory
Yes
0..1

Identifies a single room in the pack


configuration
Description
Unique identifier of the room
Indicates the specific rate desired for
the current package. If it is not
specified, the standard rate will be

SEQUENCE
PackEntry

Identifies the package entry that the


request is made for
Description
Unique numerical identifier of the
package entry

Page | 40

AIDA.WS Static Packages - Documentation

Atribute
ID

taken into consideration


Description
Unique identifier of the rate. List of
available rates for each room is
included in the package catalog.
Collection of extra services that need
to be configured in order to request
pack availability

Type
positiveInteger

Mandatory
Yes

anyType (restriction)

0..1

anyType (restriction)

1..*

Describes an extra service from the


package

anyType (restriction)

1..1

Type
positiveInteger

Mandatory
Yes

anyType (restriction)

1..1

Identifies the secondary service that


this extra service represents
Description
Unique numerical identifier of the
service within the system
Collection of selected service entries

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

Describes a single service entry.


Several entries can be selected, if the
attribute 'MultipleEntries' is true.
Description
Unique identifier of the service
entry
A time span defined by a start and end
date. When date range is specified,
the given ID is ignored and is formed
with the date range.
Includes information regarding the
number and type of passengers that
are purchasing this service. If an extra
service is selected, at least 1 adult
must purchase it.
Describes the number of passengers
of a specific type that purchase this
service.
Description
Reference to a specific passenger
type based on a person's age
Determines the number of the
guests of the type identified by
AgeQualifyingCode
Determines the age of the guest. It
is mandatory to supply this
attribute for children.

Page | 41

AIDA.WS Static Packages - Documentation


PackAvailRQ 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_PackAvailRQ>
<ns:Package ID="115" Type="holiday">
<ns:PackEntry ID="49">
<ns:Rooms>
<ns:Room ID="DBL_442_2249"/>
<ns:Rate ID="988421"/>
</ns:Rooms>
<ns:ExtraServices>
<ns:ExtraService>
<ns:Service ID="449"/>
<ns:ServiceEntries>
<ns:ServiceEntry ID="2011-08-06_5"/>
</ns:ServiceEntries>
<ns:GuestsCount>
<ns:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns:GuestsCount>
</ns:ExtraService>
<ns:ExtraService>
<ns:Service ID="459"/>
<ns:ServiceEntries>
<ns:ServiceEntry ID="2011-08-11_1"/>
</ns:ServiceEntries>
<ns:GuestsCount>
<ns:GuestCount AgeQualifyingCode="a" Count="1"/>
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="8" />
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="4" />
</ns:GuestsCount>
</ns:ExtraService>
<ns:ExtraService>
<ns:Service ID="458"/>
<ns:ServiceEntries>
<ns:ServiceEntry ID="2011-08-06_3"/>
</ns:ServiceEntries>
<ns:GuestsCount>
<ns:GuestCount AgeQualifyingCode="a" Count="1"/>
</ns:GuestsCount>
</ns:ExtraService>
</ns:ExtraServices>
</ns:PackEntry>
</ns:Package>
</ns:AIDA_PackAvailRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 42

AIDA.WS Static Packages - Documentation

AIDA_PackAvailRS
Element

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

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

The name of package.


A 3 letter code for the package currency.
The code of package
The code of the package category. For a
complete list of package category codes,
please use the CodesList method.

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

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information that defines the package, as it is
defined in AIDA.
Mandatory
Description
Yes
The internal ID of the package.
Yes
The type of package.

anyType (restriction)

Collection of secondary services that the


current package contains.

Describes a secondary service that may be


included in the pacakge
Mandatory
Description
Yes
Unique numerical identifier of the extra
service within the system
Yes
Describes the name of the service
Yes
Describes the type of the service (e.g.
meal, transfer etc)
Yes
Indicates whether the extra service must
be purchased along with the other services
in package.
1..1
The selected configuration

ComplexType:
PackEntryTour

0..1

ComplexType:

1..*

Identifies a tour service within the package.


This appears only for tour package types and
only appears once
Identifies an accommodations service within
Page | 43

AIDA.WS Static Packages - Documentation


PackEntryAcc

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

the package. For holiday packages, this appears


only once. For tour packages, there can be
multiple or no accommodation services
Identifies a transportation service within the
package. Can only appear for holiday packages
(and even there, it is optional)
Describes the standard price of the current
package entry and configuration
Describes the selected rate of the current
package entry and configuration
Informs if there is enough availability to
accommodate the requested guests in the
specified period and rooms
Collection of cancel penalties that may apply
for this particular package and configuration

PackAvailRS XML 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_PackAvailRS TimeStamp="2011-08-08T15:39:24+03:00" Version="1.0" RequestHost="192.168.1.108">
<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/>
<ns1:Package ID="111" Type="tour" Name="CEHIA-GERMANIA AVION" Currency="EUR" Code="CEHGERA" Category="City break">
<ns1:PackEntry ID="229" DateStart="2011-08-14">
<ns1:ExtraServices>
<ns1:ExtraService ID="439" Name="Supliment demipensiune - Olympic Prague" Type="Masa pe perioada" Mandatory="true"/>
<ns1:ExtraService ID="438" Name="Tur oras Praga (ziua 2)" Type="Tur oras" Mandatory="true"/>
<ns1:ExtraService ID="440" Name="Cina romantica de adio (ziua 4)" Type="Masa pe zi" Mandatory="true"/>
</ns1:ExtraServices>
<ns1:Configuration>
<ns1:Tour>
<ns1:Segment From="Bucharest, Romania" DepartureDate="2011-08-14" DepartureTime="07:20" DeparturePlace="otopeni"
To="Praga, Cehia" ArrivalDate="2011-08-14" ArrivalTime="08:15"/>
<ns1:Segment From="Praga, Cehia" DepartureDate="2011-08-18" DepartureTime="11:40" To="Bucharest, Romania"
ArrivalDate="2011-08-18" ArrivalTime="14:30" ArrivalPlace="otopeni"/>
</ns1:Tour>
<ns1:Accommodation Name="Olympic prague" Stars="3" RoomID="436_DBL_433_2224"/>
<ns1:Price Ammount="639.76" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="427.98"/>
<ns1:Commission Ammount="13.78"/>
<ns1:Tax Ammount="198.00"/>
</ns1:Price>
<ns1:Rate ID="699477" Type="spo" Name="Early Booking I" DateStart="2011-07-21" DateEnd="2013-09-15">
<ns1:Price Ammount="858.80" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="823.72"/>
<ns1:Commission Ammount="35.08"/>
<ns1:Tax Ammount="0.00"/>
</ns1:Price>
<ns1:Description>Early Booking I payment by 15.10.2011</ns1:Description>
</ns1:Rate>
<ns1:Availability Status="RQ">Package can be booked on request</ns1:Availability>
</ns1:Configuration>
<ns1:CancelPenalties>
<ns1:CancelPenalty Start="2011-07-30" Ammount="191.93" CurrencyCode="EUR"/>
<ns1:CancelPenalty Start="2011-08-13" Ammount="639.76" CurrencyCode="EUR"/>
</ns1:CancelPenalties>
</ns1:PackEntry>
</ns1:Package>
</ns1:AIDA_PackAvailRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 44

AIDA.WS Static Packages - Documentation

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

Additional data regarding reseller:


username and code
Description
The outside system reseller
username
The outside system reseller code
Collection of information that identify
the desired package
Description
Unique numerical identifier of the
desired package
Identifies the type of the package
(holiday, tour).

anyType (restriction)

1..1

Attribute
ID

Type
positiveInteger

Mandatory
Yes

SEQUENCE
Rooms

anyType (restriction)

1..*

Collection of selected rooms for this


configuration. The system allows more
rooms to be entered to account for
tour packages, where a room must be
selected for each accommodation.
However, for holiday packages there
can be only 1 room, because there is
only 1 accommodation service. Several
room collections indicate multipleroom booking.

anyType (restriction)

1..*

Identifies a single room in the pack


configuration

Type
string

Mandatory
Yes

Attribute
OutsiderUsername
OutsiderCode
Package

SEQUENCE
PackEntry

SEQUENCE
Room

Attribute
ID

Identifies the package entry that the


request is made for
Description
Unique numerical identifier of the
package entry

Description
Unique identifier of the room
Page | 45

AIDA.WS Static Packages - Documentation


Customers

anyType (restriction)

0..1

Collection of references indicating the


persons associated with this collection
of rooms. All customers must be
associated with all rooms.

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

Identifies a single customer.


Description
Identifies a single customer.
The desired rate for this package. If
not specified, the booking will be
made at standard price
Description
Unique identifier of the rate
Collection of extra services that need
to be configured in order to request
pack availability

SEQUENCE
ExtraService

anyType (restriction)

1..*

Describes an extra service from the


package

anyType (restriction)

1..1

Type
positiveInteger

Mandatory
Yes

anyType (restriction)

1..1

Identifies the secondary service that


this extra service represents
Description
Unique numerical identifier of the
service within the system
Collection of selected service entries

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

Describes a single service entry.


Several entries can be selected, if the
attribute 'MultipleEntries' is true.
Description
Unique identifier of the service
entry
Collection of associated customers
Identifies a single customer that is
associated with current extra service
Description
A positive integer that serves as
reference and is used as an index
identifying this customer in the
message
Collection of customers that are
booking the current package
Provides information regarding a
person that is related to the
booking action
Information that affects the
reservation as a whole
Page | 46

AIDA.WS Static Packages - Documentation


SEQUENCE
Comments

string

0..1

Remarks

string

0..1

Information that is relevant for the


booking action
Message specifically addressed to
the tour operator. It is handled by a
special message system between
the tour operator and reseller.

Page | 47

AIDA.WS Static Packages - Documentation


PackBookRQ 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_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.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Type
string

Complex Type:
ReservationDataType

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information regarding the effects of the
booking action in the system
Mandatory
Description
No
Indicator of the result of the booking
action. If the booking was successful, the
status will be Reserved
1..1

Information about the system reservation: id,


status, total price

PackBookRS XML Sample


<SOAP-ENV:Envelopexmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"xmlns:ns1="http://aida.dcsplus.net/ws/2010">
<SOAP-ENV:Body>
<ns1:AIDA_PackBookRSTimeStamp="2013-02-27T08:51:46+02:00"Version="1.0"RequestHost="192.168.1.2">
<ns1:POS>
<ns1:Requestor>
<ns1:AgencyID="1082"Code="CAT2">test</ns1:Agency>
<ns1:UserUsername="dcssupport2++">TBS</ns1:User>
<ns1:DistributorAgencyCode="CAT2"AgentUsername="dcssupport2++">TBS</ns1:Distributor>
</ns1:Requestor>
<ns1:BookingChannelType="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:BookingReference>
<ns1:ReservationID="1580000081"Code="Q4OVV5"Status="OK"PaymentStatus="OK">
<ns1:PriceAmmount="784.00"CurrencyCode="EUR"/>
<ns1:ResServices>
<ns1:PackageComponentID="1580000334"Status="OK"/>
<ns1:AccommodationComponentID="1580000335"Status="OK"/>
<ns1:TransportationComponentID="1580000336"Status="OK"/>
<ns1:TransportationComponentID="1580000337"Status="OK"/>
<ns1:SecondaryServiceComponentID="1580000338"Status="OK"/>
<ns1:SecondaryServiceComponentID="1580000341"Status="OK"/>
</ns1:ResServices>
</ns1:Reservation>
</ns1:BookingReference>
</ns1:AIDA_PackBookRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 49

AIDA.WS Static Packages - Documentation

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

token:the token from the PackCatalogFileRS message

fileKey:

an md5 hash of the file contents

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

AIDA.WS Static Packages - Documentation


1.

HTTP/1.1 403 Forbidden


This can happen if the token or security code are not provided or no request can be found to match them. Also,
this header can be returned if the catalog file has not yet been generated at the time of the download.

2.

HTTP/1.1 500 Internal Server Error


This can occur if there was an internal error on AIDA server and cannot return the requested file

3.

HTTP/1.0 404 Not Found


This can occur if file is marked as generated but cannot be found on disk.

A custom header called AIDA-Catalog-Status is also sent to provide more information when necessary.

Message Pair Elements and Attributes

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
string (extension)

1..1
1..1
0..1
1..1

Type

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Includes details about how the package catalog
file request was handled by AIDA
Mandatory
Description

Page | 51

AIDA.WS Static Packages - Documentation


Accepted

boolean

Yes

Token

string

Yes

DownloadURL

anyURI

No

Indicates whether the request was


accepted by the system. If it was not
accepted, the reason is given as text in the
parent element's content.
Alphanumeric code that uniquely identifies
the request withing the system
The URL where the requester can
download the catalog file once it is
generated.

PackCatalogFileRS XML 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_PackCatalogFileRS TimeStamp="2011-10-17T12:48:20+03:00" Version="1.0"
RequestHost="192.168.1.104">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="test">Campan Mirela (test)</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:PackCatalogFileRequest Accepted="false" Token="94812265a698f41f6b6174fdf6fb410b">A
request from current reseller already exists.</ns1:PackCatalogFileRequest>
</ns1:AIDA_PackCatalogFileRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

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

AIDA.WS Static Packages - Documentation

Element

Type

Occurs

Attribute
SearchStartDate
SearchEndDate
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Packages
SEQUENCE
Package

Type
date
date

Mandatory
Yes
Yes

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
0..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of found packs

anyType (restriction)

0..*

Information that defines the base package, as it


is defined in AIDA

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

The name of package.


A 3 letter code for the package currency.
The code of package
The code of the package category. For a
complete list of package category codes,
please use the CodesList method.

SEQUENCE
Description
Project

string
anyType(restriction)

0..1
1..1

Attribute
ID
Name
PackEntries

Type
positiveInteger
string
anyType (restriction)

Mand
Yes
Yes
1..1

Short description of the package


Includes short details of the project that this
package is part of
Description
Unique numerical identifier of the project
The name of the project
A pack entry is a prebuild configuration of the
package. It includes details about
checkin/checkout and departure/arrival info.

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

Identifies a single package entry for holiday


packages
Mandatory
Description
Yes
Unique numerical identifier of the package
entry
Yes
Represents the checkin
Yes
Represents the checkout

string (extension)

1..1

Attribute

Type

Includes information about the duration of the


package entry.

Mandatory

Description
Page | 53

AIDA.WS Static Packages - Documentation


TimeUnit

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)

The time unit that the duration of package


entry is measured in. E.g. day, night
Collection of secondary services that the
current package contains.

Describes a secondary service that may be


included in the pacakge.
Mandatory
Description
Yes
Unique numerical identifier of the extra
service within the system
Yes
Describes the name of the service
Yes
Describes the type of the service (e.g.
meal, transfer etc)
Yes
Indicates whether the extra service must
be purchased along with the other services
in package
1..1
Collection of package configurations that are
valid for a particular package entry.
1..*

A package entry configuration contains specific


details about the rooms and itinerary included
when purchasing a package. It also offers
information regarding price and availability.

1..1

The types and numbers that the passengers in


this room can have.

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..*

Identifies an accommodations service within


the package. For holiday packages, this appears
only once. For tour packages, there can be
multiple accommodation services.

Page | 54

AIDA.WS Static Packages - Documentation


Transportation

ComplexType:
PackEntryTran
sp

0..2

Price

Complex Type:
PriceType
anyType
(restriction)

1..1

Complex Type:
PriceRateType

1..*

Describes a price rate of the current package


entry and configuration

ComplexType:
PackAvailType

1.. 1

Informs if there is enough availability to


accommodate the requested guests in the
specified period and rooms

Rates
SEQUENCE
Rate
Availability

1..1

Identifies a transportation service within the


package. Can only appear for holiday packages
(and even there, it is optional). There can be
only 1 outbound transportation and only 1
inbound.
Describes the standard price of the current
package entry and configuration
Collection of available price rates for this
package entry and configuration

FullListRS XML Sample part 1: holiday packages


[...]
<Packages>
<Package ID="129" Type="holiday" Name="Budapest - Bohem Art Hotel 4*" Currency="BOHWITR" Category="leisure">
<Project ID="69" Name="PROIECT BUDAPESTA 2011"/>
<PackEntries>
<PackEntry ID="517" DateStart="2011-10-13" DateEnd="2011-10-19">
<ExtraServices>
<ExtraService ID="494" Name="Supliment - Bohem Art" Type="Masa pe perioada" Mandatory="false"/>
</ExtraServices>
<PackConfigurations>
<Configuration>
<Occupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
</Occupancy>
<Accommodation Name="Bohem Art Hotel" Stars="4" RoomID="SGL_478_2483" RoomName="SGL std">
<RoomOccupancy>
<GuestCount AgeQualifyingCode="a" Count="1"/>
</RoomOccupancy>
<City ID="10" Name="Budapest"/>
</Accommodation>
<Transportation>
<Departure Date="2011-10-13" Time="05:00">
<City ID="3" Name="Bucharest" ISO3="BUH"/>
</Departure>
<Arrival Date="2011-10-13" Time="06:00">
<City ID="10" Name="Budapest"/>
</Arrival>
</Transportation>
<Transportation>
<Departure Date="2011-10-19" Time="16:00">
<City ID="10" Name="Budapest"/>
</Departure>
<Arrival Date="2011-10-19" Time="17:00">
<City ID="3" Name="Bucharest" ISO3="BUH"/>
</Arrival>
</Transportation>
<Price Ammount="632.40" CurrencyCode="EUR"/>
<Rates>
<Rate ID="699500" Type="standard" Name="Standard" DateStart="2013-02-21" DateEnd="2013-12-31">
<Price Ammount="485.56" CurrencyCode="EUR" />
<Description />
</Rate>
<Rate ID="699501" Type="spo" Name="EB1" DateStart="2013-02-21" DateEnd="2013-03-15">
<Price Ammount="437.80" CurrencyCode="EUR" />
<Description>Early Booking I - cu plata pana la 15.03.2013</Description>
</Rate>
</Rates>
<Availability Status="RQ"/>
</Configuration>

[]

Page | 55

AIDA.WS Static Packages - Documentation

FullListRS XML Sample part 2: tour packages

[]
</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

AIDA.WS Static Packages - Documentation

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

PackDetailsRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_PackDetailsRQ>
<ns:Package ID="174"/>
</ns:AIDA_PackDetailsRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_PackDetailsRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType

1..1
1..1
0..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Page | 57

AIDA.WS Static Packages - Documentation


Package
Attribute
ID
Type

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

The name of the package.


A 3 letter code for the package currency.
The code of the package.
The code of the package category. For a
complete list of package category codes,
please use the CodesList method.

Short description of the package


Identifies a single image of the unit. The
content model includes the name of the image
(but is optional)
Mandatory
Description
Yes
Identifies the URL address where the unit's
image can be viewed
1..1

Includes details of the project that this package


is part of
Mandatory
Description
Yes
Unique numerical identifier of the project
Yes
The name of the project
Yes
The start date of the project
Yes
The end date of the project
No
A string identifier of the project, given by
the tour operator
0..1

Short description of the project

PackDetailsRS XML 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_PackDetailsRS TimeStamp="2012-02-28T10:46:32+02:00" Version="1.0" RequestHost="192.168.1.109">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="DCST">dcstravel agency</ns1:Agency>
<ns1:User Username="test">Campan Mirela (test)</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:Package ID="174" Type="holiday" Name="BUH-Amsterdam Multatuli 3* 3n" Currency="EUR" Code="BA-MUL3"
Category="cityBreak">
<ns1:Description>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua. </ns1:Description>
<ns1:Picture URL="http://someURL/?url=imagename&idPackage=174"/>
<ns1:Project ID="54" Name="Vacanta OLANDA" DateStart="2011-06-07" DateEnd="2011-10-31"/>
</ns1:Package>
</ns1:AIDA_PackDetailsRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 58

AIDA.WS Static Packages - Documentation

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

Receives a reservation ID and returns all of its details

Receives a reservation ID and either returns the


information specific of the cancellation or actually cancels
the resevation

AccUnits
Returns all information about existing units in the system
(static/informative operation)

Page | 59

AIDA.WS Static Packages - Documentation


AIDA Transfer Web Service Logic

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

Receives a reservation ID and returns all of its details

Receives a reservation ID and either returns the


information specific of the cancellation or actually cancels
the resevation

Page | 60

AIDA.WS Static Packages - Documentation

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

Collection of information that the units list can be


filtered by

CHOICE
Unit

anyType (restriction)

0..1

Attribute
ID
City

Type
positiveInteger
Complex Type:
CityType

Identifies a single unit that details can be requested


for.
Mandatory
Description
Yes
Unique numerical identifier of the unit
0..1
Identifies the city that the units are requested for. The
City ID must be provided if this filter is used.

AccUnitsRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_AccUnitsRQ>
<ns:Filters>
<ns:City ID="7" />
</ns:Filters>
</ns:AIDA_AccUnitsRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 61

AIDA.WS Static Packages - Documentation

AIDA_AccUnitsRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccUnits
SEQUENCE
AccUnit

Attribute
ID
Name
Stars

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of accommodation units

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

Defines an accommodation unit. Includes all


static information about that unit: name,
location, facilities, images etc
Mandatory
Description
Yes
The internal ID of the unit.
Yes
Name of the accommodation unit
Yes
Number of stars of the accommodation
unit
No
The latitude of the location
No
The longitude of the location
No
Identifies the moment in time when the
unit was last modified in AIDA
No
List of themes IDs, separated by "|"

Complex Type:
ServiceType
Complex Type:
AccCategoryType
Complex Type:
LocalizationType

1..1

Type of accommodation unit

0..1

Describes the category of the accommodation

1..1

Identifies the location of the accommodation


unit. City and country information will always
be provided. Region and location may appear if
they are entered in AIDA.

anyType (restriction)

0..1

Includes contact details about the unit, such as


telephone and e-mail

string
string
string
anyURI
anyType (restriction)

0..1
0..1
0..1
0..1
0..1

Identifies the telephone number of the unit


Identifies the fax number of the unit
Identifies the e-mail address of the unit
Identifies the web address of the unit
Describes the unit's facilities

string (extension)
Type
string

1..*
Mand
Yes

Identifies a single facility of the unit


Description
Identifies the code of the facility. The text
description will be given in the facility
Page | 62

AIDA.WS Static Packages - Documentation

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

content model (for a complete list of


codes, please see the AccFacilities list
type)
Describes the category of the facility
Includes several text descriptions that the unit
may have
Identifies a short description of the unit
Identifies the full description of the unit
Identifies the description of the unit's rooms
Identifies the facilities description
Identifies the description of the unit's location
Offers information about how to reach the unit
by various means of transportation
Describes the touristic attractions near the unit
Includes various policies that the unit may
impose
Includes gallery images of the unit

Identifies a single image of the unit. The


content model includes the name of the image.
Mandatory
Description
Yes
Identifies the URL address where the unit's
image can be viewed
No
Identifies the main picture in gallery

Page | 63

AIDA.WS Static Packages - Documentation


AccUnitsRS XML 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_AccUnitsRS TimeStamp="2011-04-06T11:51:01+03:00" Version="1.0"
RequestHost="192.168.1.107">
<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/>
<ns1:AccUnits>
<ns1:AccUnit ID="42" Name="Ambassador" Stars="5">
<ns1:Type Code="h">Hotel</ns1:Type>
<ns1:Category Code="dlx">Deluxe</ns1:Category>
<ns1:Destination>
<ns1:City ID="7" Name="Viena"/>
<ns1:Country ID="2" Name="Austria"/>
<ns1:Location ID="7" Name="Innere Stadt"/>
<ns1:Address>Krntner Strae 22, 01. Innere Stadt, 1010 Vienna</ns1:Address>
</ns1:Destination>
<ns1:Facilities>
<ns1:Facility Code="res">Restaurant</ns1:Facility>
<ns1:Facility Code="bar">Bar</ns1:Facility>
<ns1:Facility Code="r24">Receptie non-stop</ns1:Facility>
<ns1:Facility Code="nsr">Camere nefumatori</ns1:Facility>
<ns1:Facility Code="elv">Lift</ns1:Facility>
<ns1:Facility Code="sef">Seif</ns1:Facility>
<ns1:Facility Code="het">Incalzire</ns1:Facility>
<ns1:Facility Code="wic">Internet wireless contra cost</ns1:Facility>
<ns1:Facility Code="cpk">Parcare contra cost</ns1:Facility>
</ns1:Facilities>
<ns1:Descriptions>
<ns1:ShortDescription>Situated directly in the city centre of Vienna, this
luxurious 5-star hotel has welcomed many famous politicians and artists over the course of its
history.</ns1:ShortDescription>
<ns1:FullDescription>The extremely spacious rooms are both elegant and stylish,
designed to meet your every need with the added benefit of ultramodern technology. Under-floor
heating and individually adjustable air conditioning are just some of the amenities that make the
Hotel Ambassador like no other hotel in town. Every room in each category represents an individual
expression of the charm of the building.</ns1:FullDescription>
<ns1:Policies>Pets are allowed on request. Charges may be
applicable.</ns1:Policies>
</ns1:Descriptions>
<ns1:Gallery>
<ns1:GalleryImage
URL="http://aidaurl/tourOperator/plugins/aida.ws/images/?url=136448.jpg&idUnit=42"/>
<ns1:GalleryImage
URL="http://aidaurl/tourOperator/plugins/aida.ws/images/?url=136450.jpg&idUnit=42"/>
<ns1:GalleryImage
URL="http://aidaurl/tourOperator/plugins/aida.ws/images/?url=1200042.jpg&idUnit=42"/>
</ns1:Gallery>
</ns1:AccUnit>
</ns1:AccUnits>
</ns1:AIDA_AccUnitsRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 64

AIDA.WS Static Packages - Documentation

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.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information regarding accommodation themes

anyType (restriction)

0..*

Information about the theme: id, code, name,


added time, update time

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

AccThemesRS XML 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_AccThemesRS TimeStamp="2013-08-21T11:07:40+03:00" Version="1.0"
RequestHost="192.168.1.136">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="victor">Petrescu Victor</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:AccomodationThemesList>
<ns1:Theme ID="1" Code="SPWE" Name="Spa &amp;amp; Wellness" AddTime="1376375952"
LastUpdateTime="1376375952"/>
<ns1:Theme ID="2" Code="FAM" Name="Family" AddTime="1376378933" LastUpdateTime="0"/>
</ns1:AccomodationThemesList>
</ns1:AIDA_AccThemesRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 66

AIDA.WS Static Packages - Documentation

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:
-

Adult having AgeQualifyingCode=a


Child having AgeQualifyingCode=c (in this case, the age of the child must also be provided)

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

Information to search accommodation by. Some of the


search criteria like date range and location must be
specified in the request.
Mandatory
Description
No
Indicates that the search results should also
include the accommodation that has request
availability.
1..1

Defines a period by specifying the date/time of start


Page | 67

AIDA.WS Static Packages - Documentation

1..1

and date/time of end.


Idenfities the location of the accommodation. City ID is
required

Complex Type:
CityType
anyType (restriction)

1..1

Identifies the city desired for the trip.

1..1

Includes information that describes the


accommodation unit

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

Offers possibility to filter by the number of stars of the


accommodation. You can specify a maximum number
of stars to be included in the results or you can specifiy
the exact number of stars for the accommodation
Mandatory
Description
No
Specifies a maximum number of stars that the
accommodation should have.

SimpleType:
ServiceStarsType
anyType (restriction)

0..5

Specifies each star count to be included in the search.

1..1

Describes the total number and types of persons that


request the service, structured by room preferences.

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

Collection of room guest candidates. Can only request


adults and children (NO infants). For children, the age
is mandatory.

Page | 68

AIDA.WS Static Packages - Documentation


AccSearchRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_AccSearchRQ>
<ns:SearchCriteria ShowRequest="true">
<ns:DateRange DateStart="2011-05-09" DateEnd="2011-05-15"/>
<ns:Destination>
<ns:City ID="42"/>
</ns:Destination>
<ns:Rooms>
<ns:Room IndexNumber="1" Count="3">
<ns:GuestsCount>
<ns:GuestCount AgeQualifyingCode="a" Count="2" />
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="19"
</ns:GuestsCount>
</ns:Room>
</ns:Rooms>
</ns:SearchCriteria>
</ns:AIDA_AccSearchRQ>
</soapenv:Body>
</soapenv:Envelope>

/>

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of accommodation units

Page | 69

AIDA.WS Static Packages - Documentation


AccUnit

anyType (restriction)

Attribute
ID
Name
Stars

Type
positiveInteger
string
SimpleType:
ServiceStarsType

SEQUENCE
Type

0..*

Defines an accommodation service along with


its rooms and offers.
Mandatory
Description
Yes
The internal ID of the unit
Yes
Name of the accommodation unit
Yes
Number of stars of the accommodation
unit

Complex Type:
ServiceType

1..1

Type of accommodation unit

Destination

Complex Type:
LocalizationType

1..1

RoomStays

anyType (restriction)

1..1

Identifies the location of the accommodation


unit. City and country information will always
be provided. Region and location may appear if
they are entered in AIDA
Includes the found rooms based on the
requested search

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

Details on the Room Stay including guest


counts and financial information.
Mandatory
Description
Yes
Identifies a specific room search from the
request message

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..*

Represents a single room entity

0..1

Describes secondary services that may be


linked to this room

ExtendedComplex
Type:
SecondaryServiceCo
mponentType
with the attribute
below
Type
boolean

1..*

Represents one of the services that this room


might be linked to

Mand
Yes

Description
Indicates if this service is mandatory or
optional to purchase with this room
Page | 70

AIDA.WS Static Packages - Documentation


Element: Room/AccSearchRS
Element

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

Identifies the code and name of the room type. E.g.


SGL - Single Room, DBL - Double Room etc
1..1
Identifies the id and name of the room feature. E.g.
23 - Sea View
1..1
Contains information on the occupancy that matches
this room and its financial description
1..1
Describes the availability status of the room
Mandatory
Description
Yes
Describes a code that indicates the availability
of the room
No
Indicates the minimum available for this room.
Appears only if the minimum available rooms
number is lower than the requested room count
1..1
Includes price information about the room
0..1

Collection of possible rates

anyType (restriction)

1..*

Includes information for this rate

Type
positiveInteger
string
integer
string

Mandatory
Yes
No
No
No

Complex Type:
PriceType
string
anyType (restriction)

1..1

Includes price information about the rate

0..1
0..1

Text representing the description of the rate type


Collection of extra service references

anyType (restriction)

1..*

Type
positiveInteger

Description
Specifies the rate id
Specifies the rate name
Specifies the rate type id
Specifies the rate type name

Indicates a reference to a specific extra service that


this room may have.
Mandatory
Description
Yes
Unique numerical identifier of the extra service

Page | 71

AIDA.WS Static Packages - Documentation


AccSearchRS XML 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_AccSearchRS TimeStamp="2014-04-28T15:23:20+03:00" Version="1.0" RequestHost="192.168.1.151">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="14" Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:User Username="victor">Victor</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:AccUnits>
<ns1:AccUnit ID="305" Name="Ramada Brasov" Stars="5">
<ns1:Type Code="h">Hotel</ns1:Type>
<ns1:Destination>
<ns1:City ID="6" Name="Brasov"/>
<ns1:Country ID="1" Name="Romania"/>
</ns1:Destination>
<ns1:RoomStays>
<ns1:RoomStay IndexNumber="1">
<ns1:Service ID="5666" Name="Ramada Brasov">
<ns1:Rooms>
<ns1:Room ID="5666_DBL_5278_37890" Count="1">
<ns1:RoomType Code="DBL">Double</ns1:RoomType>
<ns1:Feature ID="5278">Garden View</ns1:Feature>
<ns1:Occupancy ID="37890">
<ns1:GuestCount AgeQualifyingCode="c" Count="1" MinAge="0" MaxAge="18"/>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:Occupancy>
<ns1:Availability Status="OK"/>
<ns1:Price Ammount="539.00" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="469.00"/>
<ns1:Commission Ammount="60.00"/>
<ns1:Tax Ammount="10.00"/>
</ns1:Price>
<ns1:Rates>
<ns1:Rate RateId="346" RateName="Set Accomodation 1" RateTypeId="5">
<ns1:Price Ammount="539.00" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="469.00"/>
<ns1:Commission Ammount="60.00"/>
<ns1:Tax Ammount="10.00"/>
</ns1:Price>
<ns1:Description>Rate pentru diferitele piete.</ns1:Description>
</ns1:Rate>
<ns1:Rate RateId="347" RateName="Set Accomodation 2" RateTypeId="6">
<ns1:Price Ammount="519.00" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="479.00"/>
<ns1:Commission Ammount="30.00"/>
<ns1:Tax Ammount="10.00"/>
</ns1:Price>
<ns1:Description>Rezervarea produselor care beneficiaza de tarife
&amp;quot;Inscrieri timpurii&amp;quot; este supusa anumitor termeni si conditii, conform regulilor
agentiei</ns1:Description>
</ns1:Rate>
</ns1:Rates>
<ns1:ExtraServicesRef>
<ns1:ExtraServiceRef ID="5670"/>
</ns1:ExtraServicesRef>
</ns1:Room>
</ns1:Rooms>
</ns1:Service>
</ns1:RoomStay>
</ns1:RoomStays>
<ns1:ExtraServices>
<ns1:ExtraService Mandatory="true">
<ns1:Service ID="5670" Name="Croaziera">
<ns1:Type Code="z">Cruise</ns1:Type>
<ns1:Supplier ID="19" Name="Supplier"/>
</ns1:Service>
</ns1:ExtraService>
</ns1:ExtraServices>
</ns1:AccUnit>
</ns1:AccUnits>
</ns1:AIDA_AccSearchRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 72

AIDA.WS Static Packages - Documentation

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

Includes information about the selected


period.

Complex Type:
DateTimeRangeType
anyType (restriction)

1..1

Type
positiveInteger

Mandatory
Yes

Defines a period by specifying the start and


end dates
Information that identifies the
accommodation and offer we are requesting
availability for.
Description
The internal ID of the unit.

anyType (restrictions)

1..1

Attribute

Type

Mandatory

Describes the rooms availability is being


asked for. All rooms selected for the
accommodation unit must be present in the
request.
Description

RateId
SEQUENCE
Room
Attribute
ID
Count

integer

No

The selected rate

anyType (restriction)
Type
string
positiveInteger

1..*
Mandatory
Yes
Yes

Describes a single room entity


Description
The ID of the room
Room multiplier

anyType (restriction)

0..1

Collection of extra services that availability is


requested for. If the requested rooms have
extraservices attached, this element becomes
mandatory for current method request.

anyType (restriction)

1..*

Type
string
date

Mandatory
Yes
Yes

Identifies a single service that availability


is requested for
Description
Unique identifier of the service
The start date of the service

SEQUENCE
DateRange
AccUnit

Attribute
ID
SEQUENCE
Rooms

SEQUENCE
ExtraServices

SEQUENCE
ExtraService
Attribute
ID
DateStart

1..1

Page | 73

AIDA.WS Static Packages - Documentation


DateEnd
RateId
SEQUENCE
GuestsCount
SEQUENCE
GuestCount

date
integer

Yes
No

The end date of the service


The selected rate

anyType (restriction)

1..1

Collection of guests count

anyType (restriction)

1..*

Attribute
AgeQualifyingCode

Type
Simple Type:
AgeQualifyingCodeType

Mandatory
Yes

Information that identifies a


guest
Description
Reference to a specific passenger
type based on a person's age

Count

positiveInteger

Yes

Age

positiveInteger

Yes

Determines the number of the


guests of the type identified by
AgeQualifyingCode
Determines the age of the guest

AccAvailRQ XML Sample


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="http://aida.dcsplus.net/ws/2010">
<SOAP-ENV:Header>
<ns1:AuthHeader>
<ns1:Username>victor</ns1:Username>
<ns1:Password>victor</ns1:Password>
<ns1:ResellerCode>dcst</ns1:ResellerCode>
</ns1:AuthHeader>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
<ns1:AIDA_AccAvailRQ>
<ns1:SearchCriteria>
<ns1:DateRange DateStart="2014-09-21" DateEnd="2014-09-23"/>
</ns1:SearchCriteria>
<ns1:AccUnit ID="305">
<ns1:Rooms RateId="347">
<ns1:Room ID="5666_DBL_5278_37890" Count="1">
<ns1:ExtraServices>
<ns1:ExtraService ID="5670" DateStart="2014-09-21" DateEnd="2014-09-23"
RateId="470">
<ns1:GuestsCount>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
<ns1:GuestCount AgeQualifyingCode="c" Count="1" Age="3"/>
</ns1:GuestsCount>
</ns1:ExtraService>
</ns1:ExtraServices>
</ns1:Room>
</ns1:Rooms>
</ns1:AccUnit>
</ns1:AIDA_AccAvailRQ>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 74

AIDA.WS Static Packages - Documentation

AIDA_AccAvailRS
Message Structure
Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
AccUnit
Attribute
ID
Name
Stars
SEQUENCE
Type

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Type
positiveInteger
string
SimpleType:
ServiceStarsType

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Includes information that describes an
accommodation unit
Mandatory
Description
Yes
The internal ID of the unit
Yes
Name of the accommodation unit
Yes
Number of stars of the accommodation
unit

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

Type of accommodation unit

Identifies the location of the accommodation


unit. City and country information will always
be provided. Region and location may appear if
they are entered in AIDA
1..1
Describes the overall availability status of the
unit
Mandatory
Description
Yes
Describes a code that indicates the
availability of the unit
1..1
Includes the found rooms based on the
requested search
Mandatory
No

Description
Specifies the rate id

1..*

Includes information about the room: room type,


feature, occupancy and availability and price
Mandatory
Description
Yes
A string construct that uniquely identifies the
current room
Yes
Numeric multiplier of current room
1..1
1..1
1..1

Identifies the code and name of the room type.


E.g. SGL - Single Room, DBL - Double Room etc
Identifies the id and name of the room feature.
E.g. 23 - Sea View
Contains information on the occupancy that
matches this room and its financial description
Page | 75

AIDA.WS Static Packages - Documentation


Availability
Attribute
Status
Price
CancelPenalties

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

Identifies a single service that availability is


requested for
Mandatory
Description
Yes
The start date of the service
Yes
The end date of the service
Yes
Specifies if the service is mandatory

anyType (restriction)

1..1

Identifies the secondary service that this extra


service represents

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

Includes price information about the extra


service. This is only filled for optional services.
Also the data is included in the room price.
Includes information about extra service rates
Description
Specified the rate used for price processing

anyType (restriction)

1..*

Specifies the rates for this extra service

Type
integer
string

Mandatory
Yes
No

Description
Specifies the rate id
Specifies the rate name

SEQUENCE
Page | 76

AIDA.WS Static Packages - Documentation


Price
CancelPenalties

Complex Type:
PriceType
Complex Type:
CancelPenaltiesType

0..1
0..1

Includes price information for this rate.


This is only filled for optional services.
This is only filled for optional services.
Also the data is included in the room
price.

Page | 77

AIDA.WS Static Packages - Documentation


AccAvailRS XML 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_AccAvailRS TimeStamp="2014-05-05T10:09:43+03:00" Version="1.0"
RequestHost="192.168.1.160">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="14" Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:User Username="victor">Victor</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:AccUnit ID="305" Name="Ramada Brasov" Stars="5">
<ns1:Type Code="h">Hotel</ns1:Type>
<ns1:Destination>
<ns1:City ID="6" Name="Brasov"/>
<ns1:Country ID="1" Name="Romania"/>
</ns1:Destination>
<ns1:Availability Status="OK"/>
<ns1:Rooms>
<ns1:Room ID="5666_DBL_5278_37890" Count="1">
<ns1:RoomType Code="DBL">Double</ns1:RoomType>
<ns1:Feature ID="5278">Garden View</ns1:Feature>
<ns1:Occupancy ID="37890">
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
<ns1:GuestCount AgeQualifyingCode="c" Count="1" MinAge="0" MaxAge="18"/>
</ns1:Occupancy>
<ns1:Availability Status="OK"/>
<ns1:ExtraServices>
<ns1:ExtraService DateStart="2014-09-21" DateEnd="2014-09-23" Mandatory="1">
<ns1:Service ID="5670">
<ns1:Description/>
</ns1:Service>
<ns1:GuestsCount>
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
<ns1:GuestCount AgeQualifyingCode="c" Count="1" Age="3"/>
</ns1:GuestsCount>
<ns1:Rates SelectedRate="470">
<ns1:Rate RateId="469" RateName="First set"/>
<ns1:Rate RateId="470" RateName="Second set"/>
</ns1:Rates>
</ns1:ExtraService>
</ns1:ExtraServices>
<ns1:Price Ammount="600" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="435"/>
<ns1:Commission Ammount="150"/>
<ns1:Tax Ammount="15"/>
</ns1:Price>
</ns1:Room>
</ns1:Rooms>
</ns1:AccUnit>
</ns1:AIDA_AccAvailRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 78

AIDA.WS Static Packages - Documentation

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

Additional data regarding reseller:


username and code
Description
The outside system reseller username
The outside system reseller code
Includes information about the selected
period.

Complex Type:
DateTimeRangeType
anyType (restriction)

1..1

Type
positiveInteger

Mandatory
Yes

Defines a period by specifying the start and


end dates
Information that identifies the
accommodation and offer that are being
reserved.
Description
The internal ID of the unit.

anyType (restrictions)

1..1

Describe the rooms being reserved

anyType (restriction)
Type
string
positiveInteger

1..*
Mandatory
Yes
Yes

Describes a single room entity


Description
The ID of the room
Room multiplier

anyType (restriction)

1..*

Type
positiveInteger

Mandatory
Yes

Collection of customers associated with this


room
Description
Indicates the specific room with which
the specified customers are associated
(this is used mostly for when the room
count is greater than one, but the
attribute is mandatory for all cases)

SEQUENCE
DateRange
AccUnit

Attribute
ID
SEQUENCE
Rooms
SEQUENCE
Room
Attribute
ID
Count
SEQUENCE
Customers
Attribute
RoomIndex

1..1

SEQUENCE
Page | 79

AIDA.WS Static Packages - Documentation


Customer

anyType (restriction)

1..*

Type
positiveInteger
String

Mandatory
Yes
Yes

anyType (restriction)

0..1

anyType (restriction)

1..*

Attribute

Type

Mandatory

ID

string

Yes

Unique identifier of the service

DateStart

date

Yes

The start date of the service

DateEnd

date

Yes

The end date of the service

RateId

integer

No

The selected rate

anyType (restriction)

1..1

Collection of guests count

anyType (restriction)
Type
Simple Type:
AgeQualifyingCodeType

1..*
Mandatory
Yes

Information that identifies a guest


Description
Reference to a specific passenger type
based on a person's age

positiveInteger

Yes

anyType (restrictions)

1..1

Determines the number of the guests of


the type identified by
AgeQualifyingCode
Indicate references to the defined
customers that have chosen this service

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

The customer entity associated with this


room
Description
Numeric identifier of the customer
Identifies the age limits of the segment
that this customer is associated with.
Example: AgeSegment="2-18". It is
mandatory for children.
Collection of extra services that are being
reserved.
Identifies a single service that is being
reserved
Description

Describes a single reference to a defined


customer
Description
Unique numerical identifier of a
customer
List of customers included in the book.
Provides information regarding a person
that is related to the booking action
Information that affects the reservation as a
whole
Information that is relevant for the booking
action
Message specifically addressed to the tour
operator. It is handled by a special message
system between the tour operator and
reseller.
Page | 80

AIDA.WS Static Packages - Documentation


AccBookRQ 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>victor</ns:Username>
<ns:Password>victor</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_AccNewBookRQ>
<ns:SearchCriteria>
<ns:DateRange DateStart="2014-09-21" DateEnd="2014-09-23"/>
</ns:SearchCriteria>
<ns:AccUnit ID="305">
<ns:Rooms RateId="346">
<ns:Room ID="5666_DBL_5278_37890" Count="1">
<ns:Customers RoomIndex="1">
<ns:Customer CustomerIndex="1" />
<ns:Customer CustomerIndex="2" />
<ns:Customer CustomerIndex="3" />
</ns:Customers>
<ns:ExtraServices>
<ns:ExtraService ID="5670" DateStart="2014-09-21" DateEnd="2014-09-23">
<ns:GuestsCount>
<ns:GuestCount AgeQualifyingCode="a" Count="2"/>
<ns:GuestCount AgeQualifyingCode="c" Count="1" Age="3"/>
</ns:GuestsCount>
<ns:Customers>
<ns:Customer CustomerIndex="1"/>
<ns:Customer CustomerIndex="2"/>
<ns:Customer CustomerIndex="3"/>
</ns:Customers>
</ns:ExtraService>
</ns:ExtraServices>
</ns:Room>
</ns:Rooms>
</ns:AccUnit>
<ns:Customers>
<ns:Customer CustomerIndex="1" Owner="1" AgeQualifyingCode="a">
<ns:PersonName>
<ns:FirstName>Ana</ns:FirstName>
<ns:LastName>Trandafir</ns:LastName>
</ns:PersonName>
</ns:Customer>
<ns:Customer CustomerIndex="2" AgeQualifyingCode="a">
<ns:PersonName>
<ns:FirstName>Elena</ns:FirstName>
<ns:LastName>Grecu</ns:LastName>
</ns:PersonName>
</ns:Customer>
<ns:Customer CustomerIndex="3" AgeQualifyingCode="c">
<ns:PersonName>
<ns:FirstName>Ioana</ns:FirstName>
<ns:LastName>Stan</ns:LastName>
</ns:PersonName>
</ns:Customer>
</ns:Customers>
</ns:AIDA_AccNewBookRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 81

AIDA.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Type
string

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information regarding the effects of the
booking action in the system
Mandatory
Description
No
Indicator of the result of the booking
action. If the booking was successful, the
status will be Reserved

Complex Type:
ReservationDataType

1..1

anyType (restriction)

1..1

Complex Type:
ReservationDataType

1..*

Information about the system reservation: id,


status, total price. This element will become
obsolete, and is kept only for compatibility
reasons. For new implementations please
avoid it.
Information about system reservations created

Information about the system reservation: id,


status, total price

AccBookRS XML 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_AccNewBookRS TimeStamp="2014-05-05T11:33:36+03:00" Version="1.0"
RequestHost="192.168.1.160">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="14" Code="DCST">DCS TRAVEL</ns1:Agency>
<ns1:User Username="victor">Victor</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:BookingReference>
<ns1:ReservationList>
<ns1:Reservation ID="1730000013" Code="SLZWJX" Status="OK"/>
</ns1:ReservationList>
</ns1:BookingReference>
</ns1:AIDA_AccBookRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 82

AIDA.WS Static Packages - Documentation

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

Information to search transfer

anyType (restriction)

1..1

Identifies the pick up point

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

Identifies the drop off point

Identifies the departure data

Page | 83

AIDA.WS Static Packages - Documentation

TransferSearchRQ 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>dcsplus</ns:Username>
<ns:Password>dcsplus</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_TransferSearchRQ>
<ns:Filters>
<ns:PickUp>
<ns:City ID="82"/>
<ns:Location Type="airport"/>
</ns:PickUp>
<ns:DropOff>
<ns:City ID="3"/>
<ns:Location Type="airport"/>
</ns:DropOff>
<ns:Departure Date="2013-05-29" Time="23:33:33"/>
<ns:PaxNumber>1</ns:PaxNumber>
<ns:LuggageNumber>1</ns:LuggageNumber>
</ns:Filters>
</ns:AIDA_TransferSearchRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 84

AIDA.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
0..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of transfers

anyType (restriction)

0..*

Type
string
String
String

Includes information that defines a single


transfer
Mandatory
Description
Yes
Unique identifier of the transfer
Yes
Name which describes the current transfer
Yes
Will indicate the current transfer type
(private/shared)
1..1

Defines the pick up part of the transfer


segment

1..1

Defines the drop off part of the transfer


segment

Description

Complex Type:
TransferSegmentPart
Type
Complex Type:
TransferSegmentPart
Type
String

0..1

Short text representing the transfer description

Durations

anyType (restriction)

1..1

Defines transfer durations. Ex. Total travel


time, waiting time

SEQUENCE
TransferDuration

positiveInteger

1..1

WaitingDuration

positiveInteger

1..1

anyType (restriction)

1..*

Identifies the transfer duration (PThHnM


format where n is the number of minutes, and
h number of hours), meaning the total time
spent from the pick up location to the drop off
location
Identifies the waiting duration (PThHnM format
where n is the number of minutes, and h
number of hours), meaning the total time that
the vehicle will wait for the travelers at the pick
up location until it will leave
List of available vehicles for this transfer

Complex Type:
TransferVehicleType

1..*

Dropff

Vehicles
SEQUENCE
Vehicle

Includes information that identifies a single


vehicle for this transfer

Page | 85

AIDA.WS Static Packages - Documentation

TransferSearchRS XML 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_TransferSearchRS TimeStamp="2013-06-19T14:39:24+03:00" Version="1.0"
RequestHost="192.168.1.136">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="victor"></ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:Transfers>
<ns1:Transfer ID="24-4081" Name="Ploiesti / from Ploiesti to Ploiesti">
<ns1:PickUp>
<ns1:Location ID="1" Name="Malu Rosu"/>
<ns1:City ID="2" Name="Ploiesti"/>
<ns1:Country ID="1" Name="Romania"/>
</ns1:PickUp>
<ns1:DropOff>
<ns1:Location ID="48" Name="Gara de sud"/>
<ns1:City ID="2" Name="Ploiesti"/>
<ns1:Country ID="1" Name="Romania"/>
</ns1:DropOff>
<ns1:Durations>
<ns1:TransferDuration>PT0H20M</ns1:TransferDuration>
<ns1:WaitingDuration>PT0H14M</ns1:WaitingDuration>
</ns1:Durations>
<ns1:Vehicles>
<ns1:Vehicle Code="std" Name="Standard car" MinPax="1" MaxPax="4" MaxLuggage="4">
<ns1:Availability Status="OK"/>
<ns1:Price Ammount="13.00" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="12.74"/>
<ns1:Commission Ammount="0.26"/>
<ns1:Tax Ammount="0.00"/>
</ns1:Price>
<ns1:CancelPenalties>
<ns1:CancelPenalty Start="2013-05-15" Ammount="55.00" CurrencyCode="RON"/>
<ns1:CancelPenalty Start="2013-05-17" Ammount="75.00" CurrencyCode="RON"/>
</ns1:CancelPenalties>
</ns1:Vehicle>
<ns1:Vehicle Code="lux" Name="Luxury car" MinPax="1" MaxPax="8" MaxLuggage="8">
<ns1:Availability Status="OK"/>
<ns1:Price Ammount="312.00" CurrencyCode="RON">
<ns1:SupplierPrice Ammount="305.76"/>
<ns1:Commission Ammount="6.24"/>
<ns1:Tax Ammount="0.00"/>
</ns1:Price>
</ns1:Vehicle>
</ns1:Vehicles>
<ns1:Description>Ploiesti - Ploiesti</ns1:Description>
</ns1:Transfer>
</ns1:Transfers>
</ns1:AIDA_TransferSearchRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 86

AIDA.WS Static Packages - Documentation

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

Information that identifies the transfer service

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

Offer details regard pick-up location type

0..1

Includes specific details or important notes


that might be relevant for the pick up location
Includes specific details or important notes
that might be relevant for the drop off location
Offer details regard drop-off location type

anyType (restriction)

Information required to identify the requested


vehicle
Mandatory
Description
Yes
The code of the requested vehicle
(specified in the search response)
1..1
Data regarding travel details

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)

Data regarding departure (date and time)


Page | 87

AIDA.WS Static Packages - Documentation


Attribute
Date
Time
Customers

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

Provides information regarding a person that is


related to the booking action
Information that affects the reservation as a
whole
Information that is relevant for the booking
action
Message specifically addressed to the tour
operator. It is handled by a special message
system between the tour operator and reseller

TransferBookRQ 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>test</ns:Username>
<ns:Password>test</ns:Password>
<ns:ResellerCode>ROT</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_TransferBookRQ>
<ns:Transfer ID="14-4069">
<ns:Vehicle Code="cmn"/>
</ns:Transfer>
<ns:TravelInfo LuggageNumber="2" PaxNumber="2">
<ns:Departure Date="2013-06-21" Time="15:22:12"/>
</ns:TravelInfo>
<ns:Customers>
<ns:Customer Owner="1" CustomerIndex="1" AgeQualifyingCode="a">
<ns:PersonName>
<ns:FirstName>Ioana</ns:FirstName>
<ns:LastName>Stoica</ns:LastName>
</ns:PersonName>
</ns:Customer>
</ns:Customers>
</ns:AIDA_TransferBookRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_TransferBookRS
Message Structure

Element

Type

Occurs

Description

CHOICE
Errors
SEQUENCE

ErrorsType

1..1

Collection of errors that may appear


Page | 88

AIDA.WS Static Packages - Documentation


POS
Success
Warnings
BookingReference
SEQUENCE
Reservation

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Information regarding the effects of the
booking action in the system

Complex Type:
ReservationDataType

1..1

Information about the system reservation: id,


status, total price

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

Includes information identifying the


reservation
Mandatory
Description
Yes
The reservation system ID

ReservationDetailsRQ 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>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.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Contains all information regarding the
reservation: ids, package details, customers,
information about components and cancel
penalties

anyType (restriction)

1..1

Includes all the reservation services, as


package components

0..1

Includes all information relative to the


package reservation service

anyType (restriction)

0..1

Information about the package

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

Describes a string that identifies that


package. This code is public and can be
viewed by all resellers that have access
to that package
Name of package
Category of package
Includes details of this component as part of
a reservation. Information described
includes: status on reservation, total price
(cumulated through all operations; e.g. if
the reservation service that this component
represents is cancelled, its total booking
Page | 90

AIDA.WS Static Packages - Documentation


reference price will be 0 )

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..*

Collection of cancellation penalties that


regard the package component
Includes all information relative to a tour
service component. A package may contain
only 1 tour service component (extended
with element ResService of type Complex
Type: ResServiceType)
Includes all information relative to an
accommodation component (extended with
element ResService of type Complex Type:
ResServiceType) and CancelPenalties of type
Complex Type: CancelPenaltiesType
Includes all information relative to a
transportation component (extended with
element ResService of type Complex Type:
ResServiceType)
Includes all information relative to a
secondary service component (extended
with element ResService of type Complex
Type: ResServiceType)
Includes all information relative to a
transfer service component

anyType (restriction)

1..1

Information about the service

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

Short text representing the transfer


description
Includes details of this component as part of
a reservation. Information described
includes: status on reservation, total price
(cumulated through all operations; e.g. if
the reservation service that this component
represents is cancelled, its total booking
reference price will be 0 )
List of customers included in the reservation
Provides information regarding a person
that is related to the reservation

Page | 91

AIDA.WS Static Packages - Documentation


Reservation

Complex Type:
ReservationDataType

1..1

Information that affects the reservation as a


whole

Page | 92

AIDA.WS Static Packages - Documentation


ReservationDetailsRS XML 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_ReservationDetailsRS TimeStamp="2011-04-07T16:20:11+03:00" Version="1.0" RequestHost="192.168.1.107">
<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/>
<ns1:ReservationDetails>
<ns1:Components>
<ns1:PackageComponent>
<ns1:Package ID="95" Type="holiday" Code="ARIST3" Name="Atena - Aristoteles 3*"/>
<ns1:ResService ID="1360000095" Status="OK">
<ns1:Price Ammount="0.00" CurrencyCode="EUR"/>
</ns1:ResService>
</ns1:PackageComponent>
<ns1:AccommodationComponent>
<ns1:Service ID="405" Name="Aristoteles" Stars="3" DurationTimeUnit="night">
<ns1:Type Code="h">Hotel</ns1:Type>
<ns1:Category Code="cls">Clasic</ns1:Category>
<ns1:Localization>
<ns1:City ID="41" Name="Atena"/>
<ns1:Country ID="12" Name="Grecia"/>
</ns1:Localization>
</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="106.08" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="84.00"/>
<ns1:Commission Ammount="18.48"/>
<ns1:Tax Ammount="3.60"/>
</ns1:Price>
<ns1:RoomStays>
<ns1:RoomStay IndexNumber="1">
<ns1:Rooms>
<ns1:Room ID="DBL_391_2067">
<ns1:RoomType Code="DBL">Cam. dubla</ns1:RoomType>
<ns1:Feature ID="391">sea view</ns1:Feature>
<ns1:Occupancy ID="2067">
<ns1:GuestCount AgeQualifyingCode="a" Count="2"/>
</ns1:Occupancy>
<ns1:Customers>
<ns1:Customer ResCustomerID="1360000194"/>
<ns1:Customer ResCustomerID="1360000195"/>
</ns1:Customers>
</ns1:Room>
</ns1:Rooms>
</ns1:RoomStay>
</ns1:RoomStays>
</ns1:ConfigurationData>
<ns1:ResService ID="1360000096" Status="OK">
<ns1:Price Ammount="106.08" CurrencyCode="EUR"/>
</ns1:ResService>
</ns1:AccommodationComponent>
<ns1:TransportationComponent>
<ns1:Service ID="407" Name="Atena - Bucuresti">
<ns1:Type Code="c">Charter</ns1:Type>
</ns1:Service>
<ns1:ConfigurationData>
<ns1:ServiceEntries>
<ns1:ServiceEntry ID="1370000037_1370000097">
<ns1:ItinerarySegment>
<ns1:Departure Date="2011-05-07" Time="16:00">
<ns1:City ID="41" Name="Atena"/>
</ns1:Departure>
<ns1:Arrival Date="2011-05-07" Time="17:20">
<ns1:City ID="3" Name="Bucharest"/>
</ns1:Arrival>
</ns1:ItinerarySegment>
</ns1:ServiceEntry>
</ns1:ServiceEntries>
<ns1:Price Ammount="556.80" CurrencyCode="EUR">
<ns1:SupplierPrice Ammount="360.00"/>
<ns1:Commission Ammount="46.80"/>
<ns1:Tax Ammount="150.00"/>
</ns1:Price>
</ns1:ConfigurationData>
<ns1:ResService ID="1360000097" Status="OK">
<ns1:Price Ammount="556.80" CurrencyCode="EUR"/>
</ns1:ResService>
</ns1:TransportationComponent>

[]
Page | 93

AIDA.WS Static Packages - Documentation

[]
<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

AIDA.WS Static Packages - Documentation

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

The cancelled object (only the id of the


reservation is required)
Message specifically addressed to the tour
operator. It is handled by a special message
system between the tour operator and
reseller. Includes cancellation remarks or other
relevant observations

Page | 95

AIDA.WS Static Packages - Documentation


ReservationCancelRQ 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>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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
Complex Type:
ReservationDataType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
The cancelled object

0..1

Collection of cancel penalties

anyType (restriction)

1..*

Type
decimal
CurrencyCodeTypes

Describes an ammount of penalty that can be


applied, expressed in a specific currency
Mandatory
Description
Yes
A monetary amount. Specifies an amount
Yes
The code specifying a monetary unit

Page | 96

AIDA.WS Static Packages - Documentation


ReservationCancelRS XML 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_ReservationCancelRS TimeStamp="2011-04-07T15:24:59+03:00" Version="1.0"
RequestHost="192.168.1.107">
<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/>
<ns1:Reservation ID="1360000038" Code="MHPIQU" Status="OK"/>
<ns1:CancelPenalties>
<ns1:Penalty Ammount="30.80" CurrencyCode="EUR"/>
</ns1:CancelPenalties>
</ns1:AIDA_ReservationCancelRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
</SOAP-ENV:Envelope>

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

Identifies the requested reservation


Description
Unique identifier of the reservation that the
remarks belong to

Page | 97

AIDA.WS Static Packages - Documentation


ReservationRemarksListRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_ReservationRemarksListRQ>
<ns:Reservation ID="1600000116"/>
</ns:AIDA_ReservationCancelRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_ReservationRemarksListRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
RemarksList

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
Complex Type:
RemarksListType

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Contains a list with all remarks on the
requested reservation

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

AIDA.WS Static Packages - Documentation

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

Identifies the requested reservation


Description
Unique identifier of the reservation that the
remarks belong to
Choose the sender type for the remark. If not
provided, the remark will be assigned to the
reseller
The text of the remark

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.WS Static Packages - Documentation

AIDA_ReservationRemarkAddRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
RemarksList

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
Complex Type:
RemarksListType

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Contains a list with all remarks on the
requested reservation

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

AIDA.WS Static Packages - Documentation

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

Describes the object that documents are


requested for
Mandatory
Description
Yes
The code of the list itself
A short descriptive title of the document.
The ID of the document object that
documents are requested for.

DocumentsListRQ 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>user</ns:Username>
<ns:Password>pass</ns:Password>
<ns:ResellerCode>RESCODE</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_DocumentsListRQ>
<ns:DocumentObject Type="Reservation" ID="1460000063"/>
</ns:AIDA_DocumentsListRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 101

AIDA.WS Static Packages - Documentation

AIDA_DocumentsListRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success
Warnings
Documents
SEQUENCE
Document
Attribute
ID
Type

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)

1..1
1..1
0..1
1..1

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of documents found.

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

DocumentsListRS XML 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_DocumentsListRS TimeStamp="2012-02-28T10:49:57+02:00" Version="1.0"
RequestHost="192.168.1.109">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="test">Campan Mirela (test)</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:Documents>
<ns1:Document ID="1460000063" Type="ReservationDetails"/>
<ns1:Document ID="1460000182" Type="Voucher"/>
<ns1:Document ID="1460000183-1460000146" Type="Voucher"/>
<ns1:Document ID="1460000183-1460000147" Type="Voucher"/>
<ns1:Document ID="1460000184-1460000146" Type="Voucher"/>
<ns1:Document ID="1460000184-1460000147" Type="Voucher"/>
</ns1:Documents>
</ns1:AIDA_DocumentsListRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 102

AIDA.WS Static Packages - Documentation

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

Describes the document that is being


requested
Mandatory
Description
Yes
The ID of the document being requested
Yes
The type of document being requested

DocumentGetRQ 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>user</ns:Username>
<ns:Password>pass</ns:Password>
<ns:ResellerCode>RESCODE</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_DocumentGetRQ>
<ns:Document ID="1460000063" Type="ReservationDetails"/>
</ns:AIDA_DocumentGetRQ>
</soapenv:Body>
</soapenv:Envelope>

AIDA_DocumentGetRS
Message Structure

Element
CHOICE
Errors
SEQUENCE
POS
Success

Type

Occurs

Description

ErrorsType

1..1

Collection of errors that may appear

POS_Type
anyType (restriction)

1..1
1..1

Point of Sale information


Marks the success of the message
Page | 103

AIDA.WS Static Packages - Documentation


Warnings
Document

WarningsType
base64Binary
(extension)
Type
string

0..1
1..1

Yes

Title
FileName

SimpleType:
DocumentType
string
string

FileSize

string

Yes

Attribute
ID
Type

Collection of warnings that may appear


Identifies the found document.

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.

DocumentGetRS XML Sample


** The <Document> content was truncated for the purpose of this documentation.
<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_DocumentGetRS TimeStamp="2012-02-28T10:52:46+02:00" Version="1.0" RequestHost="192.168.1.109">
<ns1:POS>
<ns1:Requestor>
<ns1:Agency ID="2" Code="ROT">ROMANIAN TOUR</ns1:Agency>
<ns1:User Username="test">Campan Mirela (test)</ns1:User>
</ns1:Requestor>
<ns1:BookingChannel Type="WS"/>
</ns1:POS>
<ns1:Success/>
<ns1:Document ID="1460000063" Type="ReservationDetails" FileName="Res. details - O58V9B.pdf"
FileSize="40818">JVBERi0xLjQKJaqrrK0KNCAwIG9iago8PAovUHJvZHVjZXIgKEFwYWNoZSBGT1AgVmVyc2lvbiAwLjk1KQovQ3JlYXRpb25EYX
RlIChEOjIwMTIwMjI4MTA1MjQ1KzAyJzAwJykKPj4KZW5kb2JqCjUgMCBvYmoKPDwKICAvTiAzCiAgL0xlbmd0aCAxNCAwIFIKICAvRmlsdGVyIC9Gb
GF0ZURlY29kZQo+PgpzdHJlYW0KeJydlndUU9kWh8+9N71QkhCKlNBraFICSA29SJEuKjEJEErAkAAiNkRUcERRkaYIMijggKNDkbEiioUBUbHrBBlE
1HFwFBuWSWStGd+8ee/Nm98f935rn73P3Wfvfda6AJD8gwXCTFgJgAyhWBTh58WIjYtnYAcBDPAAA2wA4HCzs0IW+EYCmQJ82IxsmRP4F726DiD5+
wOSAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDUwCi9Sb290IDIgMCBSCi9JbmZvIDQgMCBSCi9JRCBbPEZFOUQwOENGMjYxNzFGOEJCMUU2OTU1RU
RDNzY4MkZEPiA8RkU5RDA4Q0YyNjE3MUY4QkIxRTY5NTVFREM3NjgyRkQ+XQo+PgpzdGFydHhyZWYKMzk2NjMKJSVFT0YK</ns1:Document>
</ns1:AIDA_DocumentGetRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 104

AIDA.WS Static Packages - Documentation

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..*

Describes the requested list

Type
Simple Type:
CodesListType

Mandatory
Yes

Attribute
Type

Description
The code of the list itself

CodesListRQ 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>dcstravel</ns:Username>
<ns:Password>dcstravel</ns:Password>
<ns:ResellerCode>DCST</ns:ResellerCode>
</ns:AuthHeader>
</soapenv:Header>
<soapenv:Body>
<ns:AIDA_CodesListRQ>
<ns:List Type="AccTypes"/>
<ns:List Type="PackageCategories"/>
</ns:AIDA_CodesListRQ>
</soapenv:Body>
</soapenv:Envelope>

Page | 105

AIDA.WS Static Packages - Documentation

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

Collection of errors that may appear

POS_Type
anyType (restriction)
WarningsType
anyType (restriction)
Type
Simple Type:
CodesListType
string

1..1
1..1
0..1
1..*
Mand
Yes

Point of Sale information


Marks the success of the message
Collection of warnings that may appear
Collection of codes that constitute a list
Description
The code of the list itself

Yes

The name of the list

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

CodesListRS XML 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_CodesListRS TimeStamp="2011-04-07T17:47:58+03:00" Version="1.0" RequestHost="192.168.1.107">
<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/>
<ns1:List Type="AccTypes" Name="Accommodation Types">
<ns1:ListItem ID="n" Name="Apartament"/>
<ns1:ListItem ID="s" Name="Apt. familie"/>
<ns1:ListItem ID="z" Name="Altele"/>
</ns1:List>
<ns1:List Type="PackageCategories" Name="Package Categories">
<ns1:ListItem ID="cityBreak" Name="City break"/>
<ns1:ListItem ID="health" Name="Sanatate"/>
<ns1:ListItem ID="ski" Name="SKI"/>
</ns1:List>
</ns1:AIDA_CodesListRS>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Page | 106

AIDA.WS Static Packages - Documentation

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

A unique numerical identifier of the country


The name of the country
The ISO2 code of the country (restricted to 2 character length)
Latitude of the country
Longitude of the country

Page | 107

AIDA.WS Static Packages - Documentation

Complex Type: RegionType


Description
Information that identifies a region. If the region has a text description, it will be offered as the region element's content.
Attributes
Attribute

Type

Required

Description

ID
Name
CountryID
Latitude
Longitude

positiveInteger
string
positiveInteger
StringLength1to16
StringLength1to16

No
No
No
No
No

A unique numerical identifier of the region


The name of the region
A unique numerical identifier of the country
Latitude of the region
Longitude of the region

Page | 108

AIDA.WS Static Packages - Documentation

Complex Type: CityType


Description
Information that identifies a city. If the city has a text description, it will be offered as the city element's content.
Attributes
Attribute

Type

Required

Description

ID
Name
ISO3
CountryID
RegionID
Latitude
Longitude

positiveInteger
string
ISO3Code
positiveInteger
positiveInteger
StringLength1to16
StringLength1to16

No
No
No
No
No
No
No

A unique numerical identifier of the city


The name of the city
The ISO3 code of the city (restricted to 3 characters length)
Unique numerical identifier of the country
Unique numerical identifier of the city
Latitude of the city
Longitude of the city

Page | 109

AIDA.WS Static Packages - Documentation

Complex Type: LocationType


Description
Information that describes a location. If the location has a description, it will be included as the location's element
content.
Attributes
Attribute

Type

Required

Description

ID
Name
CityID
Type

positiveInteger
string
positiveInteger
string

No
No
No
No

Latitude
Longitude

StringLength1to16
StringLength1to16

No
No

A unique numerical identifier of the location


The name of the location
Unique numerical identifier of the city
Location type. Please review transfer location types codes list
for possible values
Latitude of the location
Longitude of the location

Page | 110

AIDA.WS Static Packages - Documentation

Complex Type: DateTimeRangeType


Attributes
Attribute

Type

Required

DateStart
TimeStart
DateEnd
TimeEnd
Duration

date
time
date
time
string

No
No
No
No
No

Description

Page | 111

AIDA.WS Static Packages - Documentation

Complex Type: LocalizationType


Description
Identifies a map location. City and country details are mandatory. Location, region and address details can also be
provided.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
City
Country
Region
Location
Address

Type

Occurs

Description

Complex Type:
CityType
Complex Type:
CountryType
Complex Type:
RegionType
Complex Type:
LocationType
string

1..1

Structure that identifies a city

1..1

Structure that identifies a country

0..1

Structure that identifies a region

0..1

Structure that identifies a location

0..1

Page | 112

AIDA.WS Static Packages - Documentation

Complex Type: ItinerarySegmentLocationType


Description
Defines a location that is part of an itinerary segment
Attributes
Attribute

Type

Required

Description

Date

date

No

Time

time

No

Place

string

No

Represents the date of the transportation (it can be a


departure date or an arrival date, depending on the location
type)
Represents the time of the transportation (it can be a
departure time or an arrival time, depending on the location
type)
The physical place of the segment (can be a meeting point of
some sort). This is optional.

Content Model
Contains elements as defined in the following table.
Element

Type

Occurs

Description

SEQUENCE
City
Country
Location

Complex Type: CityType


Complex Type: CountryType
Complex Type: LocationType

1..1
1..1
0..1

Identifies the city of the segment location.


Identifies the country of the segment location.
Idenfies the location of the segment

Page | 113

AIDA.WS Static Packages - Documentation

Complex Type: GuestsCountType


Description
Describes the GuestCount element structure
Content Model
Contains elements as defined in the following table.
Element

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

Determines the maximum age of the guest


count.
Identifies the exact age of the guest count

Page | 114

AIDA.WS Static Packages - Documentation

Complex Type: ServiceType


Description
Type of service - varies depending on service group. Construct is formed from code and name of service type.
Derived By
Extending string
Attributes
Attribute

Type

Required

Description

Code

string

No

Unique identifier of the service type

Page | 115

AIDA.WS Static Packages - Documentation

Complex Type: RoomElementType


Description
Describes the structure of a Room element. The name of the room type is provided as simple content.
Derived By
Extending string
Attributes
Attribute

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

AIDA.WS Static Packages - Documentation

Complex Type: FeatureElementType


Description
Describes the structure of the Feature element. The name of the feature is provided as simple content.
Attributes
Attribute

Type

Required

Description

ID

positiveInteger

Yes

AIDA internal code that identifies a single feature

Page | 117

AIDA.WS Static Packages - Documentation

Complex Type: OccupancyElementType


Description
Describes the structure of the occupancy element. It has an ID and details the structure of the passenger types it includes.
Derived By
Extending Complex Type: GuestsCountType
Attributes
Attribute

Type

Required

Description

ID

positiveInteger

Yes

The internal ID of the occupation

Content Model
Contains elements as defined in the following table.
Element

Type

Occurs

Description

SEQUENCE
GuestCount

anyType (restriction)

0..*

Information that identifies a guest

For the complete structure of the GuestCount element, see Complex Type: GuestsCountType

Page | 118

AIDA.WS Static Packages - Documentation

Complex Type: RoomStayType


Description
Details on the Room Stay including guest counts and finacial information.
Attributes
Attribute

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

Identifies the code and name of the room type. E.g.


SGL - Single Room, DBL - Double Room etc
Identifies the id and name of the room feature. E.g.
23 - Sea View
Contains information on the occupancy that matches
this room and its financial description

Identifies a customer associated with this room

Page | 119

AIDA.WS Static Packages - Documentation

Complex Type: PriceType


Description
Includes information about a specific price
Derived By
Restricting anyType
Attributes
Attribute

Type

Required

Description

Ammount
CurrencyCode

decimal
CurrencyCodeType

Yes
Yes

Quantity

positiveInteger

No

A monetary amount. Specifies an amount.


The code specifiying a monetary unit (currency code type is
restrictive to 3 character length)
Used to define the quantity for an associated element or
attribute

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

The supplier price component of the service total


price
The commission component of the service total price

0..1

The tax component of the service total price

Page | 120

AIDA.WS Static Packages - Documentation

Complex Type: PriceComponent


Description
A price component of the total price. The currency of the price ammount is given by the total price currency.
Attributes
Attribute

Type

Required

Description

Ammount

decimal

Yes

The monetary ammount of the price component

Page | 121

AIDA.WS Static Packages - Documentation

Complex Type: AccCategoryType


Description
Defines the category of an accommodation unit. Construct is formed from code and name of category.
Derived By
Extending string
Attributes

Attribute

Type

Required

Description

Code

string

Yes

Unique identifier of category (consult the AccCategories list


types for possible values of code)

Page | 122

AIDA.WS Static Packages - Documentation

Complex Type: CancelPenaltiesType


Description
Collection of cancel penalties
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
CancelPenalty

Type

Occurs

Description

Complex Type:
CancelPenaltyType

1..*

Defines a cancellation penalty

Page | 123

AIDA.WS Static Packages - Documentation

Complex Type: CancelPenaltyType


Description
Defines the cancellation penalty.
Attributes
Attribute

Type

Required

Description

Start

date

Yes

Ammount

decimal

Yes

Unique identifier of category (consult the AccCategories list


types for possible values of code)
A monetary amount. Specifies an amount.

CurrencyCode

CurrencyCodeType

Yes

The code specifying a monetary unit (restricted to 3 characters


length)

Page | 124

AIDA.WS Static Packages - Documentation

Complex Type: CustomerElementType


Description
Describes the specific structure of a customer element
Attributes
Attribute

Type

Required

Description

ResCustomerID

BigIntID

No

The system internal ID of the reservation customer

CustomerIndex

positiveInteger

No

CustomerType

string

No

Owner

boolean

No

BirthDate

date

No

AgeQualifyingCode

No

Gender
PNC

Simple Type:
AgeQualifyingCodeType
string
string

A positive integer that serves as reference and is used as


an index identifying this customer in the message
Describes the type of customer. Ex: if he is passenger or a
contact person
Identifies if the customer is the owner of the reservation
or not
The date of birth of the customer (it is mandatory for
children)
The passenger type that the customer's age qualifies it for.

Nationality
Telephone
Fax
Email

string
string
string
string

No
No
No
No

No
No

The gender of the customer


Personal Number Code. This is a number that uniquely
identifies the person in the country that it resided. It
doesnt't change throughout a person's life
The nationality of the customer
The telephone number of the customer
The fax number of the customer
The email address of the customer

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

Includes full details about the customer name


(PersonNameType is defined below)
Mandatory
Description
No
Indicates how the customer should be addressed:
Mr, Mrs, Ms etc
1..1
1..1
0..1
0..1

First name of the person


Last name of the person
Middle name of the person (if it exists)
Information regarding the customer's country specific
identification card (IDCardType is defined below)
Mandatory
Description
No
The series of the customer's id. Usually it is an
alphanumeric code.
Page | 125

AIDA.WS Static Packages - Documentation


Number
ReleasedBy

positiveInteger
string

ReleaseDate
Passport

date
PassportType

Attribute
Number
ExpireDate
Address
Country
City

Type
string
date
string
string
string

No
No

The number of the customer's id


The official authority that released the customer's
id
No
The date on which the id was released
0..1
Information regarding the customers passport
(PassportType is defined below)
Mandatory
Description
No
The number of the passport
No
The date on which the passport is due to expire
0..1
The address of the customer
0..1
The country of the customer in text
0..1
The city of the customer in text

Page | 126

AIDA.WS Static Packages - Documentation

Complex Type: ServiceElementType


Description
Standard information that a service can have
Attributes
Attribute

Type

Required

Description

ID
Name
Stars

string
string
SimpleType:
ServiceStarsType

Yes
No
No

Unique identifier of service


Name of service
Number of stars associated with the service

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

Type of service - varies depending on service group.


Construct is formed from code and name of service
type.
External supplier of service. Construct is formed from
ID and name of supplier.

Page | 127

AIDA.WS Static Packages - Documentation

Complex Type: ServiceEntriesType


Description
Collection of service entries
Attributes
Attribute

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

Includes essential information needed to inquire


about availability and prices. It is specific to the
component type (tour service)
Mandatory Description
Yes
Specific construct that uniquely identifies a
service entry

date
Complex Type:
DateTimeRangeType
Complex Type:
ItinerarySegmentLocationType
ItinerarySegmentType
(defined below)

1..1
1..1

Represents a single date in mysql format


A time span defined by a start and end date

1..1

An itinerary specific structure. Defines only the


start point of an itinerary segment.
An itinerary specific structure. Defines both start
and end points of an itinerary segment.

Complex Type:
ItinerarySegmentLocationType
Complex Type:
ItinerarySegmentLocationType

1..1

1..1

1..1

Defines the departure location that is part of


an itinerary segment
Defines the arrival location that is part of an
itinerary segment

Page | 128

AIDA.WS Static Packages - Documentation

Complex Type: ConfigurationDataType


Description
Describes the selected service configurations and also includes information about price and availability
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
ServiceEntries
Itinerary

SEQUENCE
Segment
Availability

Attribute
Status
Price

Type

Occurs

Description

Complex Type:
ServiceEntriesType
anyType (restriction)

1..1

Collection of service entries

0..1

Includes information about the itinerary of tour


transportation (appears in ReservationDetails
response message, in case of tour services)

Complex Type:
ItinerarySegmentLocationType
anyType (restriction)

1..*

Identifies a single itinerary segment.

0..1

Attribute
Simple Type: AvailableStsType

Informs if there is enough availability to


accommodate the requested guests in the
specified period and rooms
Mandatory Description
Yes
Describes the status code of the availability

Complex Type: PriceType

0..1

Includes price information regarding the


selected configuration

Page | 129

AIDA.WS Static Packages - Documentation

Complex Type: BookingRuleType


Description
Describes conditions that restrict the way a service can be configured and purchased.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
MaxTotalOccupancy
MinTotalOccupancy

Type

Occurs

Description

Complex Type:
GuestsCountType
Complex Type:
GuestsCountType

0..1

Describes the maximum pax count (per pax


type) that can purchase this service
Describes the minimum pax count (per pax type)
that can purchase this service

0..1

Page | 130

AIDA.WS Static Packages - Documentation

Complex Type: TourServiceComponentType


Description
Specific structure of a tour service component in a package.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Service
ServiceEntries
ConfigurationData

Type

Occurs

Description

Complex Type:
ServiceElementType
Complex Type:
ServiceEntriesType
Complex Type:
ConfigurationDataType

1..1

Structure that includes the service specific


information.
Collection of service entries

0..1
0..1

Describes the selected service configurations and also


includes information about price and availability

Page | 131

AIDA.WS Static Packages - Documentation

Complex Type: AccommodationComponentType


Description
Specific structure of an accommodation component in a package.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Service

SEQUENCE
Unit
Attribute
ID

Type

Occurs

Description

Extending
Complex Type:
ServiceElementType
with the elements
defined below

1..1

Structure that includes the service specific


information.

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

Includes details of the accommodation unit that is the


base of the service
Mandatory
Description
Yes
Numeric unique identifier of the accommodation
unit
0..1
Category of service. Appears only for some service
groups. Construct is formed from code and name of
category.
Mand
Description
No
Unique identifier of category
0..1
Telephone of service unit
0..1
E-mail of service unit
0..1
Details about the city, country, region and location of
service
0..1
Collection of service entries
0..1

Collection of possible room stays

Complex Type:
RoomStayType

1..*

Provides information about a room stay, including


details about the room, guests, availability and prices

Extending
Complex Type:
ConfigurationDataType
with the <RoomStays>
element defined below

0..1

Describes the selected service configurations and also


includes information about price and availability

anyType (restriction)

0..1

Collection of room stays

SEQUENCE

Page | 132

AIDA.WS Static Packages - Documentation


RoomStay

Complex Type:
RoomStayType

1..*

Provides information about a room stay, including


details about the room and guests

Page | 133

AIDA.WS Static Packages - Documentation

Complex Type: TransportationComponentType


Description
Specific structure of a transportation component in a package.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Service
ServiceEntries
ConfigurationData

Type

Occurs

Description

Complex Type:
ServiceElementType
Complex Type:
ServiceEntriesType
Complex Type:
ConfigurationDataType

1..1

Structure that includes the service specific


information.
Collection of service entries

0..1
0..1

Describes the selected service configurations and also


includes information about price and availability

Page | 134

AIDA.WS Static Packages - Documentation

Complex Type: SecondaryServiceComponentType


Description
Specific structure of a secondary service component in a package.
Content Model
Contains elements as defined in the following table.
Element
SEQUENCE
Service

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

Structure that includes the service specific


information.

Complex Type:
LocalizationType

0..1

Details about the city, country, region and location of


service

Complex Type:
ServiceEntriesType
Complex Type:
GuestsCountType
anyType (restriction)

0..1

Collection of service entries

0..1
0..1

Includes information about the number and type of


passengers that purchase the service
Collection of booking rules. Booking rules are
restrictions imposed on the reservation of a package
component

Complex Type:
BookingRuleType

1..*

Describes the booking rule

Complex Type:
ConfigurationDataType
Extended with the
elements below

0..1

Describes the selected service configurations and also


includes information about price and availability

Complex Type:
GuestsCountType

0..1

Includes information about the number and type of


passengers that purchase the service

anyType (restriction)

0..1

Describes the selected service configurations and also


includes information about price and availability

Complex Type:
CustomerElementType

1..*

List of customers associated with this service

Mandatory
No

Description
The time unit that the duration of service is
measured in. E.g. day, night

Page | 135

AIDA.WS Static Packages - Documentation

Complex Type: ReservationDataType


Description
Includes information that is not specific to any service, but to the reservation as a whole
Attributes
Attribute

Type

Required

Description

ID
Code

BigIntID
ReservationCodeType
(restricted to 6 char
length)
Simple Type:
ReservationStsType

Yes
No

The system ID of the reservation


An internal code awarded by the system to the
reservation. It identifies the reservation and all of its
derivates
Describes the state of the reservation within the system

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

The total price of the reservation

0..1

List of reservation services with their IDs and


Status

Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType
Complex Type:
ResServiceType

0..1

Provides short info about a package service


component on a reservation
Provides short info about a tour service
component on a reservation
Provides short info about an accommodation
component on a reservation
Provides short info about a transportation
component on a reservation
Provides short info about a secondary service
component on a reservation
Provides short info about a transfer component on
a reservation

0..1
0..*
0..*
0..*
0..*

Page | 136

AIDA.WS Static Packages - Documentation

Complex Type: ResServiceType


Description
Includes information that is specific to a reservation service.
Attributes
Attribute

Type

Required

Description

ID
Status

BigIntID
Simple Type:
ReservationStsType
String

Yes
No

The ID of the reservation service


The status of the service on reservation. Indicates the
availability status.
The external confirmation number of the reservation
service. May appear only if the status of the service is OK.
This attribute may appear in ReservationDetailsRS
message.

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

The period interval that the reservation service is


extended on. Appears only for package
reservation service.
Offers price information about the service on
reservation
The cancel penalties associated with this specific
service

0..1

Page | 137

AIDA.WS Static Packages - Documentation

Complex Type: TransferResServiceType


Description
Includes information specific to transfer service
Extends: ResServiceType
Attributes
Attribute

Type

Required

Description

Vehicle
VehicleName

string
String

Yes
Yes

The vehicle type that has been booked


The vehicle name that has been booked

Content Model
Contains elements as defined in the following table.
Element

Type

Occurs

Description

ExtendedComplex Type:
TransferSegmentPartType
with element below
String

1..1

The pickup location

0..1

Extended Complex Type:


TransferSegmentPartType
with element below
String

1..1

Includes specific details or important notes


that might be relevant for the location
The drop-off location

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

Includes specific details or important notes


that might be relevant for the location
Identifies all the information regarding the
departure.
Description
Identifies the departure date of the transfer
service.
Identifies the time date of the transfer
service.
Contains details about durations, like
transfer duration and waiting time
Identifies the transfer duration in minutes
(PThHnM format where n is the number of
minutes, and h number of hours), meaning
the total time spent from the pickup location
to the drop off location
Identifies the waiting duration in minutes
(PThHnM format where n is the number of
minutes, and h number of hours), meaning
the total time that the vehicle will wait for
the travelers at the pickup location until it
will leave
Page | 138

AIDA.WS Static Packages - Documentation

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..*

Describes a specific segment from the itinerary

anyType (restriction)

1..1

Type
date
date
string

Complex Type:
CityType
anyType (restriction)
Type
date
date
string

Complex Type:
CityType

Includes details about location, date and time of the


departure.
Mandatory Description
Yes
The date of the departure
Yes
The time of the departure
No
The physical place of the departure (can be a
meeting point of some sort). This is optional.
1..1

The city of the departure

1..1

Includes details about location, date and time of the


departure.
Mandatory Description
Yes
The date of the arrival
Yes
The time of the arrival
No
The physical place of the arrival (can be a
meeting point of some sort). This is optional.
1..1

Includes details about location, date and time of the


arrival.

Page | 139

AIDA.WS Static Packages - Documentation

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

Identifies the code and name of the room type.


E.g. SGL - Single Room, DBL - Double Room etc
Identifies the ID and name of the room feature.
E.g. 23 Sea view
The types and numbers that the passengers in
this room can have.

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

Identifies the departure location. Includes city


and country names
Mandatory
Description
Yes
Yes
No

No

1..1

Includes details about the city where the


accommodation is located

anyType(restriction)

0..1

This is an optional element that appears only for


tour packages. For holiday packages, the entry
period is also the accommodation period. For
tour, each accommodation date of each service is
specified within this element.

string

1..*

Specifies a single accommodation date.

Attributes
Attribute

Type

Required

Description

UnitID

positiveInteger

No

Name
Stars

string
positiveInteger

Yes
Yes

Numeric unique identifier of the accommodation unit.


Appears if a unit is associated with the service.
The name of the accommodation service.
The stars ranking of the acommodation service.
Page | 140

AIDA.WS Static Packages - Documentation


RoomID
RoomName

string
String

Yes
Yes

Unique identifier of current room and service


The name of the current room (is formed by room type
name, feature name and occupancy information)

Page | 141

AIDA.WS Static Packages - Documentation

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).

Includes details about location, date and time of the


departure.
Mandatory
Description
Yes
The date of the departure
Yes
The time of the departure
No
The carrier of the first segment of the outbound
transportation service(appears only in the
PackAvailRS).
1..1

The city of the departure

0..1

The location of the departure

1..1

Includes details about location, date and time of the


departure.
Mandatory
Description
Yes
The date of the arrival
Yes
The time of the arrival
1..1

Includes details about location, date and time of the arrival.

0..1

The location of the departure

Page | 142

AIDA.WS Static Packages - Documentation

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

Indicates if the current configuration is available for


booking

Page | 143

AIDA.WS Static Packages - Documentation

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

The price details of the rate

0..1

Short description of the rate

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

AIDA.WS Static Packages - Documentation

Page | 145

AIDA.WS Static Packages - Documentation

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

Identifies the reservation that the listed remarks are on

Type
BigIntID

Mandatory
Yes

anyType (restrictions)

0..1

List of remarks. If no remarks exist on the requested


reservation, this element does not appear.

anyType (restriction)
Type
dateTime

1..*
Mand
Yes

Details about the remark


Description
The time when the remark was added

string

No

Name of the person who first read the remark

ComplexType:
SenderType
string

1..1

The type of agency who wrote the remark.

1..1

The text of the remark

Attributes
ID
Remarks
SEQUENCE
Remark
Attribute
AddTime
ReadByUser
SEQUENCE
Sender
RemarkText

Description
Unique identifier of the reservation

Page | 146

AIDA.WS Static Packages - Documentation

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

The type of sender that is performing the request

Yes

The name of the person sending the request

Type
Name

Description

Page | 147

AIDA.WS Static Packages - Documentation

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

Identifies the location

1..1

Identifies the city

1..1

Identifies the country

Page | 148

AIDA.WS Static Packages - Documentation

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

Offers details about the availability of this vehicle

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

Collection of cancel penalties specific of the service

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

AIDA.WS Static Packages - Documentation

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

Identifies the pick-up/drop-off location.

Address

string

0..1

Identifies the address for pick-up/drop-off location.

PostalCode

string

0..1

Identifies the postal code for pick-up/drop-off location.

Airline

string

0..1

Identifies the airline for pick-up/drop-off location.

Flight

string

0..1

Identifies the flight for pick-up/drop-off location.

Terminal

string

0..1

Identifies the terminal for pick-up/drop-off location.

Time

string

0..1

Identifies the time for pick-up/drop-off location.

Route

string

0..1

Identifies the route for pick-up/drop-off location.

Number

string

0..1

Identifies the number for pick-up/drop-off location.

Page | 150

AIDA.WS Static Packages - Documentation

SIMPLE TYPES
Simple Type: PackageType
Description
Describes possible values of package type
Derived By
Restricting string
Enumeration
Value

Description

holiday
tour

Page | 151

AIDA.WS Static Packages - Documentation

Simple Type: AgeQualifyingCodeType


Description
Describes the standard passenger types derived from age.
Enumeration
Value

Description

a
c
i

Describes an adult
Describes a child
Describes an infant

Page | 152

AIDA.WS Static Packages - Documentation

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

AIDA.WS Static Packages - Documentation

Simple Type: AvailableStsType


Description
Enumerates possible availability statuses
Derived By
Restricting string
Enumeration
Value

Description

OK
RQ
NA

Describes an available service.


Indicates that the service is only available on request.
Indicates that the service is not available for the selected configuration

Page | 154

AIDA.WS Static Packages - Documentation

Simple Type: DurationTimeUnitType


Description
Describes possible values of duration time unit
Derived By
Restricting string
Enumeration
Value

Description

day
night

Page | 155

AIDA.WS Static Packages - Documentation

Simple Type: ReservationStsType


Description
Describes the statuses that a reservation can have.
Enumeration
Value

Description

RQ
OK
XX
AM

Identifies a reservation in request


Identifies a confirmed reservation
Identifies a cancelled reservation
Identifies an ammended reservation

Page | 156

AIDA.WS Static Packages - Documentation

Simple Type: CodesList Type


Description
Offers the possible list types that can be requested
Derived By
Restricting string
Enumeration
Value

Description

AccTypes
AccRoomTypes
AccCategories
AccFacilities
TranspTypes
SecondServTypes
TourServTypes
PackageCategories

Requests the list of accommodation types.


Requests the list of room types.
Requests the list of accommodation categories.
Requests the list of accommodation facilities.
Requests the list of transportation types
Requests the list of secondary service types
Requests the list of tour service types
Requests the list of package categories

Page | 157

AIDA.WS Static Packages - Documentation

Simple Type: AgeQualifyingCodeTypeRQ


Description
Describes the standard passenger types derived from age, used in request messages.
Enumeration
Value

Description

a
c

Describes an adult
Describes a child

Page | 158

AIDA.WS Static Packages - Documentation

SimpleType: AgeQualifyingCode TypeRS


Description
Describes the standard passenger types derived from age, used in response messages.
Enumeration
Value

Description

a
c
i

Describes an adult
Describes a child
Describes an infant

Page | 159

AIDA.WS Static Packages - Documentation

SimpleType: DocumentObjectType
Description
Offers the possible document object types that documents can be requested for
Enumeration
Value

Description

Project
Package
Reservation
ReservationService

Requests the list of documents for a project


Requests the list of documents for a package
Requests the list of documents for a reservation
Requests the list of documents for a reservation service.

Page | 160

AIDA.WS Static Packages - Documentation

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

AIDA.WS Static Packages - Documentation

Simple Type: TransferLocationType


Description
List of possible transfer location types
Derived By
Restricting string
Enumeration
Value

Description

accommodation
airport
station
port
other

The location type represents an accommodation


The location type represents an airport
The location type represents a station
The location type represents a port
The location type represents any other type of locations

Page | 162

Potrebbero piacerti anche