POST/Package Booking
Booking your package.
HOW TO USE?
The SavePackageDetails the ------
HEADERS TO USE FOR REQUEST
|
Parameter |
Value |
Description |
|
Method |
POST |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json, text/plain, */* |
|
|
Accept-Language |
{{language}}-{{country}} |
|
|
APIKEY |
as given you |
|
|
AFFILIATECODE |
as given you |
For Affiliate only. Not required for Tenant |
|
TENANTCODE |
as given you |
For Tenants only. Not required for affiliate |
BODY PARAMETERS
|
Parameter |
Type |
Description |
Example |
|
ArrivalDate |
String |
Provide Tenant code |
Code Provided Separately |
|
ReturnDate |
String |
|
|
|
TenantCode |
String |
|
|
|
TransactionUniqueId |
string |
Provide unique id having length of 15 character, alphanumeric only. Using that unique id you can check the status of booking (using API - api/PackageBooking/GetBookingStatus) |
|
|
AffiliateCode |
String |
For affiliates only |
|
|
PromoCode |
String |
For affiliates only |
|
|
NoOfNight |
int |
|
|
|
DiscountID |
int |
|
|
|
ParkPassID |
int |
|
|
|
SpecialRequest |
String |
|
|
|
SearchType |
String |
|
|
|
RoomOnly |
Boolean |
Flag to identify Park Pass Price included in the Package Price or Not. |
true/false |
|
TenantReferenceNo |
string |
This is the Tenants Internal Reference No Which can be used as Booking Reference No and will be returned in the booking success response.(For affiliates only) |
Ex. TCODE8872735632 |
|
HotelRoomObj |
arrayObj |
|
|
|
.HotelID |
int |
|
|
|
.HotelName |
String |
|
|
|
.RoomID |
int |
|
|
|
.RoomName |
String |
|
|
|
.RoomPrice |
int |
|
|
|
.AllotmentCode |
String |
|
|
|
.RatePlanObj |
|
|
|
|
.. RatePlanCategory |
String |
This is applicable Rate Plan Category Code |
ROOM_TICKET_GEN/ ROOM_TICKET_HB/ ROOM_TICKET_GC/ ROOMONLY |
|
.. RatePlanCode |
String |
This is applicable Rate Plan Code |
Ex. RSTAEVTC0JEE2X9 |
|
.. MealPlanCode |
String |
This is applicable Meal Plan Code |
NOM/ BK/ HalfBoardPlusIncluded/ HalfBoardStandardIncluded |
|
.. RoomTypeCode |
String |
Applicable to this Room Type Code |
Ex. HTLAEVRO4 |
|
.. PropertyCode |
String |
Applicable to this is Hotel Code |
Ex. AEV |
|
HotelExtraObj |
arrayObj |
|
|
|
.BookingDateWiseExtraList |
arrayObj |
|
|
|
..DatewiseSubTotal |
int |
|
|
|
..ObjDateWiseExtras |
arrayObj |
|
|
|
...HotelExtraID |
int |
|
|
|
...HotelExtraName |
String |
|
|
|
...ServiceInventryCode |
String |
To Identify Service & Its Pricing |
CAKDBITP0JEE2X9_CAKDBITP0_5 |
|
...ExtraSubtotal |
int |
|
|
|
...IncludeExtraOption |
String |
|
|
|
...RoomCount |
int |
|
|
|
...ObjPricingPeriod |
arrayObj |
|
|
|
....PerBookingActualPrice |
int |
|
|
|
....objAgePrice |
arrayObj |
|
|
|
.....NoOfPersons |
int |
|
|
|
.....AgeCategoryCode |
string |
|
|
|
.....AgeCategoryName |
string |
|
|
|
..BookingDay |
string |
|
|
|
..BookingDate |
datetime |
|
|
|
.ExtraGrandTotal |
int |
|
|
|
TransferObj |
arraObj |
|
|
|
.SelectedTransferObj |
arraObj |
|
|
|
..HotelTransferID |
int |
|
|
|
..TransferName |
string |
|
|
|
..TransferTypeCode |
string |
|
|
|
..ObjPerPerson |
arraObj |
|
|
|
...ObjPersonPrice |
arraObj |
|
|
|
....NoOfPersons |
int |
|
|
|
....AgeCategoryCode |
string |
|
|
|
.FlightTiming |
arraObj |
|
|
|
..FlightArrivalTime |
datetime |
|
|
|
..FlightDepartureTime |
datetime |
|
|
|
.TransferSubtotal |
int |
|
|
|
.SelectedTransferVehicleTypeID |
int |
|
|
|
.NoOfVehicles |
int |
|
|
|
.JourneyType |
string |
|
|
|
.ChildSeatsRequired |
int |
|
|
|
.JourneyDirection |
string |
|
|
|
LeadPersonObj |
arrayObj |
|
|
|
.FullName |
string |
|
|
|
.Address |
string |
|
|
|
.PostalCode |
string |
|
|
|
|
string |
|
|
|
.TelephoneNo |
string |
|
|
|
PaymentObj |
Obj |
|
|
|
.DepositAmount |
decimal |
|
|
|
.TotalAmount |
decimal |
|
|
|
MemberList |
arrayObj |
List of all members including lead person |
|
|
.AgeCategoryCode |
string |
|
|
|
.AgeCategoryGroupCode |
string |
|
|
|
.AgeCategoryName |
string |
|
|
|
.DateOfBirth |
datetime |
|
|
|
.Title |
string |
|
|
|
.FirstName |
string |
|
|
|
.LastName |
string |
|
|
|
AgecategoryWiseNoOfPersonsInSearch |
string |
|
|
|
.AgeCategoryCode |
string |
|
|
|
.PersonCount |
int |
|
|
|
PassengerAllotment |
arrayObj |
|
|
|
.RoomAllotment |
arrayObj |
|
|
|
..AgeCategoryCode |
string |
|
|
|
..PersonCount |
int |
|
|
|
PostageObj |
arrayObj |
|
|
|
..PostageName |
string |
|
|
|
..PostageID |
int |
|
|
|
..PostagePrice |
int |
|
|
|
PostageID |
int |
|
|
Note - In the booking request object you have to pass the exact same room allocation element(PassengerAllotment) which we pass in the get hotel availability api.(at the time of room check-in, you can reallocate the persons as needed)
UAT URL: https://uat.breakaway.ie/api/PackageBooking/SavePackageDetails
RESPONSE PARAMETERS
|
Name |
Type |
Description |
Example |
|
Result |
String |
Provide Tenant code |
ETST |
|
Message |
String |
|
|
|
Object |
Array of Objects |
|
|
|
ExtraObject |
|
|
|
|
IsTimeout |
boolean |
|
|
|
HttpResponseCode |
int |
|
|
|
ErrorCode |
|
|
|
ERROR CODES
|
HTTP Status |
Type |
|
500 |
INTERNAL_SERVER_ERROR |
IMP Note
1.Please follow the process that every time before showing hotels call API ”GetHotels". So you can get updated prices and offers available for rooms.
2.When the Discount price is there for room send values for DiscountID and DiscountObj in the API.
SAMPLE REQUEST
•With Hotel Extra:
{
"ArrivalDate": "2017-10-20T00:00:00",
"ReturnDate": "2017-10-23T00:00:00",
"TenantCode": "BRKY",
"AffiliateCode": "Click100",
"PromoCode": "",
"NoOfNight": 3,
"DiscountID": null,
"ParkPassID": 2,
"SpecialRequest": "Test",
"SearchType": "HotelPark",
"RoomOnly": false,
"TenantReferenceNo": null,
"HotelRoomObj": {
"HotelID": 1,
"HotelName": "Santa fe",
"RoomID": 1,
"RoomName": "Standard Max 4",
"RoomPrice": 859.94,
"AllotmentCode": "O",
"RatePlanObj": {
"RatePlanCategoryId": 1,
"RatePlanCategory": "ROOM_TICKET_GEN",
"RatePlanID": 32,
"RatePlanCode": "RSTDNBTC0JEETGX",
"MealPlanID": 1,
"MealPlanCode": "NOM",
"RoomTypeCode": "HTLD3TRO4",
"PropertyCode": "49629"
}
},
"HotelExtraObj": {
"BookingDateWiseExtraList": [
{
"DatewiseSubTotal": 130,
"ObjDateWiseExtras": [
{
"HotelExtraID": 99,
"HotelExtraName": "Wild West Show Premium Seats Show 06.30pm",
"ServiceInventryCode": "WWSDBITP0JEE2X9_WWSDBITP0_5",
"ExtraSubtotal": 130,
"IncludeExtraOption": "P",
"RoomCount": 0,
"ObjPricingPeriod": [
{
"PerBookingActualPrice": 0,
"objAgePrice": [
{
"NoOfPersons": 2,
"AgeCategoryCode": "AD",
"AgeCategoryName": "Adults (18+ yrs)"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH1218",
"AgeCategoryName": "Adults (12-17 yrs)"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH711",
"AgeCategoryName": "Children (7-11 yrs)"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH36",
"AgeCategoryName": "Children (3-6 yrs)"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH03",
"AgeCategoryName": "Infants (0-2 yrs)"
}
]
}
]
}
],
"BookingDay": "Saturday",
"BookingDate": "2017-07-21T00:00:00"
},
{
"DatewiseSubTotal": 29,
"ObjDateWiseExtras": [
{
"HotelExtraID": 98,
"HotelExtraName": "Birthday Cake (Per Cake 6-8 people)",
"ServiceInventryCode": "CAKDBITP0JEE2X9_CAKDBITP0_5",
"ExtraSubtotal": 29,
"IncludeExtraOption": "B",
"RoomCount": 0,
"ObjPricingPeriod": [
{
"PerBookingActualPrice": 29,
"objAgePrice": []
}
]
}
],
"BookingDay": "Sunday",
"BookingDate": "2017-07-22T00:00:00"
},
{
"DatewiseSubTotal": 50,
"ObjDateWiseExtras": [
{
"HotelExtraID": 100,
"HotelExtraName": "CBDND Character Breakfast 2nd Seating 09.30 Disney",
"ServiceInventryCode": "CHADBITP0JEE2X9_CHADBITP0_5"
"ExtraSubtotal": 50,
"IncludeExtraOption": "R",
"RoomCount": 1,
"ObjPricingPeriod": [
{
"PerBookingActualPrice": 50,
"objAgePrice": []
}
]
}
],
"BookingDay": "Monday",
"BookingDate": "2017-07-23T00:00:00"
}
],
"ExtraGrandTotal": 209
},
"TransferObj": {
"SelectedTransferObj": {
"HotelTransferID": 1,
"TransferName": "Magical Shuttle",
"TransferTypeCode": "P",
"ObjPerPerson": [
{
"ObjPersonPrice": [
{
"NoOfPersons": 2,
"AgeCategoryCode": "AD"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH1218"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH711"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH36"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH03"
}
]
}
]
},
"FlightTiming": {
"FlightArrivalTime": null,
"FlightDepartureTime": null
},
"TransferSubtotal": 92,
"SelectedTransferVehicleTypeID": null,
"NoOfVehicles": 1,
"JourneyType": "1",
"ChildSeatsRequired": 1,
"JourneyDirection": "HA"
},
"LeadPersonObj": {
"FullName": "Harry Burke",
"Address": "12 Leinster St S, \r\nDublin 2, \r\nIreland",
"PostalCode": "123456789",
"Email": "test@gmail.com",
"TelephoneNo": "35316079900"
},
"PaymentObj": {
"DepositAmount": 190,
"TotalAmount": 971
},
"MemberList": [
{
"AgeCategoryCode": "AD",
"AgeCategoryGroupCode": "AD",
"AgeCategoryName": "Adults (18+ yrs)",
"DateOfBirth": null,
"Title": "Mr.",
"FirstName": "Harry",
"LastName": "Burke"
},
{
"AgeCategoryCode": "AD",
"AgeCategoryGroupCode": "AD",
"AgeCategoryName": "Adults (18+ yrs)",
"DateOfBirth": null,
"Title": "Mr.",
"FirstName": "Jack",
"LastName": "Burke"
}
],
"AgecategoryWiseNoOfPersonsInSearch": [
{
"AgeCategoryCode": "AD",
"PersonCount": 2
},
{
"AgeCategoryCode": "CH1218",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH711",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH36",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH03",
"PersonCount": 0
}
],
"PassengerAllotment": [
{
"RoomAllotment": [
{
"AgeCategoryCode": "AD",
"PersonCount": 2
},
{
"AgeCategoryCode": "CH1218",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH711",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH36",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH03",
"PersonCount": 0
}
]
}
],
"PostageObj": {
"PostageName": " Express Post +(Ticket Pack) €10",
"PostageID": 2,
"PostagePrice": 0
},
"PostageID": 2
}
•Without Hotel Extra:
{
"ArrivalDate": "2017-10-20T00:00:00",
"ReturnDate": "2017-10-23T00:00:00",
"TenantCode": "BRKY",
"AffiliateCode": "Click100",
"PromoCode": "",
"NoOfNight": 3,
"DiscountID": null,
"ParkPassID": 2,
"SpecialRequest": "Test",
"SearchType": "HotelPark",
"RoomOnly": false,
"TenantReferenceNo": null,
"HotelRoomObj": {
"HotelID": 1,
"HotelName": "Santa fe",
"RoomID": 1,
"RoomName": "Standard Max 4",
"RoomPrice": 859.94,
"AllotmentCode": "O",
"RatePlanObj": {
"RatePlanCategoryId": 1,
"RatePlanCategory": "ROOM_TICKET_GEN",
"RatePlanID": 32,
"RatePlanCode": "RSTDNBTC0JEETGX",
"MealPlanID": 1,
"MealPlanCode": "NOM",
"RoomTypeCode": "HTLD3TRO4",
"PropertyCode": "49629"
}
},
"HotelExtraObj": null,
"TransferObj": {
"SelectedTransferObj": {
"HotelTransferID": 1,
"TransferName": "Magical Shuttle",
"TransferTypeCode": "P",
"ObjPerPerson": [
{
"ObjPersonPrice": [
{
"NoOfPersons": 2,
"AgeCategoryCode": "AD"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH1218"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH711"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH36"
},
{
"NoOfPersons": 0,
"AgeCategoryCode": "CH03"
}
]
}
]
},
"FlightTiming": {
"FlightArrivalTime": null,
"FlightDepartureTime": null
},
"TransferSubtotal": 92,
"SelectedTransferVehicleTypeID": null,
"NoOfVehicles": 1,
"JourneyType": "1",
"ChildSeatsRequired": 1,
"JourneyDirection": "HA"
},
"LeadPersonObj": {
"FullName": "Harry Burke",
"Address": "12 Leinster St S, \r\nDublin 2, \r\nIreland",
"PostalCode": "123456789",
"Email": "test@gmail.com",
"TelephoneNo": "35316079900"
},
"PaymentObj": {
"DepositAmount": 190,
"TotalAmount": 971
},
"MemberList": [
{
"AgeCategoryCode": "AD",
"AgeCategoryGroupCode": "AD",
"AgeCategoryName": "Adults (18+ yrs)",
"DateOfBirth": null,
"Title": "Mr.",
"FirstName": "Harry",
"LastName": "Burke"
},
{
"AgeCategoryCode": "AD",
"AgeCategoryGroupCode": "AD",
"AgeCategoryName": "Adults (18+ yrs)",
"DateOfBirth": null,
"Title": "Mr.",
"FirstName": "Jack",
"LastName": "Burke"
}
],
"AgecategoryWiseNoOfPersonsInSearch": [
{
"AgeCategoryCode": "AD",
"PersonCount": 2
},
{
"AgeCategoryCode": "CH1218",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH711",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH36",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH03",
"PersonCount": 0
}
],
"PassengerAllotment": [
{
"RoomAllotment": [
{
"AgeCategoryCode": "AD",
"PersonCount": 2
},
{
"AgeCategoryCode": "CH1218",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH711",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH36",
"PersonCount": 0
},
{
"AgeCategoryCode": "CH03",
"PersonCount": 0
}
]
}
],
"PostageObj": {
"PostageName": " Express Post +(Ticket Pack) €10",
"PostageID": 2,
"PostagePrice": 0
},
"PostageID": 2
}
SAMPLE RESPONSE
{
"Result": true,
"ResultMessage": "Booking done successfully.",
"Object": "ETST1001122049",
"ExtraObject": true,
"IsTimeout": false,
"HttpResponseCode": 200,
"ErrorCode": null
}
Created with the Personal Edition of HelpNDoc: Free iPhone documentation generator