Changes for page 6. Register Reservation

Summary

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

Details

Page properties

Content

...	...	@@ -1,237 +1,0 @@
1		-{{box cssClass="floatinginfobox" title="**Contents**"}}
2		-
3		-
4		-{{toc/}}
5		-{{/box}}
6		-
7		-= Method Description =
8		-
9		-
10		-With the parameters provided in GetHotels and GetCities reponse, it’s avaible to search hotels with the desired parameters in Hotels Search.
11		-
12		-
13		-endpoint : [[https:~~/~~/testapi.rustaronline.com/api/Reservations/RegisterReservation?agentid=test.test&agentpassword=TestP@ssw0rd>>https://testapi.rustaronline.com/api/Reservations/RegisterReservation?agentid=test.test&agentpassword=TestP@ssw0rd]]
14		-
15		-Method POST
16		-
17		-
18		-== **Request example:** ==
19		-
20		-{{code language="Json"}}
21		-{
22		- "reservationcode":"testGM20240229_tccapi_2",
23		- "customers": [
24		- {
25		- "customercode": "1",
26		- "title": "Mr",
27		- "gender": "M",
28		- "firstname": "TEEEST",
29		- "lastname": "TEEEST",
30		- "birthdate": "1981-01-01T00:00:00",
31		- "citizenship": "RU",
32		- "visarequired": false,
33		-
34		- "phonenumber": "+70000000000",
35		- "email": null,
36		- "passportnumber": "",
37		- "passporttype": null,
38		- "issuedate": null,
39		- "expirydate": null,
40		- "issuecity": null,
41		- "note": null
42		- }
43		- ],
44		- "hotels":[
45		- {
46		- "hotelid":"da9b081d-b963-4fb7-ad19-8c375ce60da1",
47		- "hotelname":"Delta Hotels Istanbul Halic",
48		- "checkInDate": "2024-05-06T00:00:00",
49		- "checkOutDate": "2024-05-07T00:00:00",
50		- "placement":"SNGL",
51		- "roomcategory":"TWTW",
52		- "roomcategoryname":"Deluxe Guest room, 2 Twins",
53		- "priceid":"CVNP",
54		- "price": 109.44,
55		- "promotioncodes":null,
56		- "mealplan":"RO",
57		- "adults":1,
58		- "children":0,
59		- "infants":0,
60		- "hotelnote":"Deluxe, 2 Twins, Mini fridge, 23sqm/247sqft-25sqm/269sqft, Wireless internet, complimentary, Wired internet, complimentary, Coffee/tea maker, 43in/109cm LED TV Cancellation Policy: penalty for cancellation 0-24 hours before checkin is EUR 108.37, penalty for cancellation after 12AM is EUR 108.37, penalty for NoShow is EUR 108.37",
61		- "customercodes":[
62		- "1"]
63		- }],
64		- "transfers":null,
65		- "hotelextras":null
66		- }
67		-{{/code}}
68		-
69		-
70		-== Definition of Request Parameters ==
71		-
72		-(% class="table-bordered" %)
73		-(% class="info" %)|**Parameter**|**Value**|**Description**
74		-|** "contragentContactUID"**| "55a2fcfb-8378-4b73-ab1e-bc8e5c836f4e",|A unique code assigned to each application user
75		-|** "countryMask"**|"TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
76		-|** "CheckInDate"**| "2024-05-06",|Check in date "YY-MM-DD"
77		-|** "CheckOutDate"**| "2024-05-07",|Check out date "YY-MM-DD"
78		-|** "Adults"**| 1,|number of Adults
79		-|** "Children"**| 0,|Number of children
80		-|** "ChildrenAges"**| "",|children ages, the must be separated with ","
81		-|(((
82		-**~ "priceCode"**
83		-)))|(((
84		-"CVNP",
85		-)))|
86		-|(((
87		-**"roomCategoryCode"**
88		-)))|(((
89		-"TWTW",
90		-)))|
91		-|(((
92		-**~ "hotelCode"**
93		-)))|(((
94		-"da9b081d-b963-4fb7-ad19-8c375ce60da1"
95		-)))|
96		-
97		-(% class="wikigeneratedid" %)
98		-In case there is need to display hotels in whole country, no mater cities, it's possible to remove "arrivalCities" parameter.
99		-
100		-
101		-== Response Example ==
102		-
103		-{{code language="json"}}
104		-{
105		- "Code": "00",
106		- "Message": "",
107		- "Timestamp": "2024-02-29T17:24:32.2398363+04:00",
108		- "Version": "r1",
109		- "ResponseID": "4a75b8da-5b95-4d97-a580-dbb837670a05",
110		- "Data": {
111		- "ReservationNumber": "18571",
112		- "ReservationDate": "2024-02-29T17:24:28.7",
113		- "ReservationStatusName": "DraftOverLimit",
114		- "ReservationTourists": [
115		- {
116		- "FirstName": "Teeest",
117		- "LastName": "Teeest",
118		- "ChildFlag": 0,
119		- "BirthDate": "1981-01-01T00:00:00",
120		- "CountryCode": null,
121		- "CountryAccessCode": null,
122		- "AreaCityCode": null,
123		- "PhoneNumber": "+70000000000",
124		- "Gender": "Male",
125		- "ArrivalDate": "2024-05-06T00:00:00",
126		- "ArrivalFlightNumber": "",
127		- "ArrivalTerminalName": null,
128		- "DepartureDate": "2024-05-07T00:00:00",
129		- "DepartureFlightNumber": "",
130		- "DepartureTerminalName": null,
131		- "Email": null,
132		- "PassportNumber": "",
133		- "PassportType": null,
134		- "IssueCity": null,
135		- "IssueDate": null,
136		- "ExpiryDate": null,
137		- "Note": null
138		- }
139		- ],
140		- "ReservationHotels": [
141		- {
142		- "AgentConfirmationNumber": "testGM20240229_tccapi_2",
143		- "CheckInDate": "2024-05-06T00:00:00",
144		- "CheckOutDate": "2024-05-07T00:00:00",
145		- "HotelName": null,
146		- "PriceID": "a5e45e73-eccd-43e1-b41b-e8f29a8c1dba",
147		- "MealPlanName": null,
148		- "PlacementTypeName": "SNGL",
149		- "Note": "Deluxe, 2 Twins, Mini fridge, 23sqm/247sqft-25sqm/269sqft, Wireless internet, complimentary, Wired internet, complimentary, Coffee/tea maker, 43in/109cm LED TV Cancellation Policy: penalty for cancellation 0-24 hours before checkin is EUR 108.37, penalty for cancellation after 12AM is EUR 108.37, penalty for NoShow is EUR 108.37"
150		- }
151		- ],
152		- "ReservationTransferServices": [
153		- {
154		- "TransferDate": "2024-05-06T00:00:00",
155		- "ServiceName": "WITHOUT",
156		- "FromTerminalName": "ADB",
157		- "ToTerminalName": null,
158		- "FromHotelName": null,
159		- "ToHotelName": "Delta Hotels Istanbul Halic",
160		- "VehicleTypeName": "WITHOUT"
161		- },
162		- {
163		- "TransferDate": "2024-05-07T00:00:00",
164		- "ServiceName": "WITHOUT",
165		- "FromTerminalName": null,
166		- "ToTerminalName": "ADB",
167		- "FromHotelName": "Delta Hotels Istanbul Halic",
168		- "ToHotelName": null,
169		- "VehicleTypeName": "WITHOUT"
170		- }
171		- ],
172		- "ReservationServices": []
173		- }
174		-}
175		-{{/code}}
176		-
177		-
178		-== Definition of Response Parameters ==
179		-
180		-(% class="table-bordered" %)
181		-(% class="info" %)|**Parameter**|**value**|**Description**
182		-|**{**| |
183		-|** "resultID"**| 1656436810005000001,|Unique ID of the Result
184		-|** "hotelID"**| 871186,|Unique ID of the hotel
185		-|** "providerID"**| 5,|provider id - (system internal)
186		-|** "roomCategoryCode"**| "ECO",|Special code for Room Category type
187		-|** "roomCategoryName"**| "Economic Room",|Name of the Room Category Type - definition of the ** "roomCategoryCode"**
188		-|** "mealPlanName"**| "BB",|Meal Plan code
189		-|** "placementType"**| 1,|Placement type code - in this case  1 means  single
190		-|** "placementTypeName"**| "1 Adult",|Placement type name - definition of the ** "placementType"**
191		-|** "priceCode"**| "BASERATE BB ECO",|price code for the current option
192		-|** "priceCurrency"**| "EUR",|
193		-|** "priceCurrencySrc"**| "EUR",|
194		-|** "availability"**| 3,|Availability
195		-|** "availableRoomsCount"**| 1,|Number of available rooms for the current type of options
196		-|** "totalSellPriceSrc"**| 40.70,|
197		-|** "totalSellPrice"**| 40.70,|
198		-|** "totalPriceSurcharge"**| 0.00,|
199		-|** "cancellationPolicyDescription"**| "Cancellation Policy  Non refundable",|TEXT DESCRIPTION OF THE CANCELLATION POLICY
200		-|** "cancellationPolicy"**| {|
201		-|** "noShowChargeValue"**| 100.00,|
202		-|** "noShowChargeValueType"**| "%",|
203		-|** "earlyDepartureChargeValue"**| 100.00,|
204		-|** "earlyDepartureChargeValueType"**| "%",|
205		-|** "conditions"**| [|
206		-|** {**| |
207		-|** "timeunits"**| 365,|
208		-|** "timeunitType"**| "Day",|
209		-|** "timeOffsetTypeName"**| "Before Arrival",|
210		-|** "chargeValue"**| 100.00,|
211		-|** "chargeValueType"**| "%"|
212		-|** }**| |
213		-|** ]**| |
214		-|** },**| |
215		-|** "searchId"**| 1656436810,|search id of the hotel
216		-|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
217		-|** "id"**| 1656436810005000001,|
218		-|** "hotel"**| {|
219		-|** "hotelCode"**| "10b7bc34-2a03-495e-94bc-1092b07823f7",|Unique ID of the Hotel. Full List of the hotels is available in [[Get Hotels>>Get Hotels]] method
220		-|** "hotelName"**| "Istanbul Holiday Hotel",|Full name of the Hotel
221		-|** "hotelClass"**| "~*~**",|Hotel Class in Stars
222		-|** "cityId"**| "e1344ba0-5273-4fc1-b6c4-72446260f430",|Code of the city where  hotel is located, which is available in method [[Get Cities>>Get Cities]] in parameter [cityid]
223		-|** "cityName"**| "Istanbul",|Full Name of the City
224		-|** "countryCode"**| "TR",|Country code, which can be retrieved in [[Get Cities>>Get Cities]] method, in parameter [countrycode]
225		-|** "districtId"**| "6ca0ed7e-7412-4e45-85b5-dd0d74cabc62",|District unique code, where hotel is located.
226		-|** "districtName"**| "Fatih",|Full name of the District
227		-|** "note"**| ""|Hotel note - this is optional
228		-|** },**| |
229		-|** "adults"**| 1,|Number of the adults
230		-|** "children"**| 0,|Number of the children
231		-|** "childrenAges"**| "",|in case of children, here will be their ages
232		-|** "childrenExeptInfants"**| 0,|
233		-|** "checkInDate"**| "2024-05-06T00000",|date of the check in
234		-|** "checkOutDate"**| "2024-05-07T00000",|date of the check out
235		-|** "includedExtrasAmount"**| 0,|
236		-|** "extraServices"**| []|
237		-|** },**| |