Dokumentasi API Mandira

08 Jan

BY contactwahyu IN API Comments Off on Dokumentasi API Mandira Mandira

version: 1.3

Release Notes:

Fixing parsing error bug when you’re parsing XML document.
Function GetHotelList is no longer available.
Add API Function GetBookingDetail to check your booking.
Add Field Image on Hotel Detail so you can grab hotel image from our image library.

(Updated: 12 September 2014)

Add API Function GetCity to check available city.

(Updated: 29 September 2014)

Add API Function BookingHotDeal to make reservation for Hot Deal.
Add API Function BookingSuperDeal to make reservation for Super Deal.
Add API Function GetBonusNight to get the information about the promotion.
Add API Function BookingBonusNight to make reservation for Bonus Night.

(Updated: 26 December 2014)

Rationale

Mandira Abadi Hotel Reservation is one of the leading Hotel Reservation in Indonesia. Since 2008, Mandira has developed an Extranet B2B System that allowed its supplier and sub agent to make a booking online transaction via our website http://www.mandiratravel.com.

As the technology rapidly growing, the requirement of the data has also significantly increased. The travel agent has realized the importance for having not only a website that contain static information of their company profile, but more than that, a website that has lots of feature for its customer to make an onlne reservation. What we’ve been receiving recently from our sub agent, some of them has been asking to have an access to our database using web service.

About Web Service

We have been trying to implement web service to our website. We provides two types of data for communication between web server, JSON and XML. In this documentation, it will explain the XML API Format that you can use later on to retrieve our data

XML

Requirement:

Before you can use each function, you need to have an ID Agent, Username and Password. Please contact Mandira if you don’t have the authorization. Please note that this user credential is different with the regular one that you used in our system.

There are 13 (thirteen) API Functions for Read and 4 (four) API Function for Write that can be used to get the data from Mandira Database

GetAllotment
GetAvailableRoom
GetAvailableSuperDeal
GetCutOffDate
GetHotDealRates
GetHotelDetail
GetHotelListArea
GetRegularRates
GetSuperDealRates
HotelSearch
GetBookingDetail
GetCity
GetBonusNight

Technical Support

Please feel free to contact us for further question:

webmaster@mandiratravel.com

GetAllotment

URL: (will be provided in your scenario testing document)

Function: return allotment based on the parameter given

Parameter: HotelId, RoomType, Allotment_Start, Allotment_End

Return Value: Allotment

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAllotment>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetAllotment_Request>

<RoomType>ClubRoom</RoomType>

<Allotment_Start>2014-10-10</Allotment_Start>

<Allotment_End>2014-10-12</Allotment_End>

</GetAllotment_Request>

</WebService_GetAllotment>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAllotment>

<Status>Success</Status>

</Message>

<GetAllotment_Response>

</GetAllotment_Response>

<GetAllotment_Response>

</GetAllotment_Response>

<GetAllotment_Response>

</GetAllotment_Response>

</WebService_GetAllotment>

GetAvailableRoom

URL: (will be provided in your scenario testing document)

Function: return available room based on the parameter given

Parameter: HotelId

Return Value: Available Room

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAvailableRoom>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetAvailableRoom_Request>

</GetAvailableRoom_Request>

</WebService_GetAvailableRoom>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAvailableRoom>

<Status>Success</Status>

</Message>

<GetAvailableRoom_Response>

<RoomType>ClubRoom</RoomType>

</GetAvailableRoom_Response>

<GetAvailableRoom_Response>

<RoomType>DeluxeRoom</RoomType>

<Notes>default</Notes>

</GetAvailableRoom_Response>

</WebService_GetAvailableRoom>

GetAvailableSuperDeal

URL: (will be provided in your scenario testing document)

Function: return available Super Deal based on the parameter given

Parameter: HotelId, RoomType

Return Value: BookingPeriod & TravelingPeriod of Super Deal

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAvailableSuperDeal>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetAvailableSuperDeal_Request>

<RoomType>The Haven Room</RoomType>

</GetAvailableSuperDeal_Request>

</WebService_GetAvailableSuperDeal>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetAvailableSuperDeal>

<Status>Success</Status>

</Message>

<GetAvailableSuperDeal_Response>

</GetAvailableSuperDeal_Response>

</WebService_GetAvailableSuperDeal>

GetCutOffDate

URL: (will be provided in your scenario testing document)

Function: return cutoffdate and cancelation policy based on the parameter given

Parameter: HotelId, StartDate, EndDate

Return Value: CutOffDate and Cancelation Policy

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetCOD>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetCOD_Request>

<COD_Start>2014-10-10</COD_Start>

<COD_End>2014-10-12</COD_End>

</GetCOD_Request>

</WebService_GetCOD>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetCOD>

<Status>Success</Status>

</Message>

<GetCOD_Response>

</GetCOD_Response>

<GetCOD_Response>

</GetCOD_Response>

<GetCOD_Response>

</GetCOD_Response>

</WebService_GetCOD>

GetHotDealRates

URL: (will be provided in your scenario testing document)

Function: return hot deal rates based on the parameter given

Parameter: HotelId, RoomType, StartDate, EndDate

Return Value: Hot Deal rates

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotDealRates>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetHotDealRates_Request>

<RoomType>The Haven Room</RoomType>

<Rates_Start>2014-09-10</Rates_Start>

<Rates_End>2014-09-11</Rates_End>

</GetHotDealRates_Request>

</WebService_GetHotDealRates>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotDealRates>

<Status>Success</Status>

</Message>

<GetHotDealRates_Response>

</GetHotDealRates_Response>

<GetHotDealRates_Response>

</GetHotDealRates_Response>

</WebService_GetHotDealRates>

GetHotelDetail

URL: (will be provided in your scenario testing document)

Function: return hotel detail based on the parameter given

Parameter: HotelId

Return Value: Hotel Detail

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotelDetail>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetHotelDetail_Request>

</GetHotelDetail_Request>

</WebService_GetHotelDetail>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotelDetail>

<Status>Success</Status>

</Message>

<GetHotelDetail_Response>

<HotelName>Hotel Bumi Surabaya </HotelName>

<HotelAddress>Jl. Jend Basuki Rachmat 106-128</HotelAddress>

<HotelCity>Surabaya</HotelCity>

<HotelCountry>Indonesia</HotelCountry>

…

</GetHotelDetail_Response>

</WebService_GetHotelDetail>

GetHotelListArea

URL: (will be provided in your scenario testing document)

Function: return hotel list based on the parameter given

Parameter: Area

Return Value: Hotel List

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotelListArea>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetHotelListArea_Request>

<Area>Surabaya</Area>

</GetHotelListArea_Request>

</WebService_GetHotelListArea>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetHotelListArea>

<Status>Success</Status>

</Message>

<GetHotelListArea_Response>

<HotelName>Amaris Hotel Embong Malang Surabaya</HotelName>

<HotelAddress>Jl. Kedungdoro 1-3</HotelAddress>

<HotelCity>Surabaya</HotelCity>

<HotelCountry>Indonesia</HotelCountry>

</GetHotelListArea_Response>

…

</WebService_GetHotelListArea>

GetRegularRates

URL: (will be provided in your scenario testing document)

Function: return regular rates based on the parameter given

Parameter: HotelId, RoomType, StartDate, EndDate

Return Value: Regular rates

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetRegularRates>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetRegularRates_Request>

<RoomType>ClubRoom</RoomType>

<Rates_Start>2014-10-10</Rates_Start>

<Rates_End>2014-10-11</Rates_End>

</GetRegularRates_Request>

</WebService_GetRegularRates>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetRegularRates>

<Status>Success</Status>

</Message>

<GetRegularRates_Response>

</GetRegularRates_Response>

<GetRegularRates_Response>

</GetRegularRates_Response>

</WebService_GetRegularRates>

GetSuperDealRates

URL: (will be provided in your scenario testing document)

Function: return super deal rates based on the parameter given

Parameter: HotelId, RoomType, BookingPeriod

Return Value: Super Deal rates

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetSuperDealRates>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetSuperDealRates_Request>

<RoomType>The Haven Room</RoomType>

</GetSuperDealRates_Request>

</WebService_GetSuperDealRates>

Response from XML API Mandira:

—————————————————————————————————————————

<WebService_GetSuperDealRates>

<Status>Success</Status>

</Message>

<GetSuperDealRates_Response>

</GetSuperDealRates_Response>

<GetSuperDealRates_Response>

</GetSuperDealRates_Response>

…

</WebService_GetSuperDealRates>

HotelSearch

URL: (will be provided in your scenario testing document)

Function: return hotel list based on the parameter given

Parameter: String

Return Value: Hotel List

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_HotelSearch>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<HotelSearch_Request>

</HotelSearch_Request>

</WebService_HotelSearch>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_HotelSearch>

<Status>Success</Status>

</Message>

<HotelSearch_Response>

<HotelCountry>Indonesia</HotelCountry>

…

</HotelSearch_Response>

…

</WebService_HotelSearch>

GetBookingDetail

URL: (will be provided in your scenario testing document)

Function: return hotel list based on the parameter given

Parameter: ReferenceId

Return Value: Booking Detail

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetBookingDetail>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetBookingDetail_Request>

<ReferenceId>KITWL68C</ReferenceId>

</GetBookingDetail_Request>

</WebService_GetBookingDetail>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetBookingDetail>

<Status>Success</Status>

</Message>

<GetBookingDetail_Response>

<HotelName>Mandira Trial Hotels</HotelName>

<HotelAddress>Kedungsari no. 31</HotelAddress>

<GuestName>MR. BUDI SUCIPTO</GuestName>

<BedType>Double</BedType>

<RoomType>Deluxe</RoomType>

<Status>RECONFIRMED</Status>

</GetBookingDetail_Response>

</WebService_GetBookingDetail>

GetCity

URL: (will be provided in your scenario testing document)

Function: return city/area list based on the parameter given

Parameter: none

Return Value: City List

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetCity>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetCity_Request>

</GetCity_Request>

</WebService_GetCity>

Response from XML API Mandira:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetCity>

<Status>Success</Status>

</Message>

<GetCity_Response>

<City>Ambon</City>

</GetCity_Response>

<GetCity_Response>

</GetCity_Response>

<GetCity_Response>

<City>Balikpapan</City>

</GetCity_Response>

…

</WebService_GetCity>

GetBonusNight

URL: (will be provided in your scenario testing document)

Function: return bonus night rates based on the parameter given

Parameter: HotelId, RoomType, BookingPeriod

Return Value: Bonus Night rates

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_GetBonusNightRates>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<GetBonusNightRates_Request>

<RoomType>The Haven Room</RoomType>

</GetBonusNightRates_Request>

</WebService_GetBonusNightRates>

Response from XML API Mandira:

—————————————————————————————————————————

<WebService_GetBonusNightRates>

<Status>Success</Status>

</Message>

<GetBonusNightRates_Response>

</GetBonusNightRates_Response>

<GetBonusNightRates_Response>

</GetBonusNightRates_Response>

…

</WebService_GetBonusNightRates>

Booking Service

We are developing API to enable you for making booking through web service. Before we can show you the XML Format, you need to know about the parameters of the request XML

Parameter Name	Parameter Type	Sample of Data
HotelId	String	H0000626
GuestName	String	WAHYU KURNIAWAN
GuestNumber	Integer	2
Phone	String	081123456789
CheckIn	Date yyyy-mm-dd	2014-10-01
CheckOut	Date yyyy-mm-dd	2014-10-02
RoomType	String	Deluxe
BedType	String	Double
Qty	Integer	1
Remarks	String	Non Smoking

Once you call this API, check parameter Message, it will return you with the message as below

SUCCESS MESSAGE

Congratulations! You will get the ReferenceId for your booking

FAILED MESSAGE

*** Hotel tidak ditemukan!
*** Nama Tamu terlalu panjang!
*** Jumlah Tamu melebihi batas yang ditentukan!
*** Jumlah Tamu tidak valid!
*** Telepon terlalu panjang!
*** Tanggal Check In invalid!
*** Tanggal Check Out invalid!
*** Periode yang anda pilih menerapkan Minimum Stay Policy…
*** Periode tersebut tidak valid karena dalam masa cutoff date!
*** Periode yang diminta melebihi batas maksimum booking!
*** Periode yang dipilih tidak valid!
*** Tipe Kamar tidak ditemukan!
*** Jumlah Kamar yang dibooking melebihi batas yang ditentukan!
*** Allotment tidak mencukupi!
*** Jumlah Kamar yang dibooking tidak valid!
*** Tipe Bed yang dipilih tidak valid!

When you encountered the Failed Message, make sure to check your parameter based on the failed message that you received. Next, you will see the sample of the XML.

BookingRegular

URL: (will be provided in your scenario testing document)

Function: return ReferenceId of your booking!

Parameter: as described in previous page

Return Value: ReferenceId

Example XML Request:

—————————————————————————————————————————

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_BookingRegular>

<APIKey>YourAPIKey</APIKey>

<AgentId>YourAgentID</AgentId>

<AgentName>YourAgentName</AgentName>

<AgentPassword>YourAgentPassword</AgentPassword>

</AgentLogin>

<BookingRegular_Request>

<GuestName>MR. BUDI SUCIPTO</GuestName>

<RoomType>Deluxe</RoomType>

<BedType>Double</BedType>

<Remarks>TRIAL WEB SERVICE</Remarks>

</BookingRegular_Request>

</WebService_BookingRegular>

Response from XML API Mandira:

—————————————————————————————————————————

FAILED

<?xml version=”1.0″ encoding=”UTF-8″?>

<WebService_BookingRegular>

<Status>*** Allotment tidak mencukupi!</Status>

</Message>

</WebService_BookingRegular>

SUCCESS

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<WebService_BookingRegular>

<Status>Success</Status>

</Message>

<BookingRegular_Response>

</BookingRegular_Response>

</WebService_BookingRegular>

Other Booking Service

Besides the Regular Booking, we also developed another three bookings which we believe will give you the advantages and experience a booking with special rates!

HOT DEAL

Special rates from our hotel which allow you to book in the same month

SUPER DEAL

Sepecial rates from our hotel that define a specific Booking and Traveling Period for you convenience

BONUS NIGHT

Special offer for you to get one night additional for FREE

The parameters given to the API will be the same as Regular Booking, unless for Bonus Night Booking, there’s one additional parameter to determine which package that you book:

3N Pay 2N

4N Pay 3N

5N Pay 4N

6N Pay 5N

7N Pay 6N

Please note that you have to pass the parameter exactly the same as above

Here’s also the additional failed message

*** Maaf tidak dapat melakukan reservasi karena terbentur dengan Booking Period!
*** Maaf tidak dapat melakukan reservasi karena terbentur dengan Traveling Period!
*** Tipe Bed yang dipilih tidak valid!
*** Tipe Bonus Night yang dipilih tidak valid!

Oleh: Wahyu Kurniawan

Our Blog