5. GetReservationDetails

Last modified by Giorgi Mdivnishvili on 2024/04/12 19:08

Contents

Method Description

Method Description

This API endpoint facilitates the retrieval of information pertaining to a previously booked reservation for data verification purposes.

To utilize this functionality, simply provide the reservationId parameter obtained following the initial reservation request and submit the API request.

Endpoint URL - [POST]

https://integration.kazunion.com/api/Reservations/GetReservationDetails

Request Parameters

None

Request Body

{"id":"e5955628-9fbb-4418-89e4-a928a6f92d59"}

Request Body example

{"id":"e5955628-9fbb-4418-89e4-a928a6f92d59"}

Response example

{
   "reservation": {
       "id": "e5955628-9fbb-4418-89e4-a928a6f92d59",
       "rfNumber": "314612 / 104586",
       "contactNumber": "teeeest, for testing purpose !, Contact Number: 597101803",
       "agentName": "Mr. Giorgi Mdivnishvili",
       "totalPrice": 47,
       "agentCommission": 0,
       "currency": "USD",
       "tourists": [
            {
               "id": "69c369ca-cc96-40a3-bc72-914570239d52",
               "gender": "Male",
               "ageCategory": "Adult",
               "firstName": "Teeeest",
               "lastName": "Teeeest",
               "passportNumber": "123123",
               "passportExpiryDate": "2025-09-23T00:00:00.000",
               "citizenshipCountryCode": "KZ",
               "citizenshipCountryName": "Kazakhstan",
               "arrivalDate": "2024-06-30T00:00:00.000",
               "arrivalTerminalCode": "DXB2",
               "returnDate": "2024-07-01T00:00:00.000",
               "returnTerminalCode": "DXB2",
               "showReturn": true
            },
            {
               "id": "22c86f25-0914-499e-86e8-f3da7cc1b6f4",
               "gender": "Male",
               "ageCategory": "Adult",
               "firstName": "Teeeest",
               "lastName": "Teeeest",
               "birthDate": "1990-09-23T00:00:00.000",
               "passportNumber": "1231233",
               "passportExpiryDate": "2025-12-23T00:00:00.000",
               "citizenshipCountryCode": "KZ",
               "citizenshipCountryName": "Kazakhstan",
               "arrivalDate": "2024-06-30T00:00:00.000",
               "arrivalTerminalCode": "DXB2",
               "returnDate": "2024-07-01T00:00:00.000",
               "returnTerminalCode": "DXB2",
               "showReturn": true
            }
        ],
       "hotels": [
            {
               "id": "df273eac-855f-40da-b115-258647183adf",
               "hotelName": "Royal Continental Hotel",
               "cityName": "Dubai",
               "hotelClass": "4",
               "checkInDate": "2024-06-30T00:00:00.000",
               "checkOutDate": "2024-07-01T00:00:00.000",
               "roomCategoryName": "Superior King Room",
               "placementName": "DBL",
               "mealPlan": "RO"
            }
        ],
       "flights": [],
       "transfers": [],
       "services": []
    }
}

Schema

GetReservationDetailsResponse{

reservation

ReservationDetails{

string($uuid)

rfNumber

string
nullable: true

contactNumber

string
nullable: true

agentName

string
nullable: true

totalPrice

number($double)

agentCommission

number($double)

netPrice

number($double)
nullable: true

currency

string
nullable: true

tourists

[
nullable: trueResDetailsTourist{

id	string($uuid)
gender	GenderEnumstringEnum: [ None, Male, Female ]
ageCategory	AgeCategorystringEnum: [ Adult, Infant, Child ]
firstName	string nullable: true
lastName	string nullable: true
birthDate	string($date-time) nullable: true
passportNumber	string nullable: true
passportExpiryDate	string($date-time) nullable: true
tin	string nullable: true
citizenshipCountryCode	string nullable: true
citizenshipCountryName	string nullable: true
mobile	string nullable: true
email	string nullable: true
arrivalDate	string($date-time) nullable: true
arrivalFlightNumber	string nullable: true
arrivalTerminalCode	string nullable: true
returnDate	string($date-time) nullable: true
returnFlightNumber	string nullable: true
returnTerminalCode	string nullable: true
showReturn	boolean

}]

hotels

[
nullable: trueResDetailsHotel{

id	string($uuid)
hotelName	string nullable: true
cityName	string nullable: true
hotelClass	string nullable: true
checkInDate	string($date-time)
checkOutDate	string($date-time)
roomCategoryName	string nullable: true
placementName	string nullable: true
mealPlan	string nullable: true
agentConfirmationNumber	string nullable: true

}]

flights

[
nullable: trueResDetailsFlight{

id	string($uuid)
isArrival	boolean
touristId	string($uuid)
touristName	string nullable: true
date	string($date-time)
departureAirport	string nullable: true
departureTerminal	string nullable: true
arrivalAirport	string nullable: true
arrivalTerminal	string nullable: true
agentConfirmationNumber	string nullable: true
bookingConfirmationNumber	string nullable: true
note	string nullable: true

}]

transfers

[
nullable: trueResDetailsTransfer{

id	string($uuid)
transferType	string nullable: true
vehicleName	string nullable: true
touristId	string($uuid)
touristName	string nullable: true
date	string($date-time)
fromTerminal	string nullable: true
fromCityName	string nullable: true
fromHotelName	string nullable: true
toHotelName	string nullable: true
toTerminal	string nullable: true
toCityName	string nullable: true
agentConfirmationNumber	string nullable: true
note	string nullable: true

}]

services

[
nullable: trueResDetailsService{

id	string($uuid)
serviceDate	string($date-time)
serviceName	string nullable: true
touristId	string($uuid)
touristName	string nullable: true
note	string nullable: true

}]

}

Description

Parameter	Value Type	Description
id	String	The unique identifier for the reservation, typically a UUID or similar.
rfNumber	String	The reference number for the reservation, usually generated by the system.
contactNumber	String	The contact number associated with the reservation, used for communication purposes.
agentName	String	The name of the agent who made the reservation, useful for tracking and accountability.
totalPrice	Number	The total price of the reservation, calculated based on the services and products included.
agentCommission	Number	The commission earned by the agent for this reservation, calculated as a percentage of the total price.
currency	String	The currency in which the price and commission are denominated, typically in ISO 4217 format (e.g., USD, EUR).
tourists[].id	String	The unique identifier for each tourist, typically a UUID.
tourists[].gender	String	The gender of the tourist, usually : [ None, Male, Female ]
tourists[].ageCategory	String	The age category of the tourist, such as 'Adult', 'Child', or 'Infant'.
tourists[].firstName	String	The first name of the tourist, as it appears on their passport.
tourists[].lastName	String	The last name of the tourist, as it appears on their passport.
tourists[].birthDate	String (Date)	The birth date of the tourist, typically in ISO 8601 format (YYYY-MM-DD).
tourists[].passportNumber	String	The passport number of the tourist, as it appears on their passport.
tourists[].passportExpiryDate	String (Date)	The expiry date of the tourist's passport, typically in ISO 8601 format (YYYY-MM-DD).
tourists[].citizenshipCountryCode	String	The ISO 3166-1 alpha-2 code of the tourist's country of citizenship (e.g., US, GB).
tourists[].citizenshipCountryName	String	The full name of the tourist's country of citizenship.
tourists[].arrivalDate	String (Date)	The date of the tourist's arrival, typically in ISO 8601 format (YYYY-MM-DD).
tourists[].arrivalFlightNumber	String	The flight number for the tourist's arrival, as provided by the airline.
tourists[].arrivalTerminalCode	String	The terminal code for the tourist's arrival, as provided by the airport.
tourists[].returnDate	String (Date)	The date of the tourist's return, typically in ISO 8601 format (YYYY-MM-DD).
tourists[].returnFlightNumber	String	The flight number for the tourist's return, as provided by the airline.
tourists[].returnTerminalCode	String	The terminal code for the tourist's return, as provided by the airport.
tourists[].showReturn	Boolean	A boolean indicating whether the return information should be displayed, useful for one-way trips.
hotels[].id	String	The unique identifier for each hotel booking, typically a UUID or similar.
hotels[].hotelName	String	The name of the hotel where the booking is made.
hotels[].cityName	String	The city where the hotel is located.
hotels[].hotelClass	String	The class or rating of the hotel, such as '3-star', '4-star', '5-star', etc.
hotels[].checkInDate	String (Date)	The check-in date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
hotels[].checkOutDate	String (Date)	The check-out date for the hotel booking, typically in ISO 8601 format (YYYY-MM-DD).
hotels[].roomCategoryName	String	The category of the room booked, such as 'Standard', 'Deluxe', 'Suite', etc.
hotels[].placementName	String	The type of placement, such as 'DBL' for double room, 'SGL' for single room, etc.
hotels[].mealPlan	String	The meal plan for the hotel booking, such as 'RO' for Room Only, 'BB' for Bed and Breakfast, etc.
flights[].id	String	The unique identifier for each flight, typically a UUID or similar.
flights[].isArrival	Boolean	A boolean indicating whether this flight is an arrival flight, useful for distinguishing between arrival and departure flights.
flights[].touristId	String	The id of the tourist taking this flight, linking the flight to a specific tourist.
flights[].touristName	String	The name of the tourist taking this flight, useful for passenger lists.
flights[].date	String (Date)	The date and time of the flight, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
flights[].departureAirport	String	The IATA code of the airport from which the flight departs (e.g., JFK, LHR).
flights[].departureTerminal	String	The terminal from which the flight departs, as provided by the airport.
flights[].arrivalAirport	String	The IATA code of the airport at which the flight arrives (e.g., JFK, LHR).
flights[].arrivalTerminal	String	The terminal at which the flight arrives, as provided by the airport.
flights[].note	String	Any additional notes about the flight, such as 'Overnight flight', 'Meal included', etc.
transfers[].id	String	The unique identifier for each transfer, typically a UUID or similar.
transfers[].transferType	String	The type of transfer, such as 'ARRIVAL' for airport to hotel transfers, 'DEPARTURE' for hotel to airport transfers.
transfers[].vehicleName	String	The name of the vehicle used for the transfer, such as 'Private Car', 'Shared Shuttle', etc.
transfers[].touristId	String	The id of the tourist using this transfer, linking the transfer to a specific tourist.
transfers[].touristName	String	The name of the tourist using this transfer, useful for passenger lists.
transfers[].date	String (Date)	The date and time of the transfer, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
transfers[].fromTerminal	String	The terminal from which the transfer starts, as provided by the airport or hotel.
transfers[].fromCityName	String	The city from which the transfer starts.
transfers[].toHotelName	String	The hotel to which the transfer goes.
transfers[].toCityName	String	The city to which the transfer goes.
transfers[].note	String	Any additional notes about the transfer, such as 'Private transfer', 'Shared transfer', etc.
services[].id	String	The unique identifier for each service, typically a UUID or similar.
services[].serviceDate	String (Date)	The date and time of the service, typically in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ).
services[].serviceName	String	The name of the service, such as insurance in this example.
services[].touristId	String	The id of the tourist using this service, linking the service to a specific tourist.
services[].touristName	String	The name of the tourist using this service, useful for booking confirmations.