Changes for page 7. Book

Last modified by Giorgi Mdivnishvili on 2024/02/28 09:26

From 2.1 to 1.1 From 5.1 to 4.1

From version 4.1

edited by Giorgi Mdivnishvili
on 2024/02/27 10:14

Change comment: There is no comment for this version

To version 2.1

edited by Giorgi Mdivnishvili
on 2024/02/26 15:42

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -8,11 +8,17 @@
  [[**https:~~/~~/restapi.rustaronline.com/v1.01/api/book?agentid=test.test&agentpassword=TestP@ssw0rd**>>url:https://restapi.rustaronline.com/v1.01/api/book?agentid=test.test&agentpassword=TestP@ssw0rd]]
++[[**https:~~/~~/restapigeo.rustaronline.com/v1.01/api/hotelprices?agentid=DidaTravel.Jackson&agentpassword=didatravel123!.&HotelId=A95535D0-1F0C-4CBA-A0A1-9A4E2ABF46B5**>>url:https://restapigeo.rustaronline.com/v1.01/api/hotelprices?agentid=DidaTravel.Jackson&agentpassword=didatravel123!.&HotelId=A95535D0-1F0C-4CBA-A0A1-9A4E2ABF46B5]]
++
++[[**https:~~/~~/restapi.rustaronline.com/v1.01/api/book?** **agentid=DidaTravel.Jackson&agentpassword=didatravel123!.**>>url:https://restapi.rustaronline.com/v1.01/api/book?agentid=test.test&agentpassword=TestP@ssw0rd]]
++
++
  The method registers a booking request from the agent into Rustar’s database
--**Post value example:**
++Post value example:
++
  {{code language="json"}}
  {
    "reservationcode": "RES001",
@@ -113,69 +113,124 @@
++**reservationcode:**  string. Reservation/Booking ID from Agent’s system. Might be null
--(% class="info" %)|**Value**|**Description**
--|**reservationcode**|string. Reservation/Booking ID from Agent’s system. Might be null
--|**customers**|Array of all tourists of this booking
--|**customercode**|string. Unique ID of the customer from Agent. Mandatory
--|**title**|string. Tile (“Mr”, “Mrs”…). Optional
--|**gender**|string. “M” or “F” only. Mandatory
--|**firstname**|First name of the customer. Mandatory
--|**lastname**|Last name of the customer. Mandatory
--|**birthdate**|Birth date of the customer. Optional. If empty, then the customer will be registered as adult
--|**citizenship**|string. ISO2 format of the country code. For example “KZ”, “UA”. . Mandatory
--|**visarequired**|Boolean. Is customer applying for a visa service from rustar. Mandatory
--|**arrivaldate**|datetime. Mandatory. Addival date AND time of the customer
--|**arrivalflightnumber**|string. Mandatory. Flight code of the customer for arrival
--|**arrivalairport**|string. IATA 3 character code of the airpot. Mandatory. Example  “DXB”,”SHJ”
--|**departuredate**|datetime. Mandatory. Departure date AND time of the customer
--|**departureflightnumber**|string. Mandatory. Flight code of the customer for arrival
--|**departureairport**|string. IATA 3 character code of the airpot. Mandatory. Example  “DXB”,”SHJ”
--|**countryaccesscode**|string. Phone code for the country. Optional. Example “971”
--|**areacitycode**|string. Phone code for city or mobile operator. Optional. Example “050”
--|**phonenumber**|string. Phone number of the customer. Optional
--|**email**| string. Email address of the customer. Optional
--|**passportnumber**|  string. Passport number of the customer. Optional
--|**passporttype**|string. “ID” or “PS”. Optional. Passport type.
--|**issuedate**|date. Optional. Issue date of the passport
--|**expirydate**|date. Optional. Expire date of the passport
--|**issuecity**|string. Optional. City where the passport was issued
--|**note**|string. Optional.
--|**hotels**|Array of the hotels to book for this reservation
--|**hotelid**|guid. Optional. Hotelid returned by “hotels” method (page 2)
--|**hotelname**|string. Optional. Hotel name. Will be taken from hotelid if empty
--|**placement**|string. Mandatory. Placement returned by hotelprices method. (see page 4)
--|**roomcategory**|guid. Optional. Room category ID returned by hotelprices method. (see page 4)
--|**roomcategoryname**|string. Optional. Room type name. Will be taken from roomcategory if empty
--|**priceid**|guid. Optional. Priceid returned by hotelprices method. (see page 4)
--|**promotioncodes**|string. Optional. PromotionCodes separated by “;” to book
--|**mealplan**|string. Optional. Meal plan of the price. Will be taken from priceid if empty
--|**checkindate**|date. Mandatory. Check in date for this price. Must be within the range of the price
--|**checkoutdate**|date. Mandatory. Check out date for this price. Must be within the range of the price
--|**adults**|int. Mandatory. Number of adults in booking
--|**children**|int. Number of children in booking
--|**infants**|int. Number of infants in booking
--|**hotelnote**|string. Note for the booking. Optional
--|**customercodes**|array of strings. Codes of the customers staying in this hotel reservation for these dates
--|**transfers**|Array of the transfers for this booking
--|**transferdate**|date. Mandatory. Date of the transfer
--|**transfertype**|string. Mandatory. VehicleName taken from vehicletypes method. Page 15 (“GROUP”, “TOYOTA PREVIA”…)
--|**fromairport**|string. IATA code of the airport to pick up the tourists
--|**fromhotelid**|guid. Hotelid returned by hotels method. Hotel to pick up the tourists.
--|**fromhotelname**|string. HotelName returned by hotels method.
--|**toairport**|string. IATA code of the airport to drop the tourists
--|**tohotelid**|guid. Hotelid returned by hotels method. Hotel to drop the tourists.
--|**tohotelname**|string. HotelName returned by hotels method.
--|**customercodes**|array of strings. Codes of the customers for this transfer
--|**hotelextras**|Array of the extra services, like gala dinners for this booking
--|**servicedate**|date. Mandatory. Date of the service/gala dinner
--|**extraserviceid**|guid. Mandatory. extraserviceid returned by hotelextras method. Page 9
--|**customerprices**|array of customercodes and priceid-s from hotelextras
--|**customercode**|string. Mandatory. CustomerCode from Customer’s object.
--|**priceid**|guid. Mandatory. Price id from Adult, Teen, Child, Infant from hotelextras
++**customers:**  Array of all tourists of this booking
++**~  customercode:**  string. Unique ID of the customer from Agent. Mandatory
++  **title:**  string. Tile (“Mr”, “Mrs”…). Optional
++  **gender:**  string. “M” or “F” only. Mandatory
++
++  **firstname:**  First name of the customer. Mandatory
++
++  **lastname:**  Last name of the customer. Mandatory
++
++  **birthdate:**  Birth date of the customer. Optional. If empty, then the customer will be registered as adult
++
++  **citizenship:**  string. ISO2 format of the country code. For example “KZ”, “UA”. . Mandatory
++
++  **visarequired:**  Boolean. Is customer applying for a visa service from rustar. Mandatory
++
++  **arrivaldate:**  datetime. Mandatory. Addival date AND time of the customer
++
++  **arrivalflightnumber:**  string. Mandatory. Flight code of the customer for arrival
++
++  **arrivalairport:**  string. IATA 3 character code of the airpot. Mandatory. Example: “DXB”,”SHJ”
++
++  **departuredate:**  datetime. Mandatory. Departure date AND time of the customer
++
++  **departureflightnumber:**  string. Mandatory. Flight code of the customer for arrival
++
++  **departureairport:**  string. IATA 3 character code of the airpot. Mandatory. Example: “DXB”,”SHJ”
++
++  **countryaccesscode:**  string. Phone code for the country. Optional. Example: “971”
++
++  **areacitycode:**  string. Phone code for city or mobile operator. Optional. Example: “050”
++
++  **phonenumber:**  string. Phone number of the customer. Optional
++
++  **email:**  string. Email address of the customer. Optional
++
++  **passportnumber:**  string. Passport number of the customer. Optional
++
++  **passporttype:**  string. “ID” or “PS”. Optional. Passport type.
++
++  **issuedate:**  date. Optional. Issue date of the passport
++
++  **expirydate:**  date. Optional. Expire date of the passport
++
++  **issuecity:**  string. Optional. City where the passport was issued
++
++  **note:**  string. Optional.
++
++**hotels:**  Array of the hotels to book for this reservation
++
++  **hotelid:  **guid. Optional. Hotelid returned by “hotels” method (page 2)
++
++  **hotelname:**  string. Optional. Hotel name. Will be taken from hotelid if empty
++
++  **placement:**  string. Mandatory. Placement returned by hotelprices method. (see page 4)
++
++  **roomcategory:**  guid. Optional. Room category ID returned by hotelprices method. (see page 4)
++
++  **roomcategoryname:**  string. Optional. Room type name. Will be taken from roomcategory if empty
++
++  **priceid:**  guid. Optional. Priceid returned by hotelprices method. (see page 4)
++
++**~  promotioncodes: **string. Optional. PromotionCodes separated by “;” to book
++
++  **mealplan:**  string. Optional. Meal plan of the price. Will be taken from priceid if empty
++
++  **checkindate:**  date. Mandatory. Check in date for this price. Must be within the range of the price
++
++  **checkoutdate:**  date. Mandatory. Check out date for this price. Must be within the range of the price
++
++  **adults:**  int. Mandatory. Number of adults in booking
++
++  **children:**  int. Number of children in booking
++
++  **infants:**  int. Number of infants in booking
++
++  **hotelnote:**  string. Note for the booking. Optional
++
++  **customercodes:**  array of strings. Codes of the customers staying in this hotel reservation for these dates
++
++**transfers:**  Array of the transfers for this booking
++
++  **transferdate:  **date. Mandatory. Date of the transfer
++
++  **transfertype:**  string. Mandatory. VehicleName taken from vehicletypes method. Page 15 (“GROUP”, “TOYOTA PREVIA”…)
++
++  **fromairport:**  string. IATA code of the airport to pick up the tourists
++
++  **fromhotelid:**  guid. Hotelid returned by hotels method. Hotel to pick up the tourists.
++
++  **fromhotelname:**  string. HotelName returned by hotels method.
++
++  **toairport:**  string. IATA code of the airport to drop the tourists
++
++  **tohotelid:**  guid. Hotelid returned by hotels method. Hotel to drop the tourists.
++
++  **tohotelname:**  string. HotelName returned by hotels method.
++
++  **customercodes:**  array of strings. Codes of the customers for this transfer
++
++**hotelextras:**  Array of the extra services, like gala dinners for this booking
++
++  **servicedate:  **date. Mandatory. Date of the service/gala dinner
++
++  **extraserviceid:**  guid. Mandatory. extraserviceid returned by hotelextras method. Page 9
++
++  **customerprices:**  array of customercodes and priceid-s from hotelextras
++
++    **customercode:**  string. Mandatory. CustomerCode from Customer’s object.
++
++    **priceid:**  guid. Mandatory. Price id from Adult, Teen, Child, Infant from hotelextras
++
++
++
  **Return value example:**
@@ -334,12 +334,17 @@
  The values are self-descriptive and most of them just are the same as passed to this booking. The values to pay attention apart crosschecking the booking parameters are:
--(% class="info" %)|**Value**|**Description**
--|**ReservationID**| guid. Unique ID assigned to the booking by Rustar
--|**ReservationNumber**| string. Unique booking number assigned by Rustar. Can be used for searching on web portal
--|**ReservationDate**| date and time of the reservation.
--|**ReservationAmount**| decimal. Total amount of the booking in USD
--|**ReservationStatus**| int. Status id of the reservation.
--|**ReservationStatusName**| string. Description of the status of the reservation
++**ReservationID**: guid. Unique ID assigned to the booking by Rustar
++
++**ReservationNumber**: string. Unique booking number assigned by Rustar. Can be used for searching on web portal
++
++**ReservationDate**: date and time of the reservation.
++
++**ReservationAmount**: decimal. Total amount of the booking in USD
++
++**ReservationStatus**: int. Status id of the reservation.
++
++**ReservationStatusName**: string. Description of the status of the reservation
++

Changes for page 7. Book

Summary

Details

Applications

Navigation