Changes for page 7. Book

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

From version 5.1
edited by Giorgi Mdivnishvili
on 2024/02/28 09:25
Change comment: There is no comment for this version
To version 3.1
edited by Giorgi Mdivnishvili
on 2024/02/26 16:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -113,69 +113,124 @@
113 113  
114 114  
115 115  
116 +**reservationcode:**  string. Reservation/Booking ID from Agent’s system. Might be null
116 116  
117 -(% class="table-bordered" %)
118 -(% class="info" %)|**Value**|**Description**
119 -|**reservationcode**|string. Reservation/Booking ID from Agent’s system. Might be null
120 -|**customers**|Array of all tourists of this booking
121 -|**customercode**|string. Unique ID of the customer from Agent. Mandatory
122 -|**title**|string. Tile (“Mr”, “Mrs”…). Optional
123 -|**gender**|string. “M” or “F” only. Mandatory
124 -|**firstname**|First name of the customer. Mandatory
125 -|**lastname**|Last name of the customer. Mandatory
126 -|**birthdate**|Birth date of the customer. Optional. If empty, then the customer will be registered as adult
127 -|**citizenship**|string. ISO2 format of the country code. For example “KZ”, “UA”. . Mandatory
128 -|**visarequired**|Boolean. Is customer applying for a visa service from rustar. Mandatory
129 -|**arrivaldate**|datetime. Mandatory. Addival date AND time of the customer
130 -|**arrivalflightnumber**|string. Mandatory. Flight code of the customer for arrival
131 -|**arrivalairport**|string. IATA 3 character code of the airpot. Mandatory. Example  “DXB”,”SHJ”
132 -|**departuredate**|datetime. Mandatory. Departure date AND time of the customer
133 -|**departureflightnumber**|string. Mandatory. Flight code of the customer for arrival
134 -|**departureairport**|string. IATA 3 character code of the airpot. Mandatory. Example  “DXB”,”SHJ”
135 -|**countryaccesscode**|string. Phone code for the country. Optional. Example “971”
136 -|**areacitycode**|string. Phone code for city or mobile operator. Optional. Example “050”
137 -|**phonenumber**|string. Phone number of the customer. Optional
138 -|**email**| string. Email address of the customer. Optional
139 -|**passportnumber**| string. Passport number of the customer. Optional
140 -|**passporttype**|string. “ID” or “PS”. Optional. Passport type.
141 -|**issuedate**|date. Optional. Issue date of the passport
142 -|**expirydate**|date. Optional. Expire date of the passport
143 -|**issuecity**|string. Optional. City where the passport was issued
144 -|**note**|string. Optional.
145 -|**hotels**|Array of the hotels to book for this reservation
146 -|**hotelid**|guid. Optional. Hotelid returned by “hotels” method (page 2)
147 -|**hotelname**|string. Optional. Hotel name. Will be taken from hotelid if empty
148 -|**placement**|string. Mandatory. Placement returned by hotelprices method. (see page 4)
149 -|**roomcategory**|guid. Optional. Room category ID returned by hotelprices method. (see page 4)
150 -|**roomcategoryname**|string. Optional. Room type name. Will be taken from roomcategory if empty
151 -|**priceid**|guid. Optional. Priceid returned by hotelprices method. (see page 4)
152 -|**promotioncodes**|string. Optional. PromotionCodes separated by “;” to book
153 -|**mealplan**|string. Optional. Meal plan of the price. Will be taken from priceid if empty
154 -|**checkindate**|date. Mandatory. Check in date for this price. Must be within the range of the price
155 -|**checkoutdate**|date. Mandatory. Check out date for this price. Must be within the range of the price
156 -|**adults**|int. Mandatory. Number of adults in booking
157 -|**children**|int. Number of children in booking
158 -|**infants**|int. Number of infants in booking
159 -|**hotelnote**|string. Note for the booking. Optional
160 -|**customercodes**|array of strings. Codes of the customers staying in this hotel reservation for these dates
161 -|**transfers**|Array of the transfers for this booking
162 -|**transferdate**|date. Mandatory. Date of the transfer
163 -|**transfertype**|string. Mandatory. VehicleName taken from vehicletypes method. Page 15 (“GROUP”, “TOYOTA PREVIA”…)
164 -|**fromairport**|string. IATA code of the airport to pick up the tourists
165 -|**fromhotelid**|guid. Hotelid returned by hotels method. Hotel to pick up the tourists.
166 -|**fromhotelname**|string. HotelName returned by hotels method.
167 -|**toairport**|string. IATA code of the airport to drop the tourists
168 -|**tohotelid**|guid. Hotelid returned by hotels method. Hotel to drop the tourists.
169 -|**tohotelname**|string. HotelName returned by hotels method.
170 -|**customercodes**|array of strings. Codes of the customers for this transfer
171 -|**hotelextras**|Array of the extra services, like gala dinners for this booking
172 -|**servicedate**|date. Mandatory. Date of the service/gala dinner
173 -|**extraserviceid**|guid. Mandatory. extraserviceid returned by hotelextras method. Page 9
174 -|**customerprices**|array of customercodes and priceid-s from hotelextras
175 -|**customercode**|string. Mandatory. CustomerCode from Customer’s object.
176 -|**priceid**|guid. Mandatory. Price id from Adult, Teen, Child, Infant from hotelextras
118 +**customers:**  Array of all tourists of this booking
177 177  
120 +**~ customercode:**  string. Unique ID of the customer from Agent. Mandatory
178 178  
122 + **title:**  string. Tile (“Mr”, “Mrs”…). Optional
123 +
124 + **gender:**  string. “M” or “F” only. Mandatory
125 +
126 + **firstname:**  First name of the customer. Mandatory
127 +
128 + **lastname:**  Last name of the customer. Mandatory
129 +
130 + **birthdate:**  Birth date of the customer. Optional. If empty, then the customer will be registered as adult
131 +
132 + **citizenship:**  string. ISO2 format of the country code. For example “KZ”, “UA”. . Mandatory
133 +
134 + **visarequired:**  Boolean. Is customer applying for a visa service from rustar. Mandatory
135 +
136 + **arrivaldate:**  datetime. Mandatory. Addival date AND time of the customer
137 +
138 + **arrivalflightnumber:**  string. Mandatory. Flight code of the customer for arrival
139 +
140 + **arrivalairport:**  string. IATA 3 character code of the airpot. Mandatory. Example: “DXB”,”SHJ”
141 +
142 + **departuredate:**  datetime. Mandatory. Departure date AND time of the customer
143 +
144 + **departureflightnumber:**  string. Mandatory. Flight code of the customer for arrival
145 +
146 + **departureairport:**  string. IATA 3 character code of the airpot. Mandatory. Example: “DXB”,”SHJ”
147 +
148 + **countryaccesscode:**  string. Phone code for the country. Optional. Example: “971”
149 +
150 + **areacitycode:**  string. Phone code for city or mobile operator. Optional. Example: “050”
151 +
152 + **phonenumber:**  string. Phone number of the customer. Optional
153 +
154 + **email:**  string. Email address of the customer. Optional
155 +
156 + **passportnumber:**  string. Passport number of the customer. Optional
157 +
158 + **passporttype:**  string. “ID” or “PS”. Optional. Passport type.
159 +
160 + **issuedate:**  date. Optional. Issue date of the passport
161 +
162 + **expirydate:**  date. Optional. Expire date of the passport
163 +
164 + **issuecity:**  string. Optional. City where the passport was issued
165 +
166 + **note:**  string. Optional.
167 +
168 +**hotels:**  Array of the hotels to book for this reservation
169 +
170 + **hotelid:  **guid. Optional. Hotelid returned by “hotels” method (page 2)
171 +
172 + **hotelname:**  string. Optional. Hotel name. Will be taken from hotelid if empty
173 +
174 + **placement:**  string. Mandatory. Placement returned by hotelprices method. (see page 4)
175 +
176 + **roomcategory:**  guid. Optional. Room category ID returned by hotelprices method. (see page 4)
177 +
178 + **roomcategoryname:**  string. Optional. Room type name. Will be taken from roomcategory if empty
179 +
180 + **priceid:**  guid. Optional. Priceid returned by hotelprices method. (see page 4)
181 +
182 +**~ promotioncodes: **string. Optional. PromotionCodes separated by “;” to book
183 +
184 + **mealplan:**  string. Optional. Meal plan of the price. Will be taken from priceid if empty
185 +
186 + **checkindate:**  date. Mandatory. Check in date for this price. Must be within the range of the price
187 +
188 + **checkoutdate:**  date. Mandatory. Check out date for this price. Must be within the range of the price
189 +
190 + **adults:**  int. Mandatory. Number of adults in booking
191 +
192 + **children:**  int. Number of children in booking
193 +
194 + **infants:**  int. Number of infants in booking
195 +
196 + **hotelnote:**  string. Note for the booking. Optional
197 +
198 + **customercodes:**  array of strings. Codes of the customers staying in this hotel reservation for these dates
199 +
200 +**transfers:**  Array of the transfers for this booking
201 +
202 + **transferdate:  **date. Mandatory. Date of the transfer
203 +
204 + **transfertype:**  string. Mandatory. VehicleName taken from vehicletypes method. Page 15 (“GROUP”, “TOYOTA PREVIA”…)
205 +
206 + **fromairport:**  string. IATA code of the airport to pick up the tourists
207 +
208 + **fromhotelid:**  guid. Hotelid returned by hotels method. Hotel to pick up the tourists.
209 +
210 + **fromhotelname:**  string. HotelName returned by hotels method.
211 +
212 + **toairport:**  string. IATA code of the airport to drop the tourists
213 +
214 + **tohotelid:**  guid. Hotelid returned by hotels method. Hotel to drop the tourists.
215 +
216 + **tohotelname:**  string. HotelName returned by hotels method.
217 +
218 + **customercodes:**  array of strings. Codes of the customers for this transfer
219 +
220 +**hotelextras:**  Array of the extra services, like gala dinners for this booking
221 +
222 + **servicedate:  **date. Mandatory. Date of the service/gala dinner
223 +
224 + **extraserviceid:**  guid. Mandatory. extraserviceid returned by hotelextras method. Page 9
225 +
226 + **customerprices:**  array of customercodes and priceid-s from hotelextras
227 +
228 + **customercode:**  string. Mandatory. CustomerCode from Customer’s object.
229 +
230 + **priceid:**  guid. Mandatory. Price id from Adult, Teen, Child, Infant from hotelextras
231 +
232 +
233 +
179 179  **Return value example:**
180 180  
181 181  
... ... @@ -334,12 +334,17 @@
334 334  
335 335  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:
336 336  
337 -(% class="info" %)|**Value**|**Description**
338 -|**ReservationID**| guid. Unique ID assigned to the booking by Rustar
339 -|**ReservationNumber**| string. Unique booking number assigned by Rustar. Can be used for searching on web portal
340 -|**ReservationDate**| date and time of the reservation.
341 -|**ReservationAmount**| decimal. Total amount of the booking in USD
342 -|**ReservationStatus**| int. Status id of the reservation.
343 -|**ReservationStatusName**| string. Description of the status of the reservation
344 344  
393 +**ReservationID**: guid. Unique ID assigned to the booking by Rustar
394 +
395 +**ReservationNumber**: string. Unique booking number assigned by Rustar. Can be used for searching on web portal
396 +
397 +**ReservationDate**: date and time of the reservation.
398 +
399 +**ReservationAmount**: decimal. Total amount of the booking in USD
400 +
401 +**ReservationStatus**: int. Status id of the reservation.
402 +
403 +**ReservationStatusName**: string. Description of the status of the reservation
404 +
345 345