Changes for page 7. Book

Summary

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

Details

Page properties

Content

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