Public API for Circuits/Packages
Public Core Ofi Online Circuit Reservation Protocol
Version 2.0 December 2017
Introduction and Contact
This documentation describes the set of web service methods developed by Ofimática Jaén SL with the aim of making online reservations for circuits.
The aim of this web service is XML access to circuit availability, as well as the ability to make reservations and cancellations in the system.
The following documentation describes the structure of the messages to be sent in each method, as well as the response obtained in each of them. In addition, examples of each of them are attached.
For any questions or issues during use, you can contact us Monday to Friday, from 09:00 to 14:00 and from 16:00 to 19:00 at the following phone number 953 280 144.
Webservice
- Methods used in the booking flow
The operations available to request availability, generate a booking and its subsequent cancellation are the following:
| Service | Description |
|---|---|
| SearchToursInArea | Initial search for circuits by area (4 points) and date range. It will return products with destinations (itinerary and destination of the product) in that area, with some departure date for that range. |
| GetAccommodationsAvailables | Once the product and departure date are known, we try to find available combinations of accommodations for the requested rooms. |
| GetBookingBus (Optional) | Request for bus seats for a package that allows seat selection. |
| CheckAvailability | In this method, the combination of rooms and selected extra nights is selected. |
| PreBooking | Makes a temporary block of package places. |
| Booking | Confirm the reservation |
| CancelBooking | Carry out a cancellation of a confirmed reservation |
- Booking flow
| Enviroment | Endpoint |
|---|---|
| TEST | http://booking.ofi.es/Test/ToursBookingService.svc?wsdl |
| LIVE | http://booking.ofi.es/ToursBookingService.svc?wsdl |
- Additional Methods to the Reservations Flow
Below are the available operations in the system that are additional to the reservations flow. These will be used to obtain static information that will be used to make a reservation or to query detailed information about a reservation.
| Service | Description |
|---|---|
| GetToursInfo | Request for descriptive content of a tour |
| GetBookingInfo | Query information about a reservation |
SearchToursInArea
This section describes the request and response for searching tours in the system based on an area defined by a pair of geographic coordinates (northeast and southwest latitude and longitude) and dates (from/to).
The system will return a list of tours whose itinerary touches the requested area and has defined departures between the requested dates.
Request
| Field | Cardinality | Description |
|---|---|---|
| SearchToursInAreaRequest | 1 | Root element of the search tours request |
| 1. ConsumerId | 1 | Consumer identifier |
| 2. LanguageIsoCode | 1 | ISO code of the language |
| 3. DepartureStartDateForSearch | 1 | Start date of the search range |
| 4. DepartureEndDateForSearch | 1 | End date of the search range |
| 5. NothEastLatitude | 1 | North-east latitude |
| 6. NothEastLongitude | 1 | North-east longitude |
| 7. SouthWestLatitude | 1 | South-west latitude |
| 8. SouthWestLongitude | 1 | South-west longitude |
| 9. ProviderData | 0 | This field should not be sent via XML |
| 10. InternalAgencyData | 0 | This field should not be sent via XML |
Response
| Field | Cardinality | Description |
|---|---|---|
| SearchToursInAreaResponse | 1 | Root element of the circuit search response |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there is any error |
| 3. Message | 0..1 | In case of an error, it contains the description of the error |
| 4. Warnings | 0 | This field should not be taken into account via XML |
| 5. ToursDeparturesPrices | 0..N | List of circuits obtained as a result of the search |
| 5.1 Code | 1 | Code of the circuit |
| 5.2 Name | 1 | Name of the circuit |
| 5.3 ImageUrl | 1 | Associated image URL |
| 5.4 CommisionPercentage | 1 | Client's commission percentage for this circuit |
| 5.5 ExtraNightsInfo | 0..1 | Information about extra nights |
| 5.5.1 AllowToChangeStartData | 1 | Allows extra nights ahead |
| 5.5.2 AllowToChangeEndDate | 1 | Allows extra nights behind |
| 5.5.3 NumberOfNightsAllowedToChange | 1 | Number of nights allowed to change |
| 5.6 PricesFromForDepartures | 1..N | List of departures and their prices |
| 5.6.1 StartDate | 1 | Departure date |
| 5.6.2 EndDate | 1 | Arrival date |
| 5.6.3 Price | 1 | Price of the departure |
| 5.6.3.1 Amount | 1 | Amount of the departure |
| 5.6.3.2 Commission | 1 | Commission Percentage |
| 5.6.3.3 Mandatory | 1 | True if the Amount price is mandatory |
| 5.6.3.4 Cost | 1 | Net cost of the output |
| 5.6.3.5 Currency | 1 | Currency |
| 5.6.3.6 PriceLineThrough | 1 | "Struck-through" price. Price before applying discounts. |
| 6 ProviderName | 1 | Name of the circuit provider. |
| 7 Observations | 0..1 | Public observations about the circuit. |
| 8 Features | 0..N | Distinctive features of the circuit. |
| 8.1 Features | 1 | Id of the distinctive feature. |
| 8.2 Description | 1 | Description of the distinctive feature. |
| 8.3 Image | 1 | Url of the image of the distinctive feature. |
Example request
Example response
GetAccommodationsAvailables
This section describes the request and response for obtaining available accommodations based on requested rooms. That is, once the product and departure date are known, it is necessary to find combinations of available accommodations for the requested rooms.
Request
| Field | Cardinality | Description |
|---|---|---|
| GetAccommodationsAvailablesRequest | 1 | Root element of the request for searching combinations of available accommodations |
| 1. ConsumerId | 1 | Identifier of the consumer |
| 2. LanguageIsoCode | 1 | ISO code of the language |
| 3. SessionId | 1 | Unique identifier of the session obtained in SearchToursInArea |
| 4. DepartureDate | 1 | Start date of the selected departure |
| 5. TourReferenceCode | 1 | Id of the package to be booked |
| 6. Rooms | 1..N | List of requested rooms |
| 6.1 PassengersAges | 1..N | List of ages of passengers in the corresponding room |
| 7. ProviderData | 0 | This field should not be sent via XML |
| 8. InternalAgencyData | 0 | This field should not be sent via XML |
Response
Request Example
Response example
GetBookingBus
This section describes the request and response of the method to retrieve information about the seats of a bus. This method should only be called if we get the "HasSelectionBusSeats" field in availability to be "true".
The response will provide us with the distribution of occupied and available seats on the bus.
Request
| Field | Cardinality | Description |
|---|---|---|
| GetAccommodationsAvailablesResponse | 1 | Root element of the response for searching combinations of available accommodations |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there is an error |
| 3. Message | 0..1 | In case of an error, it contains the description of the error |
| 4. Warnings | 0 | This should not be taken into account via XML |
| 5. Accommodations | 1..N | List of available accommodations |
| 5.1 Code | 1 | Accommodation code |
| 5.2 Description | 1 | Accommodation description |
| 5.3 TourCategoryCode | 1 | Accommodation category code |
| 5.4 TourCategoryName | 1 | Accommodation category name |
| 5.5 Price | 1 | Price of the departure |
| 5.5.1 Amount | 1 | Amount of the departure |
| 5.5.2 Commission | 1 | Commission percentage |
| 5.5.3 Mandatory | 1 | True if the Amount price is mandatory price |
| 5.5.4 Cost | 1 | Net cost of the departure |
| 5.5.5 Currency | 1 | Currency |
| 5.5.6 PriceLineThrough | 1 | "Struck-through" price. Price before discount application |
| 5.5.7 Taxes | 1 | Taxes amount |
| 5.5.8 FeeDetails | 0..1 | Fee details |
| 5.5.8.1 TotalFee | 0..1 | Total amount of the fee |
| 5.5.8.2 PerPax | 0..1 | Total fee amount per person |
| 5.5.8.3 NumberOfPaxes | 0..1 | Number of passengers |
| 5.5.8.4 PerBooking | 0..1 | Total fee amount per booking |
| 5.6 ConceptIds | 0..1 | List of accommodation concept identifiers. These identifiers can be used to obtain cabin information, in the case of cruises, using the GetToursInfo method |
| 6 HasSelectionBusSeats | 1 | Has bus seat selection |
| 7 ExtraNightsInfo | 0..1 | Extra nights information |
| 7.1 AllowToChangeStartDate | 1 | Indicates whether the itinerary allows modifying the departure date (by adding or removing nights) |
| 7.2 AllowToChangeEndDate | 1 | Indicates whether the itinerary allows modifying the arrival date (by adding or removing nights) |
| 7.3 NumberOfNightsAllowedToChange | 1 | Number of nights that can be added or removed from the itinerary |
| 8 Areas | 0..N | List of areas for the stops |
| 8.1 Code | 1 | Area code |
| 8.2 Description | 1 | Description of the area |
| 8.3 Stops | 1..N | List of stops |
| 8.3.1 Code | 1 | Stop code |
| 8.3.2 Description | 1 | Description of the stop |
| 8.3.3 PickUpTime | 1 | Pick-up time at the stop |
| 9 CancellationPolicy | 1 | Cancellation policy for the booking |
| 9.1 Description | 1 | Description of the cancellation policy |
| 9.2 NotRepayable | 1 | Indicates whether the booking is non-refundable |
| 9.3 Title | 1 | Title of the cancellation policy |
| 10 ConfigurationForSearchDynamicFlights | 0 | This field should not be considered via XML. |
| Field | Cardinality | Description |
|---|---|---|
| BookingBusRequest | 1 | Root element of the bus seat information request for a tour |
| 1. ConsumerId | 1 | Consumer identifier |
| 2. LanguageIsoCode | 1 | ISO code for the language |
| 3. TourReferenceCode | 1 | ID of the tour |
| 4. SessionId | 1 | Session identifier |
| 5. ProviderId | 0 | Provider identifier. Should not be sent via XML |
| 6. DepartureStartDate | 1 | Date of departure for the tour |
Response
| Field | Cardinality | Description |
|---|---|---|
| BookingBusResponse | 1 | Root element of the bus seat information response for a tour |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there is any error |
| 3. Message | 0..1 | If there is an error, it contains a description of it |
| 4. ListBookingBus | 1..N | List of bookings for the product |
| 4.1 CodeBooking | 1 | Booking code |
| 4.2 Description | 1 | Name of the booking |
| 4.3 ListVehicle | 1..N | List of vehicles |
| 4.3.1 VehicleId | 1 | Vehicle ID |
| 4.3.2 Description | 1 | Description of the vehicle |
| 4.3.3 Seats | 1..N | List of seats on the vehicle |
| 4.3.4 Column | 1 | Seat column |
| 4.3.5 Row | 1 | Seat row |
| 4.3.6 Available | 1 | True if the seat is available, false if it is occupied |
Example request
Example response
CheckAvailability
This method selects the combination of rooms and extra nights chosen.
Request
| Field | Cardinality | Description |
|---|---|---|
| CheckTourAvailavilityRequest | 1 | The root element of the request that launches the availability search for the package and dynamic services |
| 1. ConsumerId | 1 | The identifier of the consumer |
| 2. LanguageIsoCode | 1 | The ISO code for the language |
| 3. TourReferenceCode | 1 | The ID of the circuit to be booked |
| 4. AccommodationCode | 1 | The ID of the accommodation to be booked |
| 5. OriginAirportCode | 0 | This field should not be sent via XML |
| 6. ExcludeFlightsSearch | 0 | This field should not be sent via XML |
| 7. SessionId | 1 | The unique identifier of the session |
| 8. StayDateRange | 1 | The selected dates (in YYYY-MM-DD format) |
| 8.1. DepartureStartDate | 1 | The start date, to identify the selected departure |
| 8.2. DepartureEndDate | 1 | The end date of the selected departure |
| 8.3. SelectedStartDate | 1 | The actual chosen start date (may differ from DepartureStartDate if extra nights are chosen) |
| 8.4. SelectedEndDate | 1 | The actual chosen end date (may differ from DepartureEndDate if extra nights are chosen) |
| 9. ProviderData | 0 | This field should not be sent via XML |
Response
| Field | Cardinality | Description |
|---|---|---|
| CheckTourAvailavilityResponse | 1 | Root element of the circuit search response |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there is any error |
| 3. Message | 0..1 | Contains the error description in case of an error |
| 4. Warnings | 0 | Not to be taken into account via XML |
| 5. SessionId | 1 | Unique identifier of the session |
| 6. DynamicSelection | 1 | This field should not be taken into account via XML |
| 7. ItineraryInfo | 0..1 | Package itinerary |
| 7.1. Days | 1..N | List of days in the itinerary |
| 7.1.1. Date | 1 | Date of the day on the calendar |
| 7.1.2. DayNumber | 1 | Day number of the itinerary |
| 7.1.3. DayType | 1 | Day type |
| 7.1.4. Title | 1 | Title of the day |
| 7.1.5. ShortDescription | 1 | Short description of the day |
| 7.1.6. Description | 1 | Long description of the day |
| 7.1.7. Foot | 1 | Description of the foot of the day |
| 7.1.8. Origin | 1 | Origin of the day |
| 7.1.9. Destiny | 1 | Destination of the day |
| 7.1.10. Services | 1..N | List of services for the day |
| 7.1.10.1. Description | 1 | Description of the service |
| 7.1.10.2. ServiceType | 1 | Service Type |
| 7.1.11. PlacesVisited | 0..N | List of places visited in the day |
| 7.1.11.1. Code | 1 | Code of the visited place |
| 7.1.11.2. Name | 1 | Name of the visited place |
| 7.1.11.3. Latitude | 1 | Latitude of the visited place |
| 7.1.11.4. Longitude | 1 | Longitude of the visited place |
Request Example
Example response
PreBooking
This section describes the request and response of the method for reserving accommodations for a circuit, a method for pre-booking the circuit.
As a response, we will obtain the final price of the reservation.
Request
| Field | Cardinality | Description |
|---|---|---|
| PreBookingRequest | 1 | The root element of the circuit pre-booking request |
| 1. ConsumerId | 1 | The consumer's identifier |
| 2. LanguageIsoCode | 1 | ISO code for the language |
| 3. ProviderData | 0 | This field should not be sent via XML |
| 4. InternalAgencyData | 0 | This field should not be sent via XML |
| 5. SessionId | 1 | Unique identifier for the session |
| 6. IdStop | 0..1 | Code for the selected pickup stop if applicable |
| 7. IdRoute | 0..1 | Code for the route of the pickup stop if applicable |
| 8. BookingSelection | 0..N | List of bus selections |
| 8.1 CodeBooking | 1 | Booking ID |
| 8.2 Vehicle | 1..N | List of vehicles in the booking |
| 8.2.1 VehicleId | 1 | Vehicle ID |
| 8.2.2 Seats | 1..N | List of seats in the vehicle |
| 8.2.2.1 Column | 1 | Column where the seat is located |
| 8.2.2.2 Row | 1 | Row where the seat is located |
| 9 DynamicSearchsSelection | 1 | This field should not be sent via XML |
Response
| Field | Cardinality | Description |
|---|---|---|
| PreBookingResponse | 1 | The root element of the circuit pre-booking response |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there's an error |
| 3. Message | 0..1 | If there's an error, contains its description |
| 4. SessionId | 1 | Session identifier |
| 5. RateQuote | 1 | The rate quote |
| 5.1 BookingCode | 1 | The pre-booking code. It will be necessary for the booking process |
| 5.2 StartDate | 1 | The start date of the circuit |
| 5.3 EndDate | 1 | The end date of the circuit |
| 5.4 Price | 1 | The price of the booking |
| 5.4.1 Amount | 1 | The amount of the booking |
| 5.4.2 Commission | 1 | The commission percentage |
| 5.4.3 Mandatory | 1 | True if the amount price is mandatory |
| 5.4.4 Cost | 1 | The net cost of the booking |
| 5.4.5 Currency | 1 | The currency |
| 5.4.6 PriceLineThrough | 1 | The "line-through" price. Price before applying discounts. |
| 5.4.7 Total | 1 | Total price without commission. |
| 5.4.8 TotalWithCommission | 1 | Total price with commission. |
| 5.5 CancellationPolicy | 1 | The cancellation policy of the booking |
| 5.5.1 Description | 1 | The description of the cancellation policy |
| 5.5.2 NotRepayable | 1 | Indicates if the booking is non-refundable |
| 5.5.3 Title | 1 | The title of the cancellation policy |
| 5.6 DetailsPrice | 1 | The breakdown of prices for the booking |
| 5.6.1 Quantity | 1 | The units |
| 5.6.2 Description | 1 | Description of the concept |
| 5.6.3 Code | 1 | Code of the concept |
| 5.6.4 Price | 1 | Total price of the concept |
Request example
Response example
Booking
This section describes the request and response for confirming a reservation for a circuit that was previously reserved.
Request
| Field | Cardinality | Description |
|---|---|---|
| BookingRequest | 1 | The root element for the circuit reservation request. |
| 1. ConsumerId | 1 | The ID of the consumer. |
| 2. LanguageIsoCode | 1 | The ISO code of the language. |
| 3. TourReferenceCode | 1 | The ID of the circuit to be reserved. |
| 4. SessionId | 1 | The ID of the session. |
| 5. ClientLocator | 1 | The client locator (the reference given to this reservation by the agency making the reservation). |
| 6. TourReservation | 1 | The reservation data. |
| 6.1 Agent | 1 | The reference for the agency making the reservation. |
| 6.2 ClientName | 1 | The name of the person making the reservation. |
| 6.3 BookingCode | 1 | The booking code to be confirmed. This was provided in the response to the PreBooking request. |
| 6.4 Comments | 0..N | Comments about the reservation. |
| 6.5 Passangers | 1..N | A list of passengers on the reservation. |
| 6.5.1 GuestTypeCode | 1 | The passenger type (0: adult, 1: child, 2: senior). |
| 6.5.2 Name | 1 | The name of the passenger. |
| 6.5.3 Surname | 1 | The surname of the passenger. |
| 6.5.4 Email | 1 | The email of the passenger. |
| 6.5.5 BirthDate | 1 | The birthdate of the passenger (YYYY-MM-DD). |
| 6.5.6 Gender | 1 | The gender of the passenger (Male/Female). |
| 6.6 FlightIn | 0..1 | The inbound flight. |
| 6.6.1 Date | 0..1 | The date of the inbound flight. |
| 6.6.2 Airport | 0..1 | Airport |
| 6.6.3 CompanyCode | 0..1 | Airline |
| 6.6.4 FlightNumber | 0..1 | Flight number |
| 6.6.5 StartTime | 0..1 | Flight departure time |
| 6.6.6 ArrivalTime | 0..1 | Flight arrival time |
| 6.6.7 Observations | 0..1 | Observations |
| 6.7 FlightOut | 0..1 | Return flight |
| 6.7.1 Date | 0..1 | Departure date |
| 6.7.2 Airport | 0..1 | Airport |
| 6.7.3 CompanyCode | 0..1 | Airline |
| 6.7.4 FlightNumber | 0..1 | Flight number |
| 6.7.5 StartTime | 0..1 | Flight departure time |
| 6.7.6 ArrivalTime | 0..1 | Flight arrival time |
| 6.7.7 Observations | 0..1 | Observations |
Response
| Field | Cardinality | Description |
|---|---|---|
| BookingResponse | 1 | Root element of the circuits booking response |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if successful, False if there's an error |
| 3. Message | 0..1 | If there's an error, contains a description of it |
| 4. BookingStatus | 1 | Booking status (Confirmed, OnRequest, Failed, PendingIssuance, Cancelled) |
| 5. BookingCode | 1 | Final booking code (IdExpediente OfiTour) |
| 6. ProviderLocator | 1 | Locator returned by the provider |
| 7. ClientLocator | 1 | Client's locator (same as the one sent in the request) |
| 8 Price | 1 | Price of the departure |
| 8.1 Amount | 1 | Amount of the departure |
| 8.2 Commission | 1 | Commission percentage |
| 8.3 Mandatory | 1 | True if the amount price is mandatory |
| 8.4 Cost | 1 | Net cost of the departure |
| 8.5 Currency | 1 | Currency |
| 8.6 PriceLineThrough | 1 | "Crossed out" price. Price before discounts are applied. |
| 8.7 Total | 1 | Total price without commission. |
| 8.8 TotalWithCommission | 1 | Total price with commission. |
| 9 CancellationPolicy | 1 | Cancellation policy of the booking |
| 9.1 Description | 1 | Description of the cancellation policy |
| 9.2 NotRepayable | 1 | Indicates if the booking is not refundable |
| 9.3 Title | 1 | Title of the cancellation policy |
Request example
Response example
CancelBooking
This section describes the request and response of the cancellation of a confirmed reservation based on its locator.
Request
| Field | Cardinality | Description |
|---|---|---|
| CancelBookingRequest | 1 | Root element of the cancellation request for a tour reservation |
| 1. ConsumerId | 1 | Consumer identifier |
| 2. LanguageIsoCode | 1 | ISO code of the language |
| 3. BookingCode | 1 | Definitive code of the reservation (IdExpediente OfiTour) |
| 4. ProviderId | 0 | Provider identifier (Should not be sent via XML) |
Response
| Field | Cardinality | Description |
|---|---|---|
| CancelBookingResponse | 1 | Root element of the cancellation response for a tour reservation |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if successful, False if there is an error |
| 3. Message | 0..1 | If there is an error, it contains the description of the error |
| 4. CancelLocata | 1 | Cancellation locator |
Request example
Response example
GetTourInfo
This section describes the request and response of the method for obtaining descriptive information of a tour.
Request
| Field | Cardinality | Description |
|---|---|---|
| GetTourInfoRequest | 1 | Root element of the request for descriptive information of a tour |
| 1. ConsumerId | 1 | Consumer identifier |
| 2. LanguageIsoCode | 1 | ISO code of the language |
| 3. TourReferenceCode | 1 | ID of the tour for which the information is requested |
| 4. ProviderId | 0 | Provider identifier (should not be sent via XML) |
Response
| Field | Cardinality | Description |
|---|---|---|
| GetTourInfoResponse | 1 | Root element of the request for descriptive information of a tour |
| 1. SessionId | 1 | Unique identifier of the session |
| 2. Success | 1 | True if OK, False if there is an error |
| 3. Message | 0..1 | In case of an error, it contains the description of the error |
| 4. TourInfo | 1 | Information about the tour |
| 4.1 Code | 1 | Code of the tour |
| 4.2 Name | 1 | Name of the tour |
| 4.3 Itinerary | 0..N | Itinerary of the tour (List of days) |
| 4.3.1 DayNumber | 1 | Day number |
| 4.3.2 Title | 1 | Title of the day |
| 4.3.3 ShortDescription | 1 | Short description of the day |
| 4.3.4 Description | 1 | Long description of the day |
| 4.3.5 Foot | 1 | Foot description of the day |
| 4.3.6 Origin | 0..1 | Day origin |
| 4.3.6.1 Code | 1 | Day origin code |
| 4.3.6.2 Name | 1 | Day origin name |
| 4.3.3.3 Latitude | 1 | Day origin latitude |
| 4.3.3.4 Longitude | 1 | Day origin longitude |
| 4.3.7 Destiny | 0..1 | Day destination |
| 4.3.7.1 Code | 1 | Day destination code |
| 4.3.7.2 Name | 1 | Day destination name |
| 4.3.7.3 Latitude | 1 | Day destination latitude |
| 4.3.7.4 Longitude | 1 | Day destination longitude |
| 4.3.8 PlacesVisited | 0..N | List of places visited during the day |
| 4.3.8.1 Code | 1 | Visited place code |
| 4.3.8.2 Name | 1 | Visited place name |
| 4.3.8.3 Latitude | 1 | Visited place latitude |
| 4.3.8.4 Longitude | 1 | Visited place longitude |
| 4.4 DescriptiveTexts | 0..N | List of descriptive texts about the cruise |
| 4.4.1 Title | 1 | Title of the descriptive text |
| 4.4.2 Description | 1 | Description of the text |
| 4.5 Destiny | 0..1 | Cruise destination |
| 4.5.1 Code | 1 | Cruise destination code |
| 4.5.2 Name | 1 | Cruise destination name |
| 4.5.3 Latitude | 1 | Cruise destination latitude |
| 4.5.4 Longitude | 1 | Cruise destination longitude |
| 5 CabinsInformation | 0..1 | List of different types of cabins available on the cruise |
| 5.1 ShortDescription | 1 | Brief description of the cabin |
| 5.2 Description | 1 | Detailed description of the cabin |
| 5.3 Name | 1 | Name of the cabin |
| 5.4 Images | 0..1 | List of images of the cabin |
| 5.5 ConceptIds | 0..1 | List of identifiers related to the cabin. Required to obtain information about the cabins returned in the GetAcommodationsAvailables response |
Request example
Response example
GetBookingInfo
This section describes the request and response of the method for obtaining information about a previously made reservation.
Request
| Field | Cardinality | Description |
|---|---|---|
| GetBookingInfoRequest | 1 | Root element of the detailed information request for a reservation |
| 1. ConsumerId | 1 | Identifier of the consumer |
| 2. LanguageIsoCode | 1 | ISO code of the language |
| 3. BookingCode | 1 | Id of the reservation for which information is requested |
| 4. ProviderId | 0 | Provider identifier |
Response
| Field | Cardinality | Description |
|---|---|---|
| GetBookingInfoResponse | 1 | Root element of the detailed information request for a reservation |
| 1. Success | 1 | True if OK, False if there is an error |
| 2. Message | 0..1 | In case of an error, it contains the description of the error |
| 3. BookingInfo | 1 | Reservation information |
| 3.1 BookingCode | 1 | Reservation code |
| 3.2 LocatorCode | 1 | Reservation locator code |
| 3.3 Price | 1 | Reservation price |
| 3.3.1 Amount | 1 | Amount of the output |
| 3.3.2 Commission | 1 | Commission percentage |
| 3.3.4 Cost | 1 | Net cost of the output |
| 3.3.5 Currency | 1 | Currency |
| 3.3.6 Total | 1 | Total price without commission. |
| 3.3.7 TotalWithCommission | 1 | Total price with commission. |
| 3.4 StartDate | 1 | Date of File Entry. |
| 3.5 EndDate | 1 | File Output Date. |
| 3.6 PackageName | 1 | Obtained from the description of the File. |
| 3.7 AgencyName | 1 | Obtained from the Client's Name. |
| 3.8 BookingDate | 1 | Date of File Request |
| 3.9 Status | 1 | File Status (A= Open,N= Canceled, C= Closed, F=Invoiced). |
| 3.10 Days | 1 | The Days. |
| 3.11 Nights | 1 | The Nights. |
| 3.12 ProductType | 1 | Type of Product. |
| 3.13 CommissionableNet | 1 | Obtained from the Commissioned Sale of the File. |
| 3.14 NotCommissionableNet | 1 | Non-commissioned sale of the File. |