Changes for page 7. GetReservations

Last modified by Giorgi Mdivnishvili on 2024/08/16 18:29

From 5.1 to 6.1 From 7.1 to 8.1

From version 6.1

edited by Giorgi Mdivnishvili
on 2024/08/16 18:20

Change comment: There is no comment for this version

To version 7.1

edited by Giorgi Mdivnishvili
on 2024/08/16 18:25

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -485,64 +485,57 @@
  == Description ==
--(% class="table-bordered" %)
--|=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.
++|=**Parameter Name**|=**Type**|=**Description**|=**Example**
++|**pageId**|integer|Represents the current page of the results returned. Used for pagination.|0
++|**pagesCount**|integer|Indicates the total number of pages available based on the query filters applied.|0
++|**reservations**|array|An array containing details of each reservation matching the query parameters. Each entry in this array is a JSON object with multiple fields related to a single reservation.|[ {...}, {...} ]
++|**reservations[].id**|string|The unique identifier for the reservation.|"07fff3fd-7ae9-409f-b50b-2cc7a948b8d0"
++|**reservations[].number**|string|The reservation number, typically used as a reference by agents and customers.|"110576"
++|**reservations[].agentConfirmationNumber**|string|A confirmation number provided by the agent. It can be empty if not applicable.|""
++|**reservations[].registrationDate**|datetime|The date and time when the reservation was registered in the system.|"2024-07-11T10:09:52.243"
++|**reservations[].packageType**|string|Specifies the type of package associated with the reservation (e.g., "Package").|"Package"
++|**reservations[].status**|string|The current status of the reservation (e.g., "Canceled", "Confirmed").|"Canceled"
++|**reservations[].statusForAgent**|string|The reservation status as seen from the agent's perspective.|"Canceled"
++|**reservations[].departureToAirlineName**|string|The name of the airline for the departure flight. If not applicable, it will be "N/A".|"N/A"
++|**reservations[].arrivalTime**|datetime|The scheduled arrival time for the trip.|"2024-09-23T07:15:00.000"
++|**reservations[].arrivalCountryName**|string|The name of the country where the trip is scheduled to arrive.|"United Arab Emirates"
++|**reservations[].departureTime**|datetime|The scheduled departure time for the return trip.|"2024-09-29T21:30:00.000"
++|**reservations[].pickupPeriods**|array|An array of pickup periods, detailing the times when pickup services are scheduled. This can be empty if no pickup services are associated with the reservation.|[]
++|**reservations[].driverMobile**|string|The mobile number of the driver assigned for transfer services. It can be "N/A" if not applicable.|"N/A"
++|**reservations[].paymentInOutInvCurrency**|object|Contains payment details in the invoice currency.|{...}
++|**reservations[].paymentInOutInvCurrency.price**|decimal|Total price in the invoice currency.|952.90
++|**reservations[].paymentInOutInvCurrency.netPrice**|decimal|Net price after any discounts in the invoice currency.|952.90
++|**reservations[].paymentInOutInvCurrency.paid**|decimal|Amount already paid.|0.00
++|**reservations[].paymentInOutInvCurrency.unpaid**|decimal|Amount that is still unpaid.|952.90
++|**reservations[].paymentInOutInvCurrency.comission**|decimal|Commission amount, if applicable.|0.00
++|**reservations[].paymentInOutInvCurrency.comissionPercent**|integer|Percentage of the commission.|0
++|**reservations[].paymentInSellCurrency**|object|Similar to paymentInOutInvCurrency, but in the selling currency.|{...}
++|**reservations[].paymentInSellCurrency.currencyCode**|string|The code of the currency (e.g., "USD").|"USD"
++|**reservations[].paymentInSellCurrency.price**|decimal|Total price in the selling currency.|952.90
++|**reservations[].paymentInSellCurrency.netPrice**|decimal|Net price after any discounts in the selling currency.|952.90
++|**reservations[].paymentInSellCurrency.paid**|decimal|Amount already paid.|0.00
++|**reservations[].paymentInSellCurrency.unpaid**|decimal|Amount that is still unpaid.|952.90
++|**reservations[].paymentInSellCurrency.comission**|decimal|Commission amount, if applicable.|0.00
++|**reservations[].paymentInSellCurrency.comissionPercent**|integer|Percentage of the commission.|0
++|**reservations[].showDownloadDocuments**|boolean|Indicates whether documents related to the reservation can be downloaded.|false
++|**reservations[].guideMeetings**|array|An array of guide meeting details. This can be empty if no guide meetings are associated with the reservation.|[]
++|**reservations[].services**|array|An array of services associated with the reservation. Each service contains details such as service type, description, associated tourist IDs, and service-specific details (e.g., flight details).|[ {...}, {...} ]
++|**reservations[].services[].id**|string|The unique identifier for the service.|"00000000-0000-0000-0000-000000000000"
++|**reservations[].services[].serviceDate**|datetime|The date of the service.|"0001-01-01T00:00:00.000"
++|**reservations[].services[].type**|string|The type of service (e.g., "Hotel", "AviaTicket").|"Hotel"
++|**reservations[].services[].description**|string|A textual description of the service.|"N/A (N/A*) 23.09.2024 - 29.09.2024 / N/A N/A DBL"
++|**reservations[].services[].touristIds**|array|An array of tourist IDs associated with the service.|["29236304-d23c-4999-88ec-76ac4b99b614", "a2e833cf-cdcd-4ff9-9c43-b63066da1f7c"]
++|**reservations[].services[].serviceDetails**|array|Additional details specific to the service type, such as flight details.|[ {...}, {...} ]
++|**reservations[].tourists**|array|An array of tourists associated with the reservation. Each tourist object contains personal details such as name, gender, passport information, and more.|[ {...}, {...} ]
++|**reservations[].tourists[].id**|string|The unique identifier for the tourist.|"29236304-d23c-4999-88ec-76ac4b99b614"
++|**reservations[].tourists[].gender**|string|The gender of the tourist.|"Male"
++|**reservations[].tourists[].ageCategory**|string|The age category of the tourist (e.g., "Adult").|"Adult"
++|**reservations[].tourists[].title**|string|The title of the tourist (e.g., "MR.").|"MR."
++|**reservations[].tourists[].firstName**|string|The first name of the tourist.|"Teeeeest"
++|**reservations[].tourists[].lastName**|string|The last name of the tourist.|"Teeeest"
++|**reservations[].tourists[].birthDate**|datetime|The birth date of the tourist.|"1990-09-23T00:00:00"
++|**reservations[].tourists[].passportNumber**|string|The passport number of the tourist.|"1231233"
++|**reservations[].tourists[].passportExpiryDate**|datetime|The expiration date of the tourist's passport.|"2029-12-23T00:00:00"
++|**reservations[].tourists[].citizenshipCountryCode**|string|The citizenship country code of the tourist.|"N/A"
++|**reservations[].tourists[].canEdit**|boolean|Indicates whether the tourist’s details can be edited.|false
++|**reservations[].documents**|array|An array containing document details associated with the reservation.|[]

Changes for page 7. GetReservations

Summary

Details

Applications

Navigation