Master-Interlook:IntegrationService (en) — различия между версиями
| [досмотренная версия] | [досмотренная версия] |
Biryukov (обсуждение | вклад) (→Methods of working with dictionaries) |
Biryukov (обсуждение | вклад) (→Методы интеграции с системами оплаты) |
||
| Строка 6000: | Строка 6000: | ||
</div></div><br /> | </div></div><br /> | ||
| − | == | + | ==Methods of integration with payment systems== |
| − | === GetReservationPenalties ( | + | ===GetReservationPenalties (Receiving the penalties for the reservation before canceling it)=== |
| − | + | The method returns the amount of penalties for the reservation before it is canceled.<br /> | |
| − | + | The operation of the method is regulated by a license.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''Guid *''' – | + | * '''Guid *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''ReservationKey *''' – | + | * '''ReservationKey *''' – the reservation key |
| − | * '''CancellationDate''' – | + | * '''CancellationDate''' – the cancellation date on which the condition and the amount of the fine are issued. If not specified, then we get all possible cancellation rules up to arrival. |
| − | + | The returning result:<br /> | |
| − | * '''GetReservationPenaltiesResult''' – | + | * '''GetReservationPenaltiesResult''' – the search result |
| − | ** '''Penalty''' – | + | ** '''Penalty''' – fine |
| − | *** '''ServicePenalty''' – | + | *** '''ServicePenalty''' – the penalty service |
| − | **** '''ServiceClassID''' | + | **** '''ServiceClassID''' – id of the service class |
| − | **** '''ID''' – | + | **** '''ID''' – ID of the fine |
| − | **** '''Name''' – | + | **** '''Name''' – the name of the fine |
| − | **** '''PenaltyData''' – | + | **** '''PenaltyData''' – an array of penalty data |
| − | ***** '''PenaltyDataInfo''' – | + | ***** '''PenaltyDataInfo''' – an array of data |
| − | ****** '''TotalPenalty''' – | + | ****** '''TotalPenalty''' – the full amount of the penalty |
| − | ****** '''RateCode''' – | + | ****** '''RateCode''' – the currency code |
| − | ****** '''PolicyDescription''' – | + | ****** '''PolicyDescription''' – the penalty conditions |
| − | ****** '''CancellationPolicyData''' – | + | ****** '''CancellationPolicyData''' – an array of cancellation data |
| − | ******* '''PolicyKey''' – | + | ******* '''PolicyKey''' – the cancellation key |
| − | ******* '''DateFrom''' – | + | ******* '''DateFrom''' – date from |
| − | ******* '''DateTo''' – | + | ******* '''DateTo''' – date to |
| − | ******* '''PenaltyValue''' – | + | ******* '''PenaltyValue''' – the penalty value |
| − | ******* '''IsPercent''' - | + | ******* '''IsPercent''' - the percentage indicating that the penalty is in "%" (''true'') or in "nights" (''false'') |
| − | **** '''Hotel''' – | + | **** '''Hotel''' – the Hotel |
| − | ***** '''ID''' – | + | ***** '''ID''' – the hotel ID |
| − | ***** '''Name''' – | + | ***** '''Name''' – the name of the hotel |
| − | **** '''RoomType''' – | + | **** '''RoomType''' – the room type |
| − | ***** '''ID''' – | + | ***** '''ID''' – the Room ID |
| − | ***** '''Name''' – | + | ***** '''Name''' – the name of the room |
| − | **** '''RoomCategory''' – | + | **** '''RoomCategory''' – the room category |
| − | ***** '''ID''' – | + | ***** '''ID''' – ID of the room category |
| − | ***** '''Name''' – | + | ***** '''Name''' – the name of the room category |
| − | **** '''Accommodation''' – | + | **** '''Accommodation''' – the accommodation |
| − | ***** '''ID''' – | + | ***** '''ID''' – the accommodation ID |
| − | ***** '''Name''' – | + | ***** '''Name''' – the name of the placement |
| − | **** '''Pansion''' – | + | **** '''Pansion''' – the type of pansion supply |
| − | ***** '''ID''' – | + | ***** '''ID''' – ID of the type of pansion supply |
| − | ***** '''Name''' – | + | ***** '''Name''' – the name of the type of the pansion<br /> |
| − | + | In case of errors, we will receive a message with a decryption.<br /> | |
| − | + | In case of an incorrect Guid, we will receive the message: "Invalid user or password (Invalid GUID)".<br /> | |
| − | + | If there is no contract with the specified key for the current partner, we will receive the message:"Check the parameter 'reservationKey' = <value in request>. There is no booking in the database for you.".br /> | |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method GetReservationPenalties | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
| Строка 6061: | Строка 6061: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The returning result for the method GetReservationPenalties | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
| Строка 6235: | Строка 6235: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===CreatePayment ( | + | ===CreatePayment (Creating the payments for the reservation)=== |
| − | + | The method creates the payment for the reservation.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''UserToken *''' – | + | * '''UserToken *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''Date *''' – | + | * '''Date *''' – the date of payment creation |
| − | * '''Sum *''' – | + | * '''Sum *''' – the payment amount |
| − | * '''CurrencyIsoCode *''' – ISO | + | * '''CurrencyIsoCode *''' – the ISO code of the payment currency |
| − | * '''ReservationCode *''' – | + | * '''ReservationCode *''' – the reservation code |
| − | * '''PaymentId *''' – | + | * '''PaymentId *''' – the payment ID (set manually for subsequent identification of the payment). The unique code specified by the user once should not be repeated in the next payment for this reservation. |
| − | + | The returning result:<br /> | |
| − | * '''CreatePaymentResult''' – | + | * '''CreatePaymentResult''' – the output result |
| − | ** '''0''' – NoError – | + | ** '''0''' – NoError – no errors |
| − | ** '''1''' – DogovorNotFound – | + | ** '''1''' – DogovorNotFound – the reservation with this code was not found |
| − | ** '''2''' – InternalError – | + | ** '''2''' – InternalError – an internal error |
| − | ** '''3''' – DogovorAnnulate – | + | ** '''3''' – DogovorAnnulate – the reservation is canceled |
| − | ** '''4''' – DogovorPayed – | + | ** '''4''' – DogovorPayed – the reservation is paid |
| − | ** '''7''' – ExistingPaymentID – | + | ** '''7''' – ExistingPaymentID – the payment with such an external ID already exists |
| − | ** '''8''' – IncorrectPaymentType – | + | ** '''8''' – IncorrectPaymentType – there are payments of prohibited types for the reservation |
| − | ** '''9''' – NotAllowedPartnerKey – | + | ** '''9''' – NotAllowedPartnerKey – the partner on the reservation is not allowed |
| − | ** '''10''' – FailureSignature – | + | ** '''10''' – FailureSignature – the signature error |
| − | ** '''11''' – NoInvoices – | + | ** '''11''' – NoInvoices – there are no invoices for the reservation |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method CreatePayment | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
| Строка 6280: | Строка 6280: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The invocation of the method CreatePayment | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
| Строка 6293: | Строка 6293: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===GetPaymentInformation ( | + | ===GetPaymentInformation (Searching for the payment information with a specified payment ID from an external system)=== |
| − | + | The method returns information about the payment with the specified payment ID from the external system.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''UserToken *''' – | + | * '''UserToken *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''ReservationCode *''' – | + | * '''ReservationCode *''' – the reservation code |
| − | * '''ExternalPaymentId *''' – | + | * '''ExternalPaymentId *''' – the payment ID (the PaymentID parameter in the [[Master-Interlook:IntegrationService (en)#CreatePayment (Creating the payments for the reservation)|CreatePayment]] method request) |
| − | + | The returning result:<br /> | |
| − | * '''GetPaymentInformationResult''' – | + | * '''GetPaymentInformationResult''' – the output result |
| − | ** '''IsPaymentExists''' – | + | ** '''IsPaymentExists''' – shows if there is a requested payment |
| − | *** '''true''' – | + | *** '''true''' – the payment with the specified ID for the specified reservation exists |
| − | *** '''false''' – | + | *** '''false''' – there is no requested payment |
| − | ** '''PaymentInformationResult''' – | + | ** '''PaymentInformationResult''' – an array for payment data |
| − | *** '''InternalPaymentId''' – | + | *** '''InternalPaymentId''' – the payment ID in the Interlook system |
| − | *** '''DogovorCode''' – | + | *** '''DogovorCode''' – the reservation code |
| − | *** '''PaymentSum''' – | + | *** '''PaymentSum''' – the payment amount |
| − | *** '''PaymentNationalSum''' – | + | *** '''PaymentNationalSum''' – the amount of the payment in the national currency |
| − | *** '''PaymentRateISOCode''' – ISO | + | *** '''PaymentRateISOCode''' – the ISO code of the payment currency |
| − | *** '''CreateDate''' – | + | *** '''CreateDate''' – the date of payment |
| − | ** '''ErrorCode''' – | + | ** '''ErrorCode''' – the error code |
| − | *** '''0''' – NoError – | + | *** '''0''' – NoError – no errors |
| − | *** '''1''' – DogovorNotFound – | + | *** '''1''' – DogovorNotFound – the reservation with this code was not found |
| − | *** '''2''' – InternalError – | + | *** '''2''' – InternalError – an internal error |
| − | *** '''3''' – DogovorAnnulate – | + | *** '''3''' – DogovorAnnulate – the reservation is canceled |
| − | *** '''4''' – DogovorPayed – | + | *** '''4''' – DogovorPayed – the reservation is paid |
| − | *** '''7''' – ExistingPaymentID – | + | *** '''7''' – ExistingPaymentID – the payment with such an external ID already exists |
| − | *** '''8''' – IncorrectPaymentType – | + | *** '''8''' – IncorrectPaymentType – there are payments of prohibited types for the reservation |
| − | *** '''9''' – NotAllowedPartnerKey – | + | *** '''9''' – NotAllowedPartnerKey – the partner on the reservation is not allowed |
| − | *** '''10''' – FailureSignature – | + | *** '''10''' – FailureSignature – the signature error |
| − | *** '''11''' – NoInvoices – | + | *** '''11''' – NoInvoices – there are no invoices for the reservation |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method GetPaymentInformation | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
| Строка 6342: | Строка 6342: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The returning result for the method GetPaymentInformation | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
| Строка 6366: | Строка 6366: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===GetCancellationPolicyInfoWithPenalty ( | + | ===GetCancellationPolicyInfoWithPenalty (Receiving the information on the calculation of penalties for the hotel)=== |
<table style="background-color:#ffffcc;color:black" border="1" cellpadding="10" cellspacing="0"><tr><td> | <table style="background-color:#ffffcc;color:black" border="1" cellpadding="10" cellspacing="0"><tr><td> | ||
| − | + | This functionality is available starting from release 11.20<br> | |
</td></tr></table><br> | </td></tr></table><br> | ||
| − | + | The method returns information about the calculation of penalties for the hotel.<br /> | |
| − | + | The output of the method results is regulated by the license.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''Guid *''' – | + | * '''Guid *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''DateFrom *''' – | + | * '''DateFrom *''' – the start date of the stay |
| − | * '''DateTo *''' – | + | * '''DateTo *''' – the start date of the stay |
| − | * '''HotelKey *''' – | + | * '''HotelKey *''' – the hotel ID |
| − | * '''PansionKey''' – | + | * '''PansionKey''' – the pansion ID |
| − | * '''AccommodationKey ''' – | + | * '''AccommodationKey ''' – the accommodation ID, optional if we transmit Pax |
| − | * '''RoomTypeKey''' – | + | * '''RoomTypeKey''' – the room type ID |
| − | * '''RoomCategoryKey''' – | + | * '''RoomCategoryKey''' – ID of the room category |
| − | * '''Pax *''' – Pax | + | * '''Pax *''' – Pax by service |
| − | * '''Ages*''' – | + | * '''Ages*''' – the list with the ages of children. If we are looking for accommodation without children, we transmit an empty parameter (<meg:Ages></meg:Ages>) |
| − | * '''CancellationDate''' – | + | * '''CancellationDate''' – the cancellation date (if not specified, the current one is taken) |
| − | + | The returning result:<br /> | |
| − | * '''GetCancellationPolicyInfoWithPenaltyResult''' – | + | * '''GetCancellationPolicyInfoWithPenaltyResult''' – the output result |
| − | ** '''CancellationPolicyInfoWithPenalty''' – | + | ** '''CancellationPolicyInfoWithPenalty''' – an array of data |
| − | *** '''HotelKey''' – | + | *** '''HotelKey''' – the hotel ID |
| − | *** '''HotelName''' – | + | *** '''HotelName''' – the name of the hotel |
| − | *** '''AccomodatioKey''' – | + | *** '''AccomodatioKey''' – the accommodation ID |
| − | *** '''AccomodatioName''' – | + | *** '''AccomodatioName''' – the name of the accommodation |
| − | *** '''RoomTypeKey''' – | + | *** '''RoomTypeKey''' – the room type ID |
| − | *** '''RoomTypeName''' – | + | *** '''RoomTypeName''' – the name of the room type |
| − | *** '''RoomCategoryKey''' – | + | *** '''RoomCategoryKey''' – ID of the room category |
| − | *** '''RoomCategoryName''' – | + | *** '''RoomCategoryName''' – the name of the room category |
| − | *** '''PansionKey''' – | + | *** '''PansionKey''' – the pansion ID |
| − | *** '''PansionName''' – | + | *** '''PansionName''' – the name of the food |
| − | *** '''PolicyDescripion''' – | + | *** '''PolicyDescripion''' – the description of the cancellation policy and the full amount of the penalty |
| − | *** '''CancellationDate''' – | + | *** '''CancellationDate''' – the cancellation date |
| − | *** '''PolicyData''' – | + | *** '''PolicyData''' – the cancellation date |
| − | **** '''CancellationPolicyWithPenaltyValue''' – | + | **** '''CancellationPolicyWithPenaltyValue''' – an array of data for calculating the penalty |
| − | ***** '''PolicyKey''' – | + | ***** '''PolicyKey''' – the policy key |
| − | ***** '''DateFrom''' – | + | ***** '''DateFrom''' – the date "from" |
| − | ***** '''DateTo''' – | + | ***** '''DateTo''' – not set |
| − | ***** '''PenaltyValue''' – | + | ***** '''PenaltyValue''' – the penalty value |
| − | ***** '''IsPercent''' – | + | ***** '''IsPercent''' – the parameter indicating that the penalty is in "%" (true) or in "nights" (false) |
| − | ***** '''PenaltyTotal''' – | + | ***** '''PenaltyTotal''' – the total amount of the penalty |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method GetCancellationPolicyInfoWithPenalty | |
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
<soapenv:Header/> | <soapenv:Header/> | ||
| Строка 6436: | Строка 6436: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The returning result for the method GetCancellationPolicyInfoWithPenalty | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
| Строка 6489: | Строка 6489: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===CheckReservation ( | + | ===CheckReservation (Receiving the information about the payment required for the reservation in the selected currency)=== |
| − | + | The method returns information about the payment required for the reservation in the selected currency.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''UserToken *''' – | + | * '''UserToken *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''DgCode *''' – | + | * '''DgCode *''' – the voucher code |
| − | * '''CurrencyIsoCode *''' – ISO | + | * '''CurrencyIsoCode *''' – the ISO code of the payment currency |
| − | + | The returning result:<br /> | |
| − | * '''CheckReservationResult''' – | + | * '''CheckReservationResult''' – the output result |
| − | ** '''Amount''' – | + | ** '''Amount''' – the payment amount |
| − | ** '''RateCode''' – ISO | + | ** '''RateCode''' – the ISO code of the payment currency |
| − | ** '''NationalCurrencyPrice''' – | + | ** '''NationalCurrencyPrice''' – the payment amount in national currency |
| − | ** '''NationalRateCode''' – ISO | + | ** '''NationalRateCode''' – the ISO code of the national currency |
| − | ** '''CustomCurrencyPrice''' – | + | ** '''CustomCurrencyPrice''' – the payment amount in any currency |
| − | ** '''CustomRateCode''' – ISO | + | ** '''CustomRateCode''' – the ISO code of any payment currency |
| − | ** '''ErrorCode''' – | + | ** '''ErrorCode''' – the result code |
| − | *** '''0''' – NoError – | + | *** '''0''' – NoError – no errors |
| − | *** '''1''' – DogovorNotFound – | + | *** '''1''' – DogovorNotFound – the reservation with this code was not found |
| − | *** '''2''' – InternalError – | + | *** '''2''' – InternalError – an internal error |
| − | *** '''3''' – DogovorAnnulate – | + | *** '''3''' – DogovorAnnulate – the reservation is canceled |
| − | *** '''4''' – DogovorPayed – | + | *** '''4''' – DogovorPayed – the reservation is paid |
| − | *** '''7''' – ExistingPaymentID – | + | *** '''7''' – ExistingPaymentID – the payment with such an external ID already exists |
| − | *** '''8''' – IncorrectPaymentType – | + | *** '''8''' – IncorrectPaymentType – there are payments of prohibited types for the reservation |
| − | *** '''9''' – NotAllowedPartnerKey – | + | *** '''9''' – NotAllowedPartnerKey – the partner on the reservation is not allowed |
| − | *** '''10''' – FailureSignature – | + | *** '''10''' – FailureSignature – the signature error |
| − | *** '''11''' – NoInvoices – | + | *** '''11''' – NoInvoices – there are no invoices for the reservation |
| − | ** '''FilialKey''' – | + | ** '''FilialKey''' – the ID of the partner's branch |
| − | ** '''BeginTourDate''' – | + | ** '''BeginTourDate''' – the start date of the tour in the reservation |
| − | ** '''EndTourDate''' – | + | ** '''EndTourDate''' – the end date of the tour package |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example |
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method CheckReservation | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
| Строка 6537: | Строка 6537: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The returning result for the method CheckReservation | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
| Строка 6561: | Строка 6561: | ||
</div></div><br /> | </div></div><br /> | ||
| − | ===CreatePaymentForDogovor ( | + | ===CreatePaymentForDogovor (Creating the reservation payment based on issued invoice)=== |
| − | + | The method creates the payment for the reservation that has an invoice.<br /> | |
| − | + | Accepted request parameters ( '''*''' – required): | |
| − | * '''Guid *''' – | + | * '''Guid *''' – Id of authentification (returns in request for method [[Master-Interlook:IntegrationService (en)#Connect (Obtaining an authentication token)|Connect]])<br /> |
| − | * '''DgKey *''' – | + | * '''DgKey *''' – the reservation key |
| − | * '''Payment *''' – | + | * '''Payment *''' – the payment amount |
| − | + | The returning result:<br /> | |
| − | * '''CreatePaymentForDogovorResult''' – | + | * '''CreatePaymentForDogovorResult''' – the output result |
| − | ** '''OrderId''' – | + | ** '''OrderId''' – the payment ID |
| − | + | If there is no created invoice for the reservation, we will receive the message: "There is no invoice". | |
| − | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px"> | + | |
| + | <div class="toccolours mw-collapsible mw-collapsed" style="width:900px">Example | ||
<div class="mw-collapsible-content"> | <div class="mw-collapsible-content"> | ||
<TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | <TABLE STYLE="border: 0.1em dashed #2F6FAB; margin: 8px; padding: 8px" WIDTH="99%"><TR><TD> | ||
| − | + | The invocation of the method CreatePaymentForDogovor | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:meg="http://www.megatec.ru/"> | ||
| Строка 6588: | Строка 6589: | ||
</soapenv:Envelope> | </soapenv:Envelope> | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| − | + | The returning result for the method CreatePaymentForDogovor | |
<syntaxhighlight lang="java" enclose="div"> | <syntaxhighlight lang="java" enclose="div"> | ||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> | ||
Версия 10:44, 20 ноября 2024
Содержание
[убрать]- 1 Introduction
- 2 The Methods of IntegrationService
- 2.1 The Methods of IntegrationService
- 2.2 Methods for working with tours
- 2.2.1 CreateReservation (The booking of the tour)
- 2.2.2 GetReservation (Получение путевки по ключу)
- 2.2.3 GetArrivalsByDate (Получение списка туристов на дату начала тура)
- 2.2.4 GetDeparturesByDate (Получение списка туристов на дату окончания тура)
- 2.2.5 CancelReservation (Аннулирование путевки)
- 2.2.6 CancelReservationExtended (Аннулирование путевки с выводом информации о штрафах)
- 2.2.7 GetReservationsFrom (Отбор данных по дате создания путевки)
- 2.2.8 CreateReservationMessage (Создание сообщения для путевки)
- 2.2.9 GetReservationMessages (Получение сообщений по путевке)
- 2.3 Методы поиска
- 2.3.1 SearchHotelServices (Получение вариантов проживаний по параметрам запроса)
- 2.3.2 SearchHotelServicesMinHotel (Получение одной минимальной рассчитанной цены для отеля)
- 2.3.3 SearchActualCostCalculationVariant (Поиск возможных вариантов типов комнат, категорий комнат, размещений и питаний на которые есть актуальные цены по отелю)
- 2.4 Методы работы с ценами
- 2.5 Методы работы с услугами
- 2.5.1 GetHotels (Получение списка отелей по параметрам)
- 2.5.2 GetTransfers (Получение списка трансферов по параметрам)
- 2.5.3 GetExcursions (Получение списка экскурсий по параметрам)
- 2.5.4 GetServiceList (Получение списка дополнительных услуг)
- 2.5.5 GetExtraServices (Получение списка дополнительных услуг включая услуги типа AdHot)
- 2.5.6 GetExtraServiceWithPrices (Получение списка дополнительных услуг включая услуги типа AdHot с ценами)
- 2.5.7 CalculateSingleCost (Расчет стоимости услуги по ее параметрам стандартным механизмом расчета)
- 2.6 Methods of working with dictionaries
- 2.6.1 GetRegions (Receiving the list of the regions)
- 2.6.2 GetCities (Receiving the list of the cities)
- 2.6.3 GetCountries (Receiving the list of the countries)
- 2.6.4 GetRoomType (Receiving the list of the room types)
- 2.6.5 GetRoomCategories (Receiving the list of the room categories)
- 2.6.6 GetPansions (Receiving the list of the pansion types)
- 2.6.7 GetRatings (Receiving an array of hotel categories (hotel stars))
- 2.6.8 GetFlights (Receiving the list of the regions)
- 2.6.9 GetAirport (Receiving the list of the transfer nodes)
- 2.6.10 GetProviders (Receiving the list of the partners which are providers of services)
- 2.6.11 GetTransports (Receiving the list of the vehicles)
- 2.6.12 GetTransferTypes (Receiving the list of the transfer types)
- 2.6.13 GetRates (Receiving the list of the currencies)
- 2.6.14 GetServicePackage (Receiving the list of the options for package services)
- 2.6.15 GetDLStatuses (Receiving the list of the service statuses)
- 2.6.16 GetTariffs (Receiving the list of the tariffs for the certain type of services)
- 2.6.17 GetRoomDescriptions (Receiving an array of the descriptions of the rooms)
- 2.6.18 GetAccommodations (Receiving the accommodations for the hotel)
- 2.6.19 GetRoomAccommodations (Receiving the accommodations for the hotel an 2 first values of ages from the list of childrenages)
- 2.6.20 GetClientInfo (Issuing information about the partner to which relates the on-line user)
- 2.7 Methods of integration with payment systems
- 2.7.1 GetReservationPenalties (Receiving the penalties for the reservation before canceling it)
- 2.7.2 CreatePayment (Creating the payments for the reservation)
- 2.7.3 GetPaymentInformation (Searching for the payment information with a specified payment ID from an external system)
- 2.7.4 GetCancellationPolicyInfoWithPenalty (Receiving the information on the calculation of penalties for the hotel)
- 2.7.5 CheckReservation (Receiving the information about the payment required for the reservation in the selected currency)
- 2.7.6 CreatePaymentForDogovor (Creating the reservation payment based on issued invoice)
- 2.8 Метод работы с квотами
- 2.8.1 CheckQuota (Проверка доступности номера отеля на период)
- 2.8.2 GetQuotaInfo (Проверка доступности номера отеля на период с детализацией по дням)
- 2.8.3 GetChangeQuotaAndStop (Получение информации по квотам и стопам в отеле)
- 2.8.4 GetHotelQuotaStopInfo (Получение информации по отелям, у которых были изменения в квотах или стопах с определенной даты)
- 2.8.5 GetQuotaStop (Получение информации по установленным стопам на номера в отеле)
Introduction
The InterlookIntegrationService API uses the SOAP protocol. SoapUI also can be used to invoke API methods.
Decryption of server errors
If data sent in a request to the service is sent in an incorrect format, in the response of any method the server will return an error indicating in which line in the XML the error is.
"There is an error in the XML document (12, 49)." – in this case, the error is in line 12, in total 49 characters in the line have the error.
In the SoapUI interface, when the cursor is placed anywhere in the request, the line number and the character number in the line are displayed in the right corner of the window.
- Date error. Format: DateTime
Request: <meg:DateFrom>2021-10-010</meg:DateFrom>
Response: The server could not read the request. ---> System.InvalidOperationException: There is an error in the XML document (11, 47). ---> System.FormatException: String "2021-10-010" is not a valid AllXsd value
- Error in the data. Format: Integer
Request: <meg:PageSize>100000f</meg:PageSize>
Response: The server could not read the request. ---> System.InvalidOperationException: There is an error in the XML document (9, 37). ---> System.FormatException: The input string had an incorrect format
The Methods of IntegrationService
The Methods of IntegrationService
Connect (Obtaining an authentication token)
Method obtains the authentication token required to execute the CreateReservation method.
Accepted request parameters ( * – required):
- Login * – login of the online user
- Password * – online user's password
The Returning result:
- ConnectResult – authentication ID (if authentication was successful, we receive the ID, otherwise we receive the error "Connection result code: -1. Invalid login or password")
развернутьExample
СheckConnect (Checking the connection activity under a specific identifier)
The method checks whether there is an active connection under a specific authentication identifier.
Accepted request parameters ( * – required):
- Guid * – authentication ID (returns when requesting the Connect method)
The Returning result:
- CheckConnectResult – authentication ID (true – if the connection is active, false – if there is no connection)
развернутьExample
Methods for working with tours
CreateReservation (The booking of the tour)
The method makes a booking of the tour.
After receiving the authentication ID when requesting the Connect method, it should take some time for the cache to load. If a booking request is generated, when the cache is not loaded yet, the user receives the message "System.Exception: The Cache is loading. Try again after some time". In this case, you need to wait a few seconds and repeat the request.
Attention! Booking of mandatory Extra Services like WithCost, Hardlink occurs automatically. Regardless of whether they are transmitted in the request or not.
Rebooking of a tour occurs if the request contains the parameters ExternalId, ID is already available in the Interlook database.
Accepted request parameters ( * – required):
- Guid * – authentification ID (returns when requesting the Connect method)
- Reserv * – class – object of the tour
- HasInvoices * – is the tour invoice issued
- true – the invoce has been issued
- false – the invoce has not been issued
- Rate * – the currency of the tour
- ID – the currency ID (if we do not send or send 0 or send value, that is absent in the database, then the currency, that has ID=1 from table Rates of the Database, will be substituted)
- TouristServices * – an array of services, used by tourists
- TouristService * – a separate service, used by tourists
- TouristRoomNumber – the number of the room. If the accommodation is, for example, Double, then we specify the same room number for each tourist. For other services we leave the field empty.
- TouristID * – the ID of the tourist
- ServiceID * – the ID of the service
- Services – an array of services for a tour (of a certain type, depanding on the type of service, for example: ExcursionService, ExtraService, HotelService, TransferService)
- HotelService * – the parameters for a HotelService type of the service
- ExternalID – sending when the service changes (arrives in the response for method CreateReservation in parameter ID). When creating a reservation, we send 0 or do not send the parameter.
- NMen – number of adult tourists (if we do not send this parameter, then the calculation is carried out by NMen = 1)
- AdditionalParams –additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00). If it is not sent, it is considered current
- Duration * – duration of service
- ID * – id of service using for binding the service to the tourists
- Hotel * – array of data hotel
- AdditionalParams – o AdditionalParams – additional parameters (providing as pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- ID * – id of hotel
- AdditionalParams – o AdditionalParams – additional parameters (providing as pair key – value)
- Room * – array of data room
- RoomTypeID * – id of type of the room
- RoomCategoryID * – id of type of categories
- RoomAccomodationID * – id of the accommodation types
- PansionID * – id of the pansion types
- TransferService – parameters for type of service TransferService
- ExternalID – sending when the service changes (arrives in the response for method CreateReservation in parameter ID). When creating a reservation, we send 0 or do not send the parameter
- NMen – number of adult tourists (if we do not send this parameter, then the calculation is carried out by NMen = 1)
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00). If it is not sent, it is considered current
- Duration – duration of service. If the parameter is not sent, it is considered Duration=1
- ID * – id of service using for binding the service to the tourists
- Transfer * – array of data Transfer
- ID * – key of transfer from table TransferDirecions (returns in the request for the method GetTransfers)
- Transport * – array of data Transport
- ID * – key of transport from table Transport
- ExtraService – parameters for the service type ExtraService. If there is additional service AddHots WithCosts for the dates of stay, then it is automatically added in the response, there is no need to transmit it.
- ExternalID – sending when the service changes (arrives in the response for method CreateReservation in parameter ID). When creating a reservation, we send 0 or do not send the parameter.
- NMen – number of adult tourists (if we do not send this parameter, then the calculation is carried out by NMen = 1)
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00). If it is not sent, it is considered current
- Duration – duration of service. If the parameter is not sent, it is considered Duration=1
- ID * – id of service using for binding the service to the tourists
- Code * – code of the service (return in the request for method GetExtraService)
- ExcursionService - parameters for the service type Excursion
- ExternalID – sending when the service changes (arrives in the response for method CreateReservation in parameter ID). When creating a reservation, we send 0 or do not send the parameter.
- NMen – number of adult tourists (if we do not send this parameter, then the calculation is carried out by NMen = 1)
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00). If it is not sent, it is considered current
- Duration – duration of service. If the parameter is not sent, it is considered Duration=1
- ID * – id of service using for binding the service to the tourists
- ExcursionID * – id of excursion (returns in the request for method GetExcursions)
- CountryID – – id of country, if it is not transmitted, then receive -1 in response
- CityID – id of city
- HotelService * – the parameters for a HotelService type of the service
- TouristService * – a separate service, used by tourists
- Tourists * – array of tourists by service
- Tourist * – tourist
- Sex – genger (key = values: Male = 0, Female = 1, Child = 2, Infant = 3)
- BirthDate * – date of birth of the tourist (in format YYYY-MM-DDT00:00:00)
- FirstNameLat * – name of the tourist in Latin
- SurNameLat * – surname of the tourist in Latin
- AgeType – type of age (Adult = 0, Child = 1, Infant = 2)
- IsMain – sets the attribute of the main tourist in the tour (Null, 0 – no, 1 – main tourist)
- ID * – id of tourist using for binding the tourist to the service
- Phone – phone number of tourist (in international format, for example +70000000000, 70000000000)
- Email – e-mail address of the tourist
- ForeignPassport – foreign passport
- Serie – series
- Number – number
- EndDate – date of expire
- Tourist * – tourist
- ExternalID – key of the tour from the database Interlook (When creating a new tour, the parameter can be sent as 0 or not sent)
- • TourOperatorID – key of the tour in the external system (key of touroperator)
- TourOperatorCode – number from "customer reservation number"
- ID – key of the tour
- HasInvoices * – is the tour invoice issued
Returning result:
- HasInvoices – is the tour invoice issued
- true – is issued
- false – is not issued
- AgentDiscount – agent discount
- Rate – currency of the tour
- Name – name of the currency
- ID – id of the currency
- Description – description of the currency
- NameLat – name of the currency in Latin
- Code – code of the currency
- CodeLat – code of the currency in Latin
- Unicode – ISO-code for the currency
- IsMain – is the currency main (true – is, false – is not)
- IsNational – is the currency national (true – is, false – is not)
- TouristServices – array of services, using by tourists
- TouristService – parate service, using by tourist
- ID – id of service, using by tourist
- TouristRoomNumber – number of room
- TouristID – id of the tourist (-1 for the new tour)
- ServiceID – id of the service (-1 for the new tour)
- TouristService – parate service, using by tourist
- Services – an array of services for a tour (of a certain type, depanding on the type of service, for example: ExcursionService, ExtraService, HotelService, TransferService)
- HotelService – parameters for the service type HotelService
- ExternalID – not using
- Price – gross price
- NMen – number of adult tourists
- Partner – array of data of the partners
- Name – name of the partner
- ID – id of the partner
- Description – опиdescription of the partner
- NameLat – name of the partner in Latin
- Code – code of the partner
- CodeLat – code of the partner in Latin
- Unicode – ISO-code of the partner
- PartnersGroupID – id of the groups of partners
- FullName – full name of the partner
- Fax – fax of the partner
- Address – address of the partner
- Zip – zip-code of the partner
- Email – e-mail of the partner
- Phones – phone number of the partner
- PartnerID – id of the service provider (can be transmitted as 0 – then it will be picked up automatically by the calculator)
- Quota – service on a quota (key = value: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – id of package of the service
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- PenaltyCost - an object with the value of the penalty and the conditions under which the penalty was calculated. The display of the parameters is regulated by the license
- PolicyKey - the key of the penalty condition in the database (-1 – "fake condition", before the beginning of all conditions, or after the end of all, or there are no conditions at all)
- DateFrom - start date of the condition in format YYYY-MM-DDT00:00:00 (can be null, usually for "fake condition": "without penalty till...")
- DateTo - ate of end (can be null, for "fake condition": "100% after ...")
- PenaltyValue - the amount of the penalty
- IsPercent - percent, pointing, that the penalty is in "%" (true) or in "nights" (false)
- TotalPenalty - total amount of the penalty
- Description - description
- PenaltyCost - an object with the value of the penalty and the conditions under which the penalty was calculated. The display of the parameters is regulated by the license
- Value – value
- ParameterPair Key – key
- DetailBrutto – gross details
- Notes – notes for the service
- Name – name of the service (example for the hotel service: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB))
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00)
- StartDay – not using
- Duration – duration of the service
- RateBrutto – currency of the gross
- Brutto – price of the gross
- ServiceClassID – id of the service class
- TouristCount – number of tourists, using the service
- ID – id of the service (-1 for the new tour)
- Status – status of the service
- Name – name of the service status
- ID – id of the service status
- Description – description of the service status
- NameLat – name of the service status in Latin
- Code – code of the service status
- CodeLat – code of the service status in Latin
- Unicode – ISO-code of the service status
- Hotel – array of the data Hotel
- Name – name of the hotel
- ID – id of the hotel
- Description – description of the hotel
- NameLat – name of the hotel in Latin
- Code – code of the hotel
- CodeLat – code of the hotel in Latin
- Unicode – ISO-code of the hotel
- City – array of data City
- Name – name of the city
- ID – id of the city
- Description – description of the city
- NameLat – name of the city in Latin
- Code – code of the city
- CodeLat – code of the city in Latin
- Unicode – ISO-code of the city
- Country – array of data Country
- Name – name of the country
- ID – id of the country
- Description – description of the country
- NameLat – name of the country in Latin
- Code – code of the country
- CodeLat – code of the country in Latin
- Unicode – ISO-code of the country
- IsIncoming – parameter for inner use
- CountryID – id of the country in array data City
- RegionID – id of the region in array data City
- RegionID – id of the region
- PriceType – availability of price (PerPerson = 0, PerRoom = 1, All = 2, None = 1000)
- CountCosts – number of prices
- CityID – id of the city
- HotelCategoryID – id of the hotel category
- Room – array of data Room
- RoomType – array of data Type of the room
- Name – name of the room type
- ID – id of the room type
- Description – description of the room type
- NameLat – name of the room type in Latin
- Code – code of the room type
- CodeLat – code of the room type in Latin
- Unicode – ISO-code of the room type
- Places – number of places in room
- ExPlaces – additional places in room
- PrintOrder – additional places in room
- RoomTypeID – id of room type
- RoomCategory – array of data Room category
- Name – name of the room category
- ID – id of the room category
- Description – description of the room category
- NameLat – name of the room category in Latin
- Code – code of the room category
- CodeLat – code of the room category in Latin
- Unicode – ISO-code of the room category
- MainPlaces – number of main places
- ExtraPlaces – number of additional places
- IsMain – arameter of inner use
- RoomCategoryID – id of the room category
- RoomAccomodation – array of data Accommodation
- Name – name of the accommodation
- ID – id of the accommodation
- Description – description of the accommodation
- NameLat – name of the accommodation in Latin
- Code – code of the accommodation
- CodeLat – code of the accommodation in Latin
- Unicode – ISO-code of the accommodation
- PerRoom – per room/per person
- AdultMainPlaces – number of main places for adults
- ChildMainPlaces – number of main places for children
- AdultExtraPlaces – number of additional places for adults
- ChildExtraPlaces – number of additional places for children
- MainPlaces – total number of main places
- ExtraPlaces – total number of additional places
- IsMain – parameter of inner use
- AgeFrom – age of first child from
- AgeTo – age of first child to
- Age2From – age of second child from
- Age2To – age of second child to
- RoomAccomodationID – id of the accommodation
- ID – id of the room
- Name – name of the accommodation type
- RoomType – array of data Type of the room
- RoomID – id of the room
- PansionID – id of the pansion
- TransferService – parameters for service type TransferService
- ExternalID – not using
- Price – gross price
- NMen – number of adult tourists
- Partner – array of data of the partners
- Name – name of the partner
- ID – id of the partner
- Description – description of the partner
- NameLat – name of the partner in Latin
- Code – code of the partner
- CodeLat – code of the partner in Latin
- Unicode – ISO-code of the partner
- PartnersGroupID – id of the groups of partners
- FullName – full name of the partner
- Fax – fax of the partner
- Address – address of the partner
- Zip – zip-code of the partner
- Email – e-mail of the partner
- Phones – phone number of the partner
- PartnerID – id of the service provider (can be transmitted as 0 – then it will be picked up automatically by the calculator)
- Quota – service on a quota (key = value: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – id of package of the service
- AdditionalParams – additional parameters (represents as a pair key - value)
- ParameterPair Key – key
- Value – value
- Description - description
- Value – value
- ParameterPair Key – key
- DetailBrutto – gross details
- Notes – notes for the service
- Name – name of the service (example for the hotel service: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – date of providing service (in format YYYY-MM-DDT00:00:00)
- StartDay – not using
- Duration – duration of the service
- RateBrutto – currency of the gross
- Brutto – price of the gross
- ServiceClassID – id of the service class
- TouristCount – number of tourists, using the service
- ID – id of the service (-1 for the new tour)
- Status – status of the service
- Name – name of the service status
- ID – id of the service status
- Description – description of the service status
- NameLat – name of the service status in Latin
- Code – code of the service status
- CodeLat – code of the service status in Latin
- Unicode – ISO-code of the service status
- Transfer – array of data Transfer
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- ParameterPair Key – key
- Name – name of the transfer
- ID – key of the transfer from table TransferDirecion
- Description – description of the transfer
- NameLat – name of the transfer in Latin
- Code – code of the transfer
- CodeLat – code of the transfer in Latin
- Unicode – ISO-code of the transfer
- PlaceFrom – name of the point from
- PlaceTo – name of the point to
- CityID – id of the city
- RegionID – id of the region
- AdditionalParams – additional parameters (represents as a pair key – value)
- Transport – array of data Transport
- Name – name of the transport
- ID – id of the transport
- Description – description of the transport
- NameLat – name of the transport in Latin
- Code – code of the transport
- CodeLat – code of the transport in Latin
- Unicode – ISO-code of the transport
- PointToID – id of the point to
- CityKey – key of the city
- PointToName – name of the point to
- PointFromID – name of the point to
- PointFromName – name of the point from
- ExcursionService – parameters for the service type ExcursionService
- ExternalID – неnot using
- Price – gross price
- NMen – number of adult tourists
- Partner – array of data of the partners
- Name – name of the partner
- ID – id of the partner
- Description – description of the partner
- NameLat – name of the partner in Latin
- Code – code of the partner
- CodeLat – code of the partner in Latin
- Unicode – ISO-code of the partner
- PartnersGroupID – id of the groups of partners
- FullName – full name of the partner
- Fax – fax of the partner
- Address – address of the partner
- Zip – zip-code of the partner
- Email – e-mail of the partner
- Phones – phone number of the partner
- PartnerID – id of the service provider (can be transmitted as 0 – then it will be picked up automatically by the calculator)
- Quota – service on a quota (key = value: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – id of package of the service
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- DetailBrutto – gross details
- Notes – notes to the service
- Name – name of the service (example for hotel service: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – date of providing service (In format YYYY-MM-DDT:00:00)
- StartDay – not using
- Duration – duration of service
- RateBrutto – the currency of the gross
- Brutto – gross price
- ServiceClassID – id of the service class
- TouristCount – number of tourists, using the service
- ID – id of the service (-1 for the new tour)
- Status – status of the service
- Name – name of the service status
- ID – id of the service status
- Description – description of the service status
- NameLat – name of the service status in Latin
- Code – code of the service status
- CodeLat – code of the service status in Latin
- Unicode – ISO-code of the service status
- CityKey – city key
- ExcursionID – id of excursion
- ExtraService – parameters for the service type ExtraService
- ExternalID – not using
- Price – gross price
- NMen – number of adult tourists
- Partner – array of data of the partners
- Name – name of the partner
- ID – id of the partner
- Description – description of the partner
- NameLat – name of the partner in Latin
- Code – code of the partner
- CodeLat – code of the partner in Latin
- Unicode – ISO-code of the partner
- PartnersGroupID – id of the groups of partners
- FullName – full name of the partner
- Fax – fax of the partner
- Address – fax of the partner
- Zip – zip-code of the partner
- Email – e-mail of the partner
- Phones – phone number of the partner
- PartnerID – id of the service provider (can be transmitted as 0 – then it will be picked up automatically by the calculator)
- Quota – service on a quota (key = value: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – id of package of the service
- AdditionalParams – additional parameters (represents as a pair key – value)
- ParameterPair Key – key
- Value – value
- DetailBrutto – gross details
- Notes – notes to the service
- Name – name of the service (example for hotel service: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – date of providing service (In format YYYY-MM-DDT:00:00)
- StartDay – not using
- Duration – duration of service
- RateBrutto – the currency of the gross
- Brutto – gross price
- ServiceClassID – id of the service class
- TouristCount – number of tourists, using the service
- ID – id of the service (-1 for the new tour)
- Status – status of the service
- Name – name of the service status
- ID – id of the service status
- Description – description of the service status
- NameLat – name of the service status in Latin
- Code – code of the service status
- CodeLat – code of the service status in Latin
- Unicode – ISO-code of the service status
- CityKey – key of the city providing the service
- IsPackage – attribute if the service is in package
- Code – id of the service
- HasDuration – has service duration or not
- HotelService – parameters for the service type HotelService
- ID – key of the tour in external system (key of tour operator)
- Name – name of the tour
- Brutto – gross price of the tour
- CountryID – id of the country of the tour
- CityID – id of the city of the tour
- PartnerID – id of buyer of the tour
- AgentDiscount – agent discount
- Status – status of the tour (Confirmed = 0, NotConfirmed = 1, WaitingConfirmation = 2, Canceled = 3, WaitingCancelation = 4)
- StartDate – date of the beginning of the tour (in format YYYY-MM-DDT00:00:00)
- EndDate – date of the end of the tour (in format YYYY-MM-DDT00:00:00)
- Duration – duration
- CreationDate – date of the creation of the tour (in format YYYY-MM-DDT00:00:00)
- CreatorID – id of creator of the tour
- Tourists – array of the tourists on the tour
- Tourist – tourist
- Sex – gender (key = value: Male = 0, Female = 1, Child = 2, Infant = 3)
- BirthDate – date of birth of the touris (in format YYYY-MM-DDT00:00:00)*** FirstNameLat – name of the tourist in Latin
- LastNameLat – surname of the tourist in Latin
- AgeType – type of the age (Adult = 0, Child = 1, Infant = 2)
- IsMain – sets attribute main tourist on the tour (Null, 0 – no, 1 – tourist is main)
- ExternalID – parameter for the internal use
- ID – id of the tourist (-1 for the new tour)
- Phone – phone number of the tourist (sets according to the template)
- Email – e-mail address of the tourist
- ForeignPassport – foreign passport
- Serie – series
- Number – number
- EndDate – date of expire
- ExternalID – not using
- Tourist – tourist
- OwnerID – id of the creator of the tour
- ExternalID – key of the tour in the database Interlook
- TourOperatorID – key of the tour in external system (key of the tour operator)
- TourOperatorCode – number from "customer reservation number"
- AdditionalParams – additional parameters (providing as the pair key – value)
- ParameterPair Key – key
- Value – value
In case of errors in the request, we receive a message in the response with a transcript of the errors.
In case of an error in the GUID we will receive the message "Invalid user or password (Invalid GUID)."
If the service signature does not match the type declared in the request, we will receive the message "Service labeled as '<Type of service in the request>' is not a <Service type name>".
If there are no tourists in the request, we will receive the message "There is no any tourist. At least one 'Tourist' must be specified."
If the required field is not specified, we will receive the message "Parameter '<Parameter name>' is required."
If there is no record with the specified ID in the database, we will receive the message "There is no <Entity name> with '<Identifier parameter name>' = <Parameter value in the request> in the database."
развернутьExample
GetReservation (Получение путевки по ключу)
Метод производит получение информации по путевке по ключу путевки.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DgKey * – ключ путевки
Возвращаемый результат:
- HasInvoices – выставлен ли счет по путевке
- true – счет выставлен
- false – счет не выставлен
- AgentDiscount – скидка агента
- Rate – валюта путевки
- Name – название валюты
- ID – идентификатор валюты
- Description – описание валюты
- NameLat – наименование валюты латиницей
- Code – код валюты
- CodeLat – код валюты латиницей
- Unicode – код ISO для валюты
- IsMain – является ли валюта главной (true – является, false – не является)
- IsNational – является ли валюта национальной (true – является, false – не является)
- TouristServices – массив услуг, используемых туристами
- TouristService – отдельная услуга, используемая туристом
- ID – идентификатор услуги, используемой туристом
- TouristRoomNumber – номер комнаты
- TouristID – идентификатор туриста (-1 для новой путевки)
- ServiceID – идентификатор услуги (-1 для новой путевки)
- TouristService – отдельная услуга, используемая туристом
- Services – массив услуг по путевке (определенного типа, в зависимости от типа услуги, например: ExcursionService, ExtraService, HotelService, TransferService)
- HotelService – параметры для услуги типа HotelService
- ExternalID – не используется
- Price – цена брутто
- NMen – количество взрослых туристов
- Partner – массив данных партнера
- Name – наименование партнера
- ID – идентификатор партнера
- Description – описание партнера
- NameLat – наименование партнера латиницей
- Code – код партнера
- CodeLat – код партнера латиницей
- Unicode – код ISO партнера
- PartnersGroupID – идентификатор группы партнера
- FullName – полное наименование партнера
- Fax – факс партнера
- Address – адрес партнера
- Zip – почтовый код партнера
- Email – email партнера
- Phones – телефон партнера
- PartnerID – идентификатор поставщика услуги (можно передать 0 – тогда он подберется автоматически расчетчиком)
- Quota – услуга на квоте (ключ = значение: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – идентификатор пакета услуги
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- PenaltyCost - объект со значением штрафа и условиями, по которым штраф был рассчитан. Отображение параметров регулируется лицензией.
- PolicyKey - ключ условия по штрафу в БД (-1 - "псевдоусловие", до начала всех условий, или после окончания всех, или вообще никаких условий нет)
- DateFrom - дата начала действия условия в формате ГГГГ-ММ-ДДT00:00:00 (может быть null, обычно для "псевдоусловия": "без штрафа до...")
- DateTo - дата окончания (может быть null, для "псевдоусловия" : "100% после ...")
- PenaltyValue - размер штрафа
- IsPercent - процент, указывающий, что штраф в "%" (true) или в "ночах" (false)
- TotalPenalty - полная сумма штрафа
- Description - описание
- PenaltyCost - объект со значением штрафа и условиями, по которым штраф был рассчитан. Отображение параметров регулируется лицензией.
- Value – значение
- ParameterPair Key – ключ
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги (пример для услуги отель: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – не используется
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- Hotel – массив данных отель
- Name – наименование отеля
- ID – идентификатор отеля
- Description – описание отеля
- NameLat – наименование отеля латиницей
- Code – код отеля
- CodeLat – код отеля латиницей
- Unicode – код ISO отеля
- City – массив данных город
- Name – наименование города
- ID – идентификатор города
- Description – описание города
- NameLat – наименование города латиницей
- Code – код города
- CodeLat – код города латиницей
- Unicode – код ISO города
- Country – массив данных страна
- Name – наименование страны
- ID – идентификатор страны
- Description – описание страны
- NameLat – наименование страны латиницей
- Code – код страны
- CodeLat – код страны латиницей
- Unicode – код ISO страны
- IsIncoming – параметр для внутреннего использования
- CountryID – идентификатор страны в массиве данных город
- RegionID – идентификатор региона в массиве данных город
- RegionID – идентификатор региона
- PriceType – наличие цен (PerPerson = 0, PerRoom = 1, All = 2, None= 1000)
- CountCosts – количество цен
- CityID – идентификатор города
- HotelCategoryID – идентификатор категории отеля
- Room – массив данных комната
- RoomType – массив данных тип комнаты
- Name – наименование типа комнаты
- ID – идентификатор типа комнаты
- Description – описание типа комнаты
- NameLat – наименование типа комнаты латиницей
- Code – код типа комнаты
- CodeLat – код типа комнаты латиницей
- Unicode – код ISO типа комнаты
- Places – количество мест в номере
- ExPlaces – дополнительные места в номере
- PrintOrder – порядковый номер для печати в отчетах
- RoomTypeID – идентификатор типа комнаты
- RoomCategory – массив данных категории номера
- Name – наименование категории номера
- ID – идентификатор категории номера
- Description – описание категории номера
- NameLat – наименование категории номера латиницей
- Code – код категории номера
- CodeLat – код категории номера латиницей
- Unicode – код ISO категории номера
- MainPlaces – количество основных мест
- ExtraPlaces – количество дополнительных мест
- IsMain – параметр для внутреннего использования
- RoomCategoryID – идентификатор категории комнат
- RoomAccomodation – массив данных размещения
- Name – наименование размещения
- ID – идентификатор размещения
- Description – описание размещения
- NameLat – наименование размещения латиницей
- Code – код размещения
- CodeLat – код размещения латиницей
- Unicode – код ISO размещения
- PerRoom – за комнату/за человека
- AdultMainPlaces – количество основных мест для взрослых
- ChildMainPlaces – количество основных мест для детей
- AdultExtraPlaces – количество дополнительных мест для взрослых
- ChildExtraPlaces – количество дополнительных мест для детей
- MainPlaces – общее количество основных мест
- ExtraPlaces – общее количество дополнительных мест
- IsMain – параметр для внутреннего использования
- AgeFrom – возраст первого ребенка от
- AgeTo – возраст первого ребенка по
- Age2From – возраст второго ребенка от
- Age2To – возраст второго ребенка по
- RoomAccomodationID – идентификатор типа размещения
- ID – идентификатор комнаты
- Name – наименование типа размещения
- RoomType – массив данных тип комнаты
- RoomID – идентификатор комнаты
- PansionID – идентификатор типа питания
- TransferService – параметры для услуги типа TransferService
- ExternalID – не используется
- Price – цена брутто
- NMen – количество взрослых туристов
- Partner – массив данных партнера
- Name – наименование партнера
- ID – идентификатор партнера
- Description – описание партнера
- NameLat – наименование партнера латиницей
- Code – код партнера
- CodeLat – код партнера латиницей
- Unicode – код ISO партнера
- PartnersGroupID – идентификатор группы партнера
- FullName – полное наименование партнера
- Fax – факс партнера
- Address – адрес партнера
- Zip – почтовый код партнера
- Email – email партнера
- Phones – телефон партнера
- PartnerID – идентификатор поставщика услуги (можно передать 0 – тогда он подберется автоматически расчетчиком)
- Quota – услуга на квоте (ключ = значение: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – идентификатор пакета услуги
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- Description - описание
- Value – значение
- ParameterPair Key – ключ
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги (пример для услуги отель: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – не используется
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- Transfer – массив данных трансфера
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- ParameterPair Key – ключ
- Name – наименование трансфера
- ID – ключ трансфера из таблицы TransferDirecion
- Description – описание трансфера
- NameLat – наименование трансфера латиницей
- Code – код трансфера
- CodeLat – код трансфера латиницей
- Unicode – код ISO трансфера
- PlaceFrom – название точки откуда
- PlaceTo – название точки куда
- CityID – идентификатор города
- RegionID – идентификатор региона
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- Transport – массив данных транспорта
- Name – наименование транспорта
- ID – идентификатор транспорта
- Description – описание транспорта
- NameLat – наименование транспорта латиницей
- Code – код транспорта
- CodeLat – код транспорта латиницей
- Unicode – код ISO транспорта
- PointToID – идентификатор точки куда
- CityKey – ключ города
- PointToName – название точки куда
- PointFromID – идентификатор точки откуда
- PointFromName – название точки откуда
- ExcursionService – параметры для услуги типа ExcursionService
- ExternalID – не используется
- Price – цена брутто
- NMen – количество взрослых туристов
- Partner – массив данных партнера
- Name – наименование партнера
- ID – идентификатор партнера
- Description – описание партнера
- NameLat – наименование партнера латиницей
- Code – код партнера
- CodeLat – код партнера латиницей
- Unicode – код ISO партнера
- PartnersGroupID – идентификатор группы партнера
- FullName – полное наименование партнера
- Fax – факс партнера
- Address – адрес партнера
- Zip – почтовый код партнера
- Email – email партнера
- Phones – телефон партнера
- PartnerID – идентификатор поставщика услуги (можно передать 0 – тогда он подберется автоматически расчетчиком)
- Quota – услуга на квоте (ключ = значение: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – идентификатор пакета услуги
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги (пример для услуги отель: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – не используется
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- CityKey – ключ города
- ExcursionID – идентификатор экскурсии
- ExtraService – параметры для услуги типа ExtraService
- ExternalID – не используется
- Price – цена брутто
- NMen – количество взрослых туристов
- Partner – массив данных партнера
- Name – наименование партнера
- ID – идентификатор партнера
- Description – описание партнера
- NameLat – наименование партнера латиницей
- Code – код партнера
- CodeLat – код партнера латиницей
- Unicode – код ISO партнера
- PartnersGroupID – идентификатор группы партнера
- FullName – полное наименование партнера
- Fax – факс партнера
- Address – адрес партнера
- Zip – почтовый код партнера
- Email – email партнера
- Phones – телефон партнера
- PartnerID – идентификатор поставщика услуги (можно передать 0 – тогда он подберется автоматически расчетчиком)
- Quota – услуга на квоте (ключ = значение: None = 0, Yes = 1, No = 2, AFew = 3, Request = 4, NoFlight = 5, OnlyAgent = 6, All = 7, NotChecked = 10)
- PacketKey – идентификатор пакета услуги
- AdditionalParams – массив дополнительных параметров (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- ParameterPair Key – ключ
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги (пример для услуги отель: HTL::Delphi/Acropol Hotel/Double Room/2AD/100 m2/BB)
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – не используется
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- CityKey – ключ города предоставления услуги
- IsPackage – признак пакетной услуги
- Code – идентификатор услуги
- HasDuration – услуга с продолжительностью или без
- HotelService – параметры для услуги типа HotelService
- ID – ключ путевки во внешней системе (ключ туроператора)
- Name – наименование путевки
- Brutto – брутто цена путевки
- CountryID – идентификатор страны путевки
- CityID – идентификатор города путевки
- PartnerID – идентификатор покупателя путевки
- AgentDiscount – скидка агента
- Status – статус путевки (Confirmed = 0, NotConfirmed = 1, WaitingConfirmation = 2, Canceled = 3, WaitingCancelation = 4)
- StartDate – дата начала тура (в формате ГГГГ-ММ-ДДT00:00:00)
- EndDate – дата окончания тура (в формате ГГГГ-ММ-ДДT00:00:00)
- Duration – продолжительность
- CreationDate – дата создания путевки (в формате ГГГГ-ММ-ДДT00:00:00)
- CreatorID – идентификатор создателя путевки
- Tourists – массив туристов по услуге
- Tourist – турист
- Name – имя
- Sex – пол (ключ = значения: Male = 0, Female = 1, Child = 2, Infant = 3)
- FirstName – имя туриста
- LastName – фамилия туриста
- SurName – отчество туриста
- BirthDate – дата рождения туриста (в формате ГГГГ-ММ-ДДT00:00:00)
- FirstNameLat – имя туриста латиницей
- LastNameLat – фамилия туриста латиницей
- SurNameLat – отчество туриста латиницей
- AgeType – тип возраста (Adult = 0, Child = 1, Infant = 2)
- Citizen –не используется
- IsMain – устанавливает признак главного туриста по путевке (Null, 0 – нет, 1 – турист главный)
- ExternalID – параметр для внутреннего использования
- ID – идентификатор туриста (-1 для новой путевки )
- Phone – телефон туриста (задается по шаблону)
- Email – адрес электронной почты туриста
- ForeignPassport – иностранный паспорт
- IssuedBy – кем выдан
- Serie – серия
- Number – номер
- IssueDate – дата выдачи
- EndDate – дата окончания действия
- ExternalID – не используется
- Tourist – турист
- OwnerID – идентификатор создателя путевки
- ExternalID – ключ путевки в базе данных Interlook
- TourOperatorID – ключ путевки во внешней системе (ключ туроператора)
- TourOperatorCode – номер из "customer reservation number"
- AdditionalParams – дополнительные параметры (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
развернутьПример
GetArrivalsByDate (Получение списка туристов на дату начала тура)
Метод возвращает данные по списку прилетов в формате json. Метод возвращает данные по главному туристу из путевки. В случае если у главного туриста не задан номер телефона, вернутся данные следующего туриста по путевке, у которого задан номер телефона.
Если у главного туриста аннулирована услуга проживания в отеле, то вернутся данные следующего туриста у которого задан номер телефона.
За доступность метода для пользователя отвечает настройка ShowhotelReservationsByDate. По умолчанию настройка отключена.
Для включения настройки необходимо из клиентского приложения Master-Interlook перейти в Master-Interlook → Settings → Online users → User → Person connection → edit role.
Если у пользователя не включена настройка ShowhotelReservationsByDat - доступа к этому методу нет, в ответ будет возвращаться сообщение о недостаточности прав. Проверка проводится по идентификатору аутентификации Guid.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- ArrivalDate * – дата заезда
- CountryKey – ключ страны
- RegionKey – ключ региона
- CityKey – ключ города
- HotelKey – ключ отеля
Возвращаемый результат:
- GetArrivalsByDateResult – результат поиска
- ReservationId – номер путевки в клиенте Interlook
- Email – электронный адрес если есть
- Name – имя фамилия туриста
- Phone – номер телефона (выводится в формате только цифр, обрабатывается при формирование ответа)
- CheckIn – дата заезда
- CheckOut – дата выезда
- HotelId – ключ отеля
- HasTransferArrival – трансфер в отель (true – есть трансфер в отель, если трансфера в заявке нет выводится false)
- FlightArrival – номер прямого рейса
- FlightDeparture – номер обратного рейса
- FlightArrivalTime – время вылета прямого перелета
- FlightDepartureTime – время вылета обратного перелета
развернутьПример
GetDeparturesByDate (Получение списка туристов на дату окончания тура)
Метод возвращает данные по списку вылетов в формате json. Метод возвращает данные по главному туристу из путевки. В случае если у главного туриста не задан номер телефона, вернутся данные следующего туриста по путевке, у которого задан номер телефона.
Если у главного туриста аннулирована услуга проживания в отеле, то вернутся данные следующего туриста у которого задан номер телефона.
За доступность метода для пользователя отвечает настройка ShowhotelReservationsByDate. По умолчанию настройка отключена.
Для включения настройки необходимо из клиентского приложения Master-Interlook перейти в Master-Interlook → Settings → Online users → User → Person connection → edit role.
Если у пользователя не включена настройка ShowhotelReservationsByDat - доступа к этому методу нет, в ответ будет возвращаться сообщение о недостаточности прав. Проверка проводится по идентификатору аутентификации Guid.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DepartureDate * – дата выезда
- CountryKey – ключ страны
- RegionKey – ключ региона
- CityKey – ключ города
- HotelKey – ключ отеля
Возвращаемый результат:
- GetDeparturesByDateResult – результат поиска
- ReservationId – номер путевки в ИЛ(выводим номер путевки который видим в интерук клиенте)
- Email – электронный адрес если есть
- Name – имя фамилия туриста
- Phone – номер телефона (выводится в формате только цифры, не смотря на то как это в интерлке, обрабатывается при формирование ответа)
- CheckIn – дата заезда
- checkOut – дата выезда
- HotelId – ключ отеля
- HasTransferArrival – трансфер в отель (true – есть трансфер в отель, если трансфера в заявке нет выводится false)
- HasTransferDeparture – трансфер из отеля (true – есть трансфер из отеля, если трансфера в заявке нет выводится false)
- FlightArrival – номер прямого рейса
- FlightDeparture – номер обратного рейса
- FlightArrivalTime – время вылета прямого перелета
- FlightDepartureTime – время вылета обратного перелета
развернутьПример
CancelReservation (Аннулирование путевки)
Метод производит аннуляцию путевки.
Выдача результатов метода регулируется лицензией.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DgKey * – ключ путевки (не номер путевки)
- AnnulReasonID * – ключ причины аннуляции (1001 – Cancel of the touroperator, 1009 – sdf. Если такой ключ причины аннуляции отсутствует в базе данных, то получим сообщение There is no this annulating reason in database)
- Note – комментарий к аннуляции
Возвращаемые значения.
- CancelReservationResult – результат аннуляции.
В случае успешного аннулирования в ответе получаем полную характеристику удаленной путевки с датой отмены.
В случае ошибки получаем в ответ расшифровку ошибки.
В случае некорректности идентификатора аутентификации ошибка примет вид: "Invalid user or password (Invalid GUID)".
Если отсутствует один из обязательных параметров или значение некорректно " Check the parameter 'dgKey' = 0. There is no any reservation for you in the database".
развернутьПример
CancelReservationExtended (Аннулирование путевки с выводом информации о штрафах)
Метод производит аннуляцию путевки и выдает информацию о штрафе.
Выдача результатов метода регулируется лицензией.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DgKey * – ключ путевки
- AnnulReasonID * – ключ причины аннуляции (1001 – Cancel of the touroperator, 1009 – sdf. Если такой ключ причины аннуляции отсутствует в базе данных, то получим сообщение There is no this annulating reason in database)
- Note – комментарий к аннуляции
Возвращаемые значения.
- Number – номер сервиса
- ResultMessage – результат аннуляции с полным описанием. В случае успешного аннулирования в ответе получаем полную характеристику удаленной путевки с датой отмены. В случае ошибки получаем в ответ расшифровку ошибки.
- PenaltyCost - объект со значением штрафа и условиями, по которым штраф был рассчитан
- PolicyKey - ключ условия по штрафу в БД (-1 - "псевдоусловие", до начала всех условий, или после окончания всех, или вообще никаких условий нет)
- DateFrom - дата начала действия условия в формате ГГГГ-ММ-ДДT00:00:00 (может быть null, обычно для "псевдоусловия": "без штрафа до...")
- DateTo - дата окончания (может быть null, для "псевдоусловия" : "100% после ...")
- PenaltyValue - размер штрафа
- IsPercent - процент, указывающий, что штраф в "%" (true) или в "ночах" (false)
- TotalPenalty - полная сумма штрафа
- Description - описание
- PenaltyCost - объект со значением штрафа и условиями, по которым штраф был рассчитан
развернутьПример
GetReservationsFrom (Отбор данных по дате создания путевки)
Метод производит вывод данных по дате создания путевки.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DateFrom * – дата от
- DateTo – дата до
Возвращаемый результат:
- Key – ключ путевки
- Code – номер путевки
В случае ошибок в запросе в ответе получаем сообщение с расшифровкой ошибок.
В случае ошибки в GUID получим сообщение "Invalid user or password (Invalid GUID)."
В случае если дата начала больше даты окончания получим сообщение "Parameter 'DateTo' can't be less than 'DateFrom'."
В случае отсутствия одного из обязательных параметров получим сообщение "Parameter '<значение параметра>' is required."
развернутьПример
CreateReservationMessage (Создание сообщения для путевки)
Метод создает сообщение для конкретной путевки.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DgKey * – ключ путевки
- Message * – текст сообщения
- SenderName * – имя отправителя сообщения
Возвращаемый результат: не возвращает результата
развернутьПример
GetReservationMessages (Получение сообщений по путевке)
Метод производит получение сообщений для конкретной путевки.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DgKey * – ключ путевки
- MessageDirection * – директория расположения сообщений (по умолчанию 1)
Возвращаемый результат:
- DogovorMessageItem – результат поиска
- Id – идентификатор сообщения
- IsOutgouing – исходящее (true - исходящее, false - входящее )
- DogovorId – номер путевки
- DateCreate – дата создания сообщения
- SenderName – имя отправителя
- IsRead – прочитано (true - прочитано, false - не прочитано )
- TourOperKey – ключ туроператора
- Processed – статус обработки
- Text – текст сообщения
В случае ошибки приходит расшифровка ошибки.
При ошибке в Guid получим сообщение: "Invalid user or password (Invalid GUID)".
При ошибке в ключе путевки получим сообщение: "Check the parameter 'dgKey' = <значение в запросе>. There is no any reservation for you in the database".
В случае отсутствия в выбранной директории сообщений получим ответ: "Ok. There is no any message with 'messageDirection' = <значение в запросе>".
развернутьПример
Методы поиска
SearchHotelServices (Получение вариантов проживаний по параметрам запроса)
Метод производит получение возможных вариантов проживаний по параметрам запроса.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- PageSize * – размер страницы возвращаемых данных, то есть на каком количестве рассчитанных цен останавливаться и выдавать результат поиска. Если задано PageSize = 5, то поиск пойдет по ценам и как только наберет 5 рассчитанных (но перебрать цен он может больше, не все цены подходят) цен, выдаст их в результат. Количество перебранных внутренних цен будет выдано в строке TotalCount.
- RowIndexFrom * – с какой строчки выдавать результат. Для первой страницы указываем RowIndexFrom = 0 – перебор идет с самой первой цены. Чтобы получить вторую страницу или последующие страницы поиска в RowIndexFrom надо передавать внутренний номер цены на котором остановился поиск предыдущей страницы цен (этот номер будет в ответе в строке TotalCount)
- DateFrom * – дата «С»
- DateTo * – дата «По»
- RegionKeys – идентификаторы регионов (если не заданы города и отели – поиск по всем регионам, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- CityKeys – идентификаторы городов (если не заданы отели – ищем поиск для всех отелей городов, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- HotelKeys – идентификаторы отелей (если заданы отели – поиск только для них, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- RoomDescriptions – идентификаторы описаний комнат. Если не предавать будет искать для всех
- PansionKeys – идентификаторы питаний. Если не передавать будет искать для всех
- Ages – возраст детей (если не указан, то размещения с детьми не ищутся, туристы считаются взрослыми)
- Pax * – размещение
- Tariffs – идентификаторы тарифов по которым рассчитывать результат. Если не передавать будет считать по тарифу Ordinary
- CacheGuid – идентификатор поиска, который ускоряет переход по страницам. При первом поиске его передавать не нужно. Поиск вернет этот идентификатор в параметре ResponseGuid. Далее, используя пейджинг, передаем этот идентификатор дальше (но только в рамках одного поиска!)
- ResultView – тип вывода результата (1 – cортировка по суточной цене с группировкой по отелям, 2 – сортировка по суточной цене)
- QuotaTypes – фильтр по типу квоты(0 – запрос, 1 – квота, 2 – стоп). Получаем все возможные результаты. Если не указано, то значение=0
- Mode – не указываем или указываем 0
Возвращаемый результат:
- DataRequestResult – результат поиска
- ResultTable – таблица с результатом
- HotelServices – услуга отеля
- HotelName – наименование отеля
- HotelKey – ключ отеля
- RtCode – тип номера
- RtKey – ключ типа номера
- RcName – категория номера
- RcKey – ключ категории номера
- RdName – тип+категория номера
- RdKey – ключ тип+категория номера
- AcName – тип размещения
- AcKey – ключ типа размещения
- PnCode – тип питания
- PnKey – ключ типа питания
- TotalCost – конечная стоимость проживания в отеле включая обязательные доплаты Cost + AdHotCost. Сортировка по минимальной цене производиться по параметру TotalCost от наименьшей цены к наибольшей
- Cost – размер обязательной доплаты Cost
- AddHotsCost – размер обязательной доплаты AdHot
- AddHotsWithCosts – размер обязательной доплаты AdHot типа With costs (выдает -1 если настройка отображения Adhot типа With Costs в конфиге Integration Service Interlook. Описание настройки Master-Interlook:Обмен. Настройка Web-сервиса Master-Interlook#Настройка параметров конфига web.config Integration Service )
- DetailBrutto – формула расчета цены
- QuoteType – тип квоты. Может принимать 3 значения: 0 – на запрос,1 – в квоте, 2 – стоит стоп сейл.
- CountryKey – ключ страны предоставления услуги
- CityKey – ключ города предоставления услуги
- CityName – наименование города предоставления услуги
- HotelWebSite – адрес сайта отеля
- TariffId – идентификатор тарифа
- TariffName – наименование тарифа
- TariffDescription – описание тарифа
- AddHots – идентификатор Adhot
- ContractPrKey – ключ партнера, предоставляющего услугу
- HotelImage – фото отеля
- Rate – валюта
- AddHotsWithCostID – идентификатор AddHotsWithCost
- HotelServices – услуга отеля
- ColunmNames – название столбцов таблицы
- HotelName – наименование отеля
- HotelKey – ключ отеля
- RtCode – тип номера
- RtKey – ключ типа номера
- RcName – категория номера
- RcKey – ключ категории номера
- RdName – тип+категория номера
- RdKey – ключ тип+категория номера
- AcName – тип размещения
- AcKey – ключ типа размещения
- PnCode – тип питания
- PnKey – ключ типа питания
- TotalCost – конечная стоимость проживания в отеле включая обязательные доплаты Cost + AdHotCost. Сортировка по минимальной цене производиться по параметру TotalCost от наименьшей цены к наибольшей
- Cost – размер обязательной доплаты Cost
- AddHotsCost – размер обязательной доплаты AddHotsCost
- DetailBrutto – формула расчета цены
- QuoteType – тип квоты. Может принимать 3 значения: 0 – на запрос,1 – в квоте, 2 – стоит стоп сейл.
- CountryKey – ключ страны предоставления услуги
- CityKey – ключ города предоставления услуги
- CityName – наименование города предоставления услуги
- HotelWebSite – адрес сайта отеля
- TariffId – идентификатор тарифа
- TariffName – наименование тарифа
- TariffDescription – описание тарифа
- AddHots – идентификатор Adhot
- ContractPrKey – ключ партнера, предоставляющего услугу
- HotelImage – фото отеля
- Rate – валюта
- AddHotsWithCostID – идентификатор AddHotsWithCost
- TotalCount – номер строки, на которой закончился поиск
- PageSize – количество возвращаемых строк данных
- PageIndex – номер строки, с которой начали поиск
- IsLastPage – при отображении последней страницы результатов поиска с отелями параметр IsLastPage принимает значение true. Если не обрабатывать параметр IsLastPage, то следующее значение TotalCount вернет пустой результат по отелям
- AdditionalData – список обязательных Addhots
- ArrayOfAnyType – массив типов услуг
- anyType – тип услуги
- ExternalID – параметр для внутреннего использования
- Price – стоимость
- NMen – количество туристов по путевке
- PartnerID – идентификатор партнера
- Quota – квота по услуге
- PacketKey – ключ пакета
- AdditionalParams – массив дополнительных параметры (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- ParameterPair Key – ключ
- Tourists – туристы
- DetailNetto – подробности нетто
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – день предоставления услуги
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- RateNetto – валюта нетто
- Netto – цена нетто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- CityKey – ключ города предоставления услуги
- IsPackage – признак пакетной услуги
- Code – идентификатор услуги
- HasDuration – услуга с продолжительностью или без
- anyType – тип услуги
- ArrayOfAnyType – массив типов услуг
- ResponseGuid – идентификатор ответа, который необходимо передать, если мы двигаемся по тому же поиску используя пейджинг
- ResultTable – таблица с результатом
В случае ошибок в запросе в ответе получаем сообщение с расшифровкой ошибок.
В случае ошибки в GUID получим сообщение "Invalid user or password (Invalid GUID)."
В случае если дата начала больше даты окончания получим сообщение "Parameter 'DateTo' can't be less than 'DateFrom'."
В случае отсутствия одного из обязательных параметров получим сообщение "Parameter '<значение параметра>' is required."
В случае отсутствия ключа отеля, ключа города, ключа региона получим сообщение "At least one of the following parameters must be specified: 'RegionKeys', 'CityKeys' or 'HotelKeys'."
развернутьПример
SearchHotelServicesMinHotel (Получение одной минимальной рассчитанной цены для отеля)
Метод выводит одну минимальную (сортировка по суточной цене) рассчитанную цену для отеля.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- PageSize * – размер страницы возвращаемых данных, то есть на каком количестве рассчитанных цен останавливаться и выдавать результат поиска. Если задано PageSize = 5, то поиск пойдет по ценам и как только наберет 5 рассчитанных (но перебрать цен он может больше, не все цены подходят) цен, выдаст их в результат. Количество перебранных внутренних цен будет выдано в строке TotalCount.
- RowIndexFrom * – с какой строчки выдавать результат. Для первой страницы указываем RowIndexFrom = 0 – перебор идет с самой первой цены. Чтобы получить вторую страницу или последующие страницы поиска в RowIndexFrom надо передавать внутренний номер цены на котором остановился поиск предыдущей страницы цен (этот номер будет в ответе в строке TotalCount)
- DateFrom * – дата «С»
- DateTo * – дата «По»
- RegionKeys – идентификаторы регионов (если не заданы города и отели – поиск по всем регионам, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- CityKeys – идентификаторы городов (если не заданы отели – ищем поиск для всех отелей городов, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- HotelKeys – идентификаторы отелей (если заданы отели – поиск только для них, должно быть заполнено RegionKeys или CityKeys или HotelKeys)
- RoomDescriptions – идентификаторы описаний комнат. Если не предавать будет искать для всех (возвращается при запросе к методу GetRoomFescriptions)
- PansionKeys – идентификаторы питаний. Если не передавать будет искать для всех (возвращается при запросе к методу GetPansions)
- Ages – возраст детей
- Pax * – размещение
- Tariffs – идентификаторы тарифов по которым рассчитывать результат. Если не передавать будет считать по тарифу Ordinary (0 - Ordinary, 1 - SPO)
- CacheGuid – идентификатор поиска, который ускоряет переход по страницам. При первом поиске его передавать не нужно. Поиск вернет этот идентификатор в параметре ResponseGuid. Далее, используя пейджинг, передаем этот идентификатор дальше (но только в рамках одного поиска!)
- ResultView – тип вывода результата (1 – cортировка по суточной цене с группировкой по отелям, 2 – сортировка по суточной цене)
- QuotaTypes – фильтр по типу квоты(0 – запрос, 1 – квота, 2 – стоп). Получаем все возможные результаты. Если не указано, то значение=0
- Mode – не указываем или указываем 0
Возвращаемый результат:
- DataRequestResult – результат поиска
- ResultTable – таблица с результатом
- HotelServices – услуга отеля
- HotelName – наименование отеля
- HotelKey – ключ отеля
- RtCode – тип номера
- RtKey – ключ типа номера
- RcName – категория номера
- RcKey – ключ категории номера
- RdName – тип+категория номера
- RdKey – ключ тип+категория номера
- AcName – тип размещения
- AcKey – ключ типа размещения
- PnCode – тип питания
- PnKey – ключ типа питания
- TotalCost – конечная стоимость проживания в отеле включая обязательные доплаты Cost + AdHotCost. Сортировка по минимальной цене производиться по параметру TotalCost от наименьшей цены к наибольшей
- Cost – размер обязательной доплаты Cost
- AddHotsCost – размер обязательной доплаты AdHot
- AddHotsWithCosts – размер обязательной доплаты AdHot типа With costs (выдает -1 если настройка отображения Adhot типа With Costs в конфиге Integration Service Interlook. Описание настройки Master-Interlook:Обмен. Настройка Web-сервиса Master-Interlook#Настройка параметров конфига web.config Integration Service )
- DetailBrutto – формула расчета цены
- QuoteType – тип квоты. Может принимать 3 значения: 0 – на запрос,1 – в квоте, 2 – стоит стоп сейл.
- CountryKey – ключ страны предоставления услуги
- CityKey – ключ города предоставления услуги
- CityName – наименование города предоставления услуги
- HotelWebSite – адрес веб-сайта отеля
- TariffId – идентификатор тарифа
- TariffName – наименование тарифа
- TariffDescription – описание тарифа
- AddHots – идентификатор Adhot
- ContractPrKey – ключ партнера предоставляющего услугу
- HotelImage – фото отеля
- AddHotsWithCostID – идентификатор AddHotsWithCost
- Rate – валюта
- HotelServices – услуга отеля
- ColunmNames – название столбцов таблицы
- HotelName – наименование отеля
- HotelKey – ключ отеля
- RtCode – тип номер
- RtKey – ключ типа номера
- RcName – категория номера
- RcKey – ключ категории номера
- RdName – тип+категория номера
- RdKey – ключ тип+категория номера
- AcName – тип размещения
- AcKey – ключ типа размещения
- PnCode – тип питания
- PnKey – ключ типа питания
- TotalCost – конечная стоимость проживания в отеле включая обязательные доплаты Cost + AdHotCost. Сортировка по минимальной цене производиться по параметру TotalCost от наименьшей цены к наибольшей
- Cost – размер обязательной доплаты Cost
- AddHotsCost – размер обязательной доплаты AddHotsCost
- DetailBrutto – формула расчета цены
- QuoteType – тип квоты. Может принимать 3 значения: 0 – на запрос,1 – в квоте, 2 – стоит стоп сейл.
- CountryKey – ключ страны предоставления услуги
- CityKey – ключ города предоставления услуги
- CityName – наименование города предоставления услуги
- HotelWebSite – адрес сайта отеля
- TariffId – идентификатор тарифа
- TariffName – наименование тарифа
- TariffDescription – описание тарифа
- AddHots – доплата
- ContractPrKey – ключ партнера, предоставляющего услугу
- HotelImage – фото отеля
- AddHotsWithCostID – идентификатор AddHotsWithCost
- Rate – валюта
- TotalCount – номер строки, на которой закончился поиск
- PageSize – количество возвращаемых строк данных
- PageIndex – номер строки, с которой начали поиск
- IsLastPage – при отображении последней страницы результатов поиска с отелями параметр IsLastPage принимает значение true. Если не обрабатывать параметр IsLastPage, то следующее значение TotalCount вернет пустой результат по отелям
- AdditionalData – список обязательных Adhot
- ArrayOfAnyType – массив типов услуг
- anyType – тип услуги
- ExternalID – параметр для внутреннего использования
- Price – стоимость
- NMen – количество туристов по путевке
- PartnerID – идентификатор партнера
- Quota – квота по услуге
- PacketKey – ключ пакета
- AdditionalParams – массив дополнительных параметры (представляются в виде пары ключ – значение)
- ParameterPair Key – ключ
- Value – значение
- ParameterPair Key – ключ
- Tourists – туристы
- DetailNetto – подробности нетто
- DetailBrutto – подробности брутто
- Notes – примечания к услуге
- Name – наименование услуги
- StartDate – дата предоставления услуги (в формате ГГГГ-ММ-ДДT00:00:00)
- StartDay – день предоставления услуги
- Duration – продолжительность услуги
- RateBrutto – валюта брутто
- Brutto – цена брутто
- RateNetto – валюта нетто
- Netto – цена нетто
- ServiceClassID – идентификатор класса услуги
- TouristCount – количество туристов, пользующихся услугой
- ID – идентификатор услуги (-1 для новой путевки )
- Status – статус услуги
- Name – наименование статуса услуги
- ID – идентификатор статуса услуги
- Description – описание статуса услуги
- NameLat – наименование статуса услуги латиницей
- Code – код статуса услуги
- CodeLat – код статуса услуги латиницей
- Unicode – код ISO статуса услуги
- CityKey – ключ города предоставления услуги
- IsPackage – признак пакетной услуги
- Code – идентификатор услуги
- HasDuration – услуга с продолжительностью или без
- anyType – тип услуги
- ArrayOfAnyType – массив типов услуг
- ResponseGuid – идентификатор ответа
- ResultTable – таблица с результатом
В случае ошибок в запросе в ответе получаем сообщение с расшифровкой ошибок и/или номер строки с ошибкой.
В случае ошибки в GUID получим сообщение "Invalid user or password (Invalid GUID)."
В случае если дата начала больше даты окончания получим сообщение "Parameter 'DateTo' can't be less than 'DateFrom'."
В случае отсутствия одного из обязательных параметров получим сообщение "Parameter '<значение параметра>' is required."
В случае отсутствия ключа отеля, ключа города, ключа региона получим сообщение "At least one of the following parameters must be specified: 'RegionKeys', 'CityKeys' or 'HotelKeys'."
развернутьПример
SearchActualCostCalculationVariant (Поиск возможных вариантов типов комнат, категорий комнат, размещений и питаний на которые есть актуальные цены по отелю)
Метод выдает возможные варианты типов комнат, категорий комнат, размещений и питаний на которые есть актуальные цены по отелю.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса:
- HotelId * – идентификатор отеля (обязательный параметр, значения 0 и -1 не допустимы)
- DateFrom * – дата «с»
- DateTo * – дата «по»
- ValidateQuoata – проверять ли квоту (true – проверять, false – нет)
- QuotaTypes – фильтр по типу квоты (0 – запрос, 1 – квота, 2 – стоп)
- CheckAdHot – учитывать ли цены на обязательные адхоты (true – учитывать, false – нет)
- Rate * – код валюты, в которой будет вестись расчет
Возвращаемый результат:
- SearchActualCostCalculationVariantResult – результат поиска
- CostCalculationVariant – массив данных
- RoomAccommodationId – ключ размещения
- RoomTypeId – ключ типа комнаты
- RoomCategoryId – ключ категории комнаты
- PansionId – ключ питания
- RoomAccommodationName – код размещения
- RoomTypeName – код типа комнаты
- RoomCategoryName – код категории комнаты
- PansionName – код питания
- CountAdult – количество взрослых
- CountChildren – количество детей
- Quota – значение квоты
- CostCalculationVariant – массив данных
развернутьПример
Методы работы с ценами
GetSpoList (Получение списка SPO согласно запросу)
Метод возвращает список SPO согласно запросу.
Важный момент: возвращается информация только по тем Costoffers, на которые есть публикация партнеру (группе партнера) пользователя, которые подключились к веб сервису.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – класс с параметрами запроса
- SvKey * – ключ класса услуги (1 – проживание, 2 – трансфер, 4 – экскурсия, 5 – экстрасервис, 0 или -1 не принимаются)
- PublicationDateBegin * – дата публикации SPO «с»
- PublicationDateEnd * – дата публикации цены «по»
Возвращаемый результат:
- SPOInfo – результат поиска
- ResultTable – таблица с результатом
- Id – ключ SPO
- Name – название SPO
- PeriodBeforeCheckIn – период до заезда
- SaleDateBegin – дата с которой возможно бронирование
- SaleDateEnd – дата до которой возможно бронирование
- Comment – описание SPO
- CreateDate – дата создания
- UpdateDate – дата обновления
- SpoType – тип SPO (Ordinary – 0, Spo – 1)
- SvKey – класс услуги
- COLinkServices – услуги SPO
- COLinkService – конкретная услуга SPO
- SvKey – ключ типа услуги
- Code – ключ услуги
- DurationMin – минимальная продолжительность
- DurationMax – максимальная продолжительность
- IsDisable – заблокирована ли услуга
- DisableDate – дата блокировки
- COLinkService – конкретная услуга SPO
- COServices – информация о ценах на услуги в этом SPO
- COService – информация о цене на конкретную услугу в этом SPO
- Code – идентификатор услуги
- CostCount – количество цен для услуги в SPO
- CostLastUpdate – дата последнего изменения (добавления, удаления) цен для услуги в этом СПО
- COService – информация о цене на конкретную услугу в этом SPO
развернутьПример
GetCosts (Получение брутто цены по параметрам запроса)
Метод возвращает брутто цены по параметрам запроса.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- SpoId * – ключ SPO ((Параметр CO_Id таблицы CostOffers). Список SPO возвращается при запросе к методу GetSpoList)
- TariffId * – ключ тарифа ((В таблице цен соответствует параметру CS_CVId). При установке "-1" подбираются все тарифы)
- SvKey * – тип услуги(1 – проживание, 2 – трансфер, 4 – экскурсия, 5 – экстрасервис)
- Code * – ключ услуги (Для отеля это ключ из таблицы Partners. Для всех остальных услуг – это ключ SL_KEY из таблицы ServiceList. Так же эти ключи можно получить методами веб сервиса: GetServiceList, GetExcursions, GetTransfers, GetHotels)
- PriceType – тип цены проживания (0 – за человека, 1 – за комнату, 2 – все). Если не указан, то запрашивается 2.
- DownloadOnlyActualCosts * – закачка только актуальных цен (1 – получать актуальные, 0 – получать все)
- DownloadUpdateCostsFromDate * – закачивать цены только с выбранной даты (1 – настройка включена, 0 – получаем все)
- CostsUpdateDateBegin * – дата, с которой закачивать цены (используется при установке параметра DownloadUpdateCostsFromDate)
- SpoId * – ключ SPO ((Параметр CO_Id таблицы CostOffers). Список SPO возвращается при запросе к методу GetSpoList)
Возвращаемый результат:
- GetCostsResult – результаты выдачи
- CostInfo – массив данных
- Id – ключ цены
- SvKey – ключ типа услуги
- SpoId – идентификатор SPO
- Code – ключ услуги
- AgeFrom – возраст «с»
- AgeTo – возраст «по»
- CreateDate – дата создания цены
- CheckInDateBegin – дата заезда «с»
- CheckInDateEnd – дата заезда «до»
- CheckOutDateBegin – дата выезда «с»
- CheckOutDateEnd – дата выезда «до»
- DateBegin – дата действия цены «с»
- DateEnd – дата действия цены «до»
- UpdateDate – последняя дата обновления цены
- Price – значение цены
- Rate – валюта
- SubCode1 – параметр цены в зависимости от типа услуги (для проживания – ключ типа номера, для трансфера – TransferType, для Adhot – ключ типа комнаты)
- SubCode2 – параметр цены в зависимости от типа услуги (для проживания – ключ питания, для трансфера – точка начала, для Adhot – ключ отеля)
- SubCode3 – параметр цены в зависимости от типа услуги (для проживания – ключ категории номера, для трансфера – точка окончания, для Adhot – ключ категории комнаты)
- SubCode4 – параметр цены в зависимости от типа услуги (для проживания – размещение, для Adhot – размещение)
- TariffId – ключ тарифа
- Type – тип цены (1 – групповая, 0 – негрупповая. Для отеля за комнату или за человека.)
- CountryId – ключ страны услуги
- CityFromId – ключ города услуги
- CityToId – ключ города услуги «куда» (для трансферов)
- TouroperatorId – ключ туроператора
- CostInfo – массив данных
развернутьПример
SpoPriceMarkDownloaded (Получение информации о доступности конкретного SPO для продажи)
Метод возвращает информацию о доступности конкретного SPO для продажи.
Важный момент: возвращается информация только по тем Costoffers, на которые есть публикация партнеру (группе партнера) пользователя, которые подключились к веб сервису.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- SpoKey * – ключ SPO (возвращается при запросе к методу GetSpoLList)
- VariantOfCost – вариант цены
- SvKey – ключ класса услуги
- Code – код услуги
Возвращаемый результат:
- SpoPriceMarkDownloadedResult – результат поиска
- true – SPO доступно
- false – SPO недоступно
развернутьПример
Методы работы с услугами
GetHotels (Получение списка отелей по параметрам)
Метод возвращает список отелей по параметрам.
Принимаемые параметры запроса ( * – обязательный):
- СountryKey * – ключ страны (-1 для всех)
- RegionKey * – ключ региона (-1 для всех)
- СityKey * – ключ города (-1 для всех)
Возвращаемый результат:
- GetHotelsResult – результаты выдачи
- Hotel – отель
- Name – название отеля
- ID – идентификатор отеля
- Description – описание отеля
- NameLat – название отеля латиницей
- Code – код отеля
- CodeLat – код отеля латиницей
- Unicode – код ISO отеля
- City – город отеля
- Name – название города
- ID – идентификатор города
- Description – описание города
- NameLat – название города латиницей
- Code – код города
- CodeLat – код города латиницей
- Unicode – код ISO города
- CountryID – идентификатор страны отеля
- RegionID – идентификатор региона отеля
- RegionID – идентификатор региона отеля
- PriceType – тип цены (PerPerson = 0, PerRoom = 1, All = 2, None = 1000)
- CountCosts – количество цен на отель
- CityId – идентификатор города отеля
- HotelCategoryID – идентификатор категории отеля
развернутьПример
GetTransfers (Получение списка трансферов по параметрам)
Метод возвращает список трансферов по параметрам.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- СountryKey * – ключ страны (-1 для всех)
- СityKey * – ключ города (-1 для всех)
- RegionKey * – ключ региона (-1 для всех)
- TypeKey * – ключ типа трансфера (-1 для всех)
Возвращаемый результат:
- GetTransferResult – результаты выдачи
- TransferDirectionInfo – массив данных
- ID – идентификатор трансфера
- Name – название
- TransferTypeID – ключ типа трансфера
- TransferTypeName – название типа трансфера
- CityFromID – идентификатор города откуда
- CityFromName – название города откуда
- CityToID – идентификатор города куда
- CityToName – название города куда
- PointFromID – идентификатор точки откуда
- PointFromName – название точки откуда
- PointToID – идентификатор точки куда
- PointToName – название точки куда
- TransferDirectionInfo – массив данных
развернутьПример
GetExcursions (Получение списка экскурсий по параметрам)
Метод возвращает экскурсии по параметрам.
Принимаемые параметры запроса ( * – обязательный):
- СountryKey * – ключ страны (-1 для всех)
- RegionKey * – ключ региона (-1 для всех)
- СityKey * – ключ города (-1 для всех)
Возвращаемый результат:
- GetExcursionsResult – результаты выдачи
- Excursion – массив данных
- Name – название экскурсии
- ID – идентификатор экскурсии
- Description – описание экскурсии
- NameLat – название экскурсии латиницей
- Code – код экскурсии
- CodeLat – код экскурсии латиницей
- Unicode – код ISO экскурсии
- CityID – идентификатор города
- RegionID – идентификатор региона
- Excursion – массив данных
развернутьПример
GetServiceList (Получение списка дополнительных услуг)
Метод возвращает дополнительные услуги.
Возвращаемый результат:
- GetServiceListResult – результаты выдачи
- ServiceList – массив данных
- AdditionalParams – дополнительные параметры
- Key – ключ
- Value – значение
- Name – название дополнительной услуги
- ID – идентификатор дополнительной услуги
- NameLat – название дополнительной услуги латиницей
- Code – код дополнительной услуги
- CodeLat – код дополнительной услуги латиницей
- Unicode – код ISO дополнительной услуги
- ServiceClaseID – идентификатор класса дополнительной услуги
- CountryID – идентификатор страны дополнительной услуги
- AdditionalParams – дополнительные параметры
- ServiceList – массив данных
развернутьПример
GetExtraServices (Получение списка дополнительных услуг включая услуги типа AdHot)
Метод возвращает список дополнительных услуг, в том числе и услуги типа AdHot.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- ServiceClassKey * – ключ класса дополнительной услуги (-1 для всех)
- СountryKey * – ключ страны дополнительной услуги (-1 для всех)
- СityKey * – ключ города для AdHot (-1 для всех)
- HotelKey * – ключ отеля для AdHot (-1 для всех)
- RegionKey * – ключ региона (-1 для всех)
- TypeKey * – тип AdHot (-1 – для всех, 1 – Manual, 2 – HardLink, 3 – WithCosts)
Возвращаемый результат:
- GetExtraServicesResult – результаты выдачи
- ExtraServiceInfo – массив данных
- Id – идентификатор дополнительной услуги
- Name – название дополнительной услуги
- Description – описание дополнительной услуги
- ServiceClassId – идентификатор класса дополнительной услуги
- IsWeb – доступность дополнительной услуги в онлайн
- DurationType – c продолжительностью или без (1 – с продолжительностью)
- UpdateDate – дата последнего обновления дополнительной услуги
- IsPartnerLikeHotel – партнер у AdHot такой же как и у проживания
- LinkType – тип AdHot (1 - Manual, 2 – HardLink, 3 - WithCosts)
- IsAddHot – является ли услуга AdHot (true – является, false – не является)
- CountryList – список ключей стран для AdHot (если коллекция пустая – значит для всех)
- CityList – список ключей городов для AdHot (если коллекция пустая – значит для всех)
- HotelList – список ключей отелей для AdHot (если коллекция пустая – значит для всех)
- RoomTypeList – список ключей типов комнат для AdHot (если коллекция пустая – значит для всех)
- RoomCategoryList – список ключей категорий комнат для AdHot (если коллекция пустая – значит для всех)
- AccommodationList – список ключей размещений для AdHot (если коллекция пустая – значит для всех)
- HotelLinkTypeList – список переопределений типа AdHot для отелей
- HotelLinkTypeEx – переопределение типа AdHot для отеля
- HotelId – ключ отеля
- ExtraServiceLinkType – переопределенный тип AdHot (1 – Manual, 2 – HardLink, 3 – WithCosts)
- HotelLinkTypeEx – переопределение типа AdHot для отеля
- ExtraServiceInfo – массив данных
развернутьПример
GetExtraServiceWithPrices (Получение списка дополнительных услуг включая услуги типа AdHot с ценами)
Метод возвращает список дополнительных услуг, в том числе и услуги типа AdHot с ценами.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Request – объект с параметрами запроса
- HotelKey * – ключ отеля для AdHot (-1 для всех)
- DateFrom – дата действия от
- DateTo – дата действия до
Возвращаемый результат:
- GetExtraServiceWithPricesResult Message="Ok">
- CostInfo – массив данных
- Id – ключ цены
- SvKey – ключ типа услуги
- SpoId – идентификатор SPO
- Code – ключ услуги
- AgeFrom – возраст «с»
- AgeTo – возраст «по»
- CreateDate – дата создания цены
- CheckInDateBegin – дата заезда «с»
- CheckInDateEnd – дата заезда «до»
- CheckOutDateBegin – дата выезда «с»
- CheckOutDateEnd – дата выезда «до»
- DateBegin – дата действия цены «с»
- DateEnd – дата действия цены «до»
- UpdateDate – последняя дата обновления цены
- Price – значение цены
- Rate – валюта
- SubCode1 – параметр цены в зависимости от типа услуги (для проживания – ключ типа номера, для трансфера – TransferType, для Adhot – ключ типа комнаты)
- SubCode2 – параметр цены в зависимости от типа услуги (для проживания – ключ питания, для трансфера – точка начала, для Adhot – ключ отеля)
- SubCode3 – параметр цены в зависимости от типа услуги (для проживания – ключ категории номера, для трансфера – точка окончания, для Adhot – ключ категории комнаты)
- SubCode4 – параметр цены в зависимости от типа услуги (для проживания – размещение, для Adhot – размещение)
- TariffId – ключ тарифа
- Type – тип цены (1 – групповая, 0 – негрупповая. Для отеля за комнату или за человека.)
- CountryId – ключ страны услуги
- CityFromId – ключ города услуги
- CityToId – ключ города услуги «куда» (для трансферов)
- TouroperatorId – ключ туроператора
- AdHotName – название доп. услуги в отеле
- LinkType – тип доп. услуги в отеле: 1 - Manual (услуга, добавляемая по желанию), 2 – HardLink (обязательная услуга в отеле), 3 - WithCosts (обязательная услуга, добавляемая при наличии цены в период бронирования отеля)
- DurationType – услуга c продолжительностью или без (1 – цена указана за сутки, 0 - цена указана за весь период проживания)
- CostInfo – массив данных
развернутьПример
CalculateSingleCost (Расчет стоимости услуги по ее параметрам стандартным механизмом расчета)
Метод рассчитывает стоимость услуги по ее параметрам стандартным механизмом расчета.
Принимаемые параметры запроса ( * – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- SvKey * – ключ типа услуги
- СountryKey * – ключ страны
- Сode * – ключ услуги
- Subcode1 * – параметр цены в зависимости от типа услуги (для проживания – ключ типа номера, для трансфера – TransferType)
- Subcode2 * – параметр цены в зависимости от типа услуги (для проживания – ключ питания, для трансфера – точка начала)
- Subcode3 * – параметр цены в зависимости от типа услуги (для проживания – ключ категории номера, для трансфера – точка окончания)
- Subcode4 * – параметр цены в зависимости от типа услуги (для проживания – размещение)
- TourOperatorGroupKey * – ключ группы туроператора
- TourOperatorKey * – ключ туроператора (продавца)
- MrKey * – ключ рынка
- FilialKey * – ключ филиала
- TafiffKey * – ключ тарифа
- Pax * – Pax по услуге
- Ages * – список с возрастами детей
- CheckInDate * – дата «с»
- CheckOutDate * – дата «по»
- CityKey * – ключ города
- CityKeyTo * – ключ города «куда»
- Rate * – код валюты
- PricePerRoom * – за комнату или за человека
- OnlyPublished * – учитывать только опубликованные цены
- ServiceProviderKey * – ключ поставщика услуги
Возвращаемый результат:
- CalculateSingleCostResult – результаты выдачи
- Brutto – рассчитанная брутто цена
- ProviderKey – ключ поставщика услуги
- IsCalcBrutto
- CancellationPolicies – Политика аннуляции
- PolicyKey – ключ политики
- DateFrom – дата "от"
- DateTo – дата "до"
- PenaltyValue – значение штрафа
- IsPercent - процент, указывающий, что штраф в "%" (true) или в "ночах" (false)
развернутьПример
Methods of working with dictionaries
GetRegions (Receiving the list of the regions)
The method returns a list of regions. Accepted request parameters ( * – required):
- СountryKey * – the country ID (-1 for all)
The returning result:
- GetRegionsResult – the search result
- Region – an array of the data
- Name – the name of the region
- ID – ID of the region
- Description – the description of the region
- NameLat – the name of the region in Latin
- Code – the region code
- CodeLat – the region code in Latin
- Unicode – the ISO code of the region
- CountryID – the country ID
- Region – an array of the data
развернутьExample
GetCities (Receiving the list of the cities)
The method returns a list of cities. Accepted request parameters ( * – required):
- СountryKey * – country ID (-1 for all)
- RegionKey * – region ID (-1 for all)
The returning result:
- GetCitiesResult – the search result
- City – an array of the data
- Name – the name of the city
- ID – ID of the city
- Description – the description of the city
- NameLat – the name of the city in Latin
- Code – the city code
- CodeLat – the city code in Latin
- Unicode – the ISO code of the city
- CountryID – ID of the city
- RegionID – the region ID
- City – an array of the data
развернутьExample
GetCountries (Receiving the list of the countries)
The method returns a list of countries.
The returning result:
- GetCountriesResult – the search result
- Country – the an array of the data
- Name – the name of the country
- ID – the country ID
- Description – the description of the country
- NameLat – the name of the country in Latin
- Code – the country code
- CodeLat – the country code in Latin
- Unicode – the ISO code of the country
- IsIncoming – the parameter for internal use
- Country – the an array of the data
развернутьExample
GetRoomType (Receiving the list of the room types)
The method returns a list of room types.
The returning result:
- GetRoomTypeResult – the search result
- RoomType – an array of the data
- Name – the name of the room type
- ID – ID of the room type
- Description – the description of the room type
- NameLat – the name of the room type
- Code – the room type code
- CodeLat – the room type code in Latin
- Unicode – the ISO code of the room type
- Places – the number of main places
- ExPlaces – the number of additional seats
- PrintOrder – the number of additional seats
- RoomType – an array of the data
развернутьExample
GetRoomCategories (Receiving the list of the room categories)
The method returns a list of room categories.
The returning result:
- GetRoomCategoriesResult – the search result
- RoomCategory – an array of the data
- Name – the name of the room category
- ID – ID of the room category
- Description – the description of the room category
- NameLat – the name of the room category
- Code – the room category code
- CodeLat – the room category code in Latin
- Unicode – the ISO code of the room category
- MainPlaces – the number of main places
- ExtraPlaces – the number of additional places
- IsMain – the parameter for internal use
- RoomCategory – an array of the data
развернутьExample
GetPansions (Receiving the list of the pansion types)
The method returns a list of types of meals.
The returning result:
- GetPansionsResult – the search result
- Pansion – the search result
- Name – the name of the pansion type
- ID – ID of the type of pansion
- Description – the description of the type of pansion
- NameLat – the name of the type of pansion in Latin
- Code – the code of the type of pansion
- CodeLat – the type of pansion code in Latin
- Unicode – the ISO code of the pansion type
- Pansion – the search result
развернутьExample
GetRatings (Receiving an array of hotel categories (hotel stars))
The method returns an array of hotel categories.
The returning result:
- GetRatingsResult – the search result
- HotelCategory – an array of the data
- Name – the name of the hotel category
- ID – ID of the hotel category
- Description – the description of the hotel category
- NameLat – the name of the hotel category in Latin
- Code – the code of the hotel category
- CodeLat – the code of the hotel category
- Unicode – the ISO code of the hotel categoryя
- HotelCategory – an array of the data
развернутьExample
GetFlights (Receiving the list of the regions)
The method returns a list of flights.
The returning result:
- GetFlightsResult – the search result
- Flight – an array of the data
- AirportFrom – the transfer hub at the departure point
- Name – the name of the transfer node from the Flight numbers dictionary
- ID – ID of the city of the transfer node
- Description – the name of the city of the transfer node from the Pickup point list dictionary
- NameLat – the name of the transfer node
- Code – the code of the transfer node
- CodeLat – the code of the transfer node in Latin
- Unicode – the ISO code of the transfer node
- RegionID – ID of the region of the transfer node location
- CityID – ID of the city where the transfer node is located
- AirportTo – the transfer hub at the point of arrival
- Name – the name of the transfer node from the Flight numbers dictionary
- ID – ID of the city of the transfer node
- Description – the name of the city of the transfer node from the Pickup point list dictionary
- NameLat – the name of the transfer node
- Code – the code of the transfer node
- CodeLat – the code of the transfer node in Latin
- Unicode – the ISO code of the transfer node
- RegionID – ID of the region of the transfer node location
- CityID – ID of the region of the transfer node location
- TimeFrom – time from
- TimeTo – time to
- DateFrom – date from
- DateTo – date to
- IsArrival –
- Available –
- ID – ID of the row from the Charter table from the database
- Name – ID of the row from the Charter table from the database
- Number – the flight number from the Flight numbers dictionary
- ArrivalFlightNumber – the arrival flight number from the Flight numbers dictionary
- DepartureFlightNumber – the departure flight number from the Flight numbers dictionary
- AirportFrom – the transfer hub at the departure point
- Flight – an array of the data
развернутьExample
GetAirport (Receiving the list of the transfer nodes)
The method returns a list of transfer nodes.
The returning result:
- GetFlightsResult – the search result
- Airport – an array of the data
- Name – the name of the transfer node from the Pickup Pickup point list dictionary
- ID – ID of the transfer node
- Description – the name of the city of the transfer node from the Pickup point list dictionary
- NameLat – the name of the city of the transfer node in Latin
- Code – the city code of the transfer node in Latin
- CodeLat – the city code of the transfer node in Latin
- Unicode – the ISO code of the city of the transfer node in Latin
- RegionID – ID of the region of the transfer node location
- CityID – ID of the city where the transfer node is located
- Airport – an array of the data
развернутьExample
GetProviders (Receiving the list of the partners which are providers of services)
The method returns a list of partners of the system who are used to be service providers.
Returning result:
- GetProvidersResult – the search result
- Partner – an array of the data
- Name – the name of the partner
- ID – the ID of the stalls
- Description – the description of the partner
- NameLat – the name of the partner in Latin
- Code – the partner's code
- CodeLat – the partner code in Latin
- Unicode – the partner's ISO code
- PartnersGroupID – ID of the partner's group
- FullName – the full name of the partner
- Fax – the partner's fax
- Address – the partner's address
- Zip – the partner's zip code
- Email – the partner's e-mail
- Phones – the partner's phones
- Partner – an array of the data
развернутьExample
GetTransports (Receiving the list of the vehicles)
The method returns a list of vehicles.
The returning result:
- GetTransportsResult – the search result
- Transport – an array of the data
- Name – the name of the vehicle
- ID – the vehicle ID
- Description – the description of the vehicle
- NameLat – the name of the vehicle in Latin
- Code – the vehicle code
- CodeLat – the vehicle code in Latin
- Unicode – the ISO code of the vehicle
- Transport – an array of the data
развернутьExample
GetTransferTypes (Receiving the list of the transfer types)
The method returns a list of transfer types.
The returning result:
- GetTransferTypesResult – the search result
- Transport – an array of the data
- Name – the name of the transfer
- ID – the transfer ID
- Description – the description of the transfer
- NameLat – the name of the transfer in Latin
- Code – the transfer code
- CodeLat – transfer code in Latin
- Unicode – the ISO code of the transfer
- Transport – an array of the data
развернутьExample
GetRates (Receiving the list of the currencies)
The method returns a list of currencies.
The returning result:
- GetRatesResult – the search result
- Rate – an array of the data
- Name – the name of the currency
- ID – the currency ID
- Description – the currency description
- NameLat – the description of the currency in Latin
- Code – the currency code
- CodeLat – the currency code in Latin
- Unicode – the ISO code of the currency
- IsMain – the currency attribute "main"
- IsNational – the currency attribute "national"
- Rate – an array of the data
развернутьExample
GetServicePackage (Receiving the list of the options for package services)
The method returns a list of options for package services.
The returning result:
- GetServicePackageResult – the search result
- ServiceList – an array of the data
- Name – the name of the option
- ID – ID of the option
- Description – the description of the option
- NameLat – the description of the option in Latin
- Code – the code of the option
- CodeLat – the code of the option in Latin
- Unicode – the ISO code of the option
- ServiceClaseID – ID of the additional service class
- CountryID – the key of the country of the option
- ServiceList – an array of the data
развернутьExample
GetDLStatuses (Receiving the list of the service statuses)
The method returns the file status of the service.
The returning result:
- GetDLStatusesResult – the search result
- StatusService – an array of the data
- Name – the name of the
- ID – the service status ID
- Description – the description status services
- NameLat – the description of services in Latin
- Code – the code of service status
- CodeLat – the code of service status in Latin
- Unicode – the ISO code of service status
- StatusService – an array of the data
развернутьExample
GetTariffs (Receiving the list of the tariffs for the certain type of services)
The method returns tariffs for the certain type of service.
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
- SvKey * – the service type key
The returning result:
- GetTariffsResult – the search result
- Tariff – an array of the data
- ID – the tariff ID
- Name – the name of the tariff
- Description – the description of the tariff
- NameLat – the name of the tariff in Latin
- Code – the code of the tariff
- CodeLat – the tariff code in Latin
- Unicode – the ISO code of the tariff
- SvKey – the service type key
- Comment – the description
- CreateDate – the creation date
- Tariff – an array of the data
развернутьExample
GetRoomDescriptions (Receiving an array of the descriptions of the rooms)
The method returns an array of room descriptions.
Accepted request parameters ( * – required):
- RoomTypeId * – the room type key (0 – for all)
- RoomCategoryId * – the room category key (0 – for all)
The returning result:
- GetRoomDescriptionsResult – the search result
- AdditionalDescription – an array of the data
- Name – the name of the description of the room
- ID – the name of the description of the room
- Description – the description
- NameLat – the name of the description of the room in Latin
- Code – the room description code
- CodeLat – the code of the description of the room in Latin
- Unicode – the ISO code of the room description
- AdditionalDescription – an array of the data
развернутьExample
GetAccommodations (Receiving the accommodations for the hotel)
The method returns hotel accommodations.
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
The returning result:
- GetAccommodationsResult – the search result
- Message – the accommodation ID
- Data – an array of objects with data
- AccomodationInfo – an array of the data with accommodation
- Id – the accommodation ID
- Code – the accommodation code
- Name – the name of the accommodation
- IsPerRoom – per room or per person
- NameUnicode – the name of the accommodation in Unicode
- CountAdultMain – the number of adults in the main places
- CountChildMain – the number of children in the main places
- CountAdultExtra – the number of adults per additional place
- CountChildExtra – the number of children per additional place
- ChildrenAges – the string with a description of the ages of children
- IsWeb – the accessibility for Interlook-Web
- IsPackage – is it possible to add to the package
- UpdateDate – the date of the last update of the accommodation
- ClildrenAgesList – the list with the ages of children
- AccomadationAge – an array of the data with age
- Id – ID of the record
- AgeFrom – age «from»
- AgeTo – age «to»
- CountMen – the number of adults in the accommodation
- IsMain – is a child of this age in the main place
- UpdateDate – the date of the last update of the record
- AccomadationAge – an array of the data with age
- AccomodationInfo – an array of the data with accommodation
развернутьExample
GetRoomAccommodations (Receiving the accommodations for the hotel an 2 first values of ages from the list of childrenages)
The method returns the hotel accommodation and the first 2 values of ages from the list of ages of children.
The returning result:
- GetRoomAccommodationsResult – The returning result
- RoomAccomodation – an array of the data
- Name – the name of the accommodation
- ID – the accommodation ID
- Description – the description of the accommodation
- NameLat – the name of the accommodation in Latin
- Code – the accommodation code
- CodeLat – the accommodation code in Latin
- Unicode – the ISO code of the accommodation
- PerRoom – per room
- AdultMainPalces – the number of adult main places
- ChildMainPalces – the number of primary places for children
- AdultExtraPalces – the number of adult additional places
- ChildExtraPalces – the number of additional places for children
- MainPlaces – the number of main places
- ExtraPlaces – the number of additional seats
- IsMain – the are there any main places
- AgeFrom – the age of children «from»
- AgeTo – the age of children «to»
- Age2From – the age of children «from»
- Age2To – the age of children «to»
- RoomAccomodation – an array of the data
развернутьExample
GetClientInfo (Issuing information about the partner to which relates the on-line user)
The method provides information about the partner to which the on-line user belongs, under which the request was made in the Connect method .
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
The returning result:
- Name – the name of the partner
- MarketName – the list of markets from the partner card
- Address – the address from the partner's card
развернутьExample
Methods of integration with payment systems
GetReservationPenalties (Receiving the penalties for the reservation before canceling it)
The method returns the amount of penalties for the reservation before it is canceled.
The operation of the method is regulated by a license.
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
- ReservationKey * – the reservation key
- CancellationDate – the cancellation date on which the condition and the amount of the fine are issued. If not specified, then we get all possible cancellation rules up to arrival.
The returning result:
- GetReservationPenaltiesResult – the search result
- Penalty – fine
- ServicePenalty – the penalty service
- ServiceClassID – id of the service class
- ID – ID of the fine
- Name – the name of the fine
- PenaltyData – an array of penalty data
- PenaltyDataInfo – an array of data
- TotalPenalty – the full amount of the penalty
- RateCode – the currency code
- PolicyDescription – the penalty conditions
- CancellationPolicyData – an array of cancellation data
- PolicyKey – the cancellation key
- DateFrom – date from
- DateTo – date to
- PenaltyValue – the penalty value
- IsPercent - the percentage indicating that the penalty is in "%" (true) or in "nights" (false)
- PenaltyDataInfo – an array of data
- Hotel – the Hotel
- ID – the hotel ID
- Name – the name of the hotel
- RoomType – the room type
- ID – the Room ID
- Name – the name of the room
- RoomCategory – the room category
- ID – ID of the room category
- Name – the name of the room category
- Accommodation – the accommodation
- ID – the accommodation ID
- Name – the name of the placement
- Pansion – the type of pansion supply
- ID – ID of the type of pansion supply
- Name – the name of the type of the pansion
- ServicePenalty – the penalty service
- Penalty – fine
In case of errors, we will receive a message with a decryption.
In case of an incorrect Guid, we will receive the message: "Invalid user or password (Invalid GUID)".
If there is no contract with the specified key for the current partner, we will receive the message:"Check the parameter 'reservationKey' = <value in request>. There is no booking in the database for you.".br />
развернутьExample
CreatePayment (Creating the payments for the reservation)
The method creates the payment for the reservation.
Accepted request parameters ( * – required):
- UserToken * – Id of authentification (returns in request for method Connect)
- Date * – the date of payment creation
- Sum * – the payment amount
- CurrencyIsoCode * – the ISO code of the payment currency
- ReservationCode * – the reservation code
- PaymentId * – the payment ID (set manually for subsequent identification of the payment). The unique code specified by the user once should not be repeated in the next payment for this reservation.
The returning result:
- CreatePaymentResult – the output result
- 0 – NoError – no errors
- 1 – DogovorNotFound – the reservation with this code was not found
- 2 – InternalError – an internal error
- 3 – DogovorAnnulate – the reservation is canceled
- 4 – DogovorPayed – the reservation is paid
- 7 – ExistingPaymentID – the payment with such an external ID already exists
- 8 – IncorrectPaymentType – there are payments of prohibited types for the reservation
- 9 – NotAllowedPartnerKey – the partner on the reservation is not allowed
- 10 – FailureSignature – the signature error
- 11 – NoInvoices – there are no invoices for the reservation
развернутьExample
GetPaymentInformation (Searching for the payment information with a specified payment ID from an external system)
The method returns information about the payment with the specified payment ID from the external system.
Accepted request parameters ( * – required):
- UserToken * – Id of authentification (returns in request for method Connect)
- ReservationCode * – the reservation code
- ExternalPaymentId * – the payment ID (the PaymentID parameter in the CreatePayment method request)
The returning result:
- GetPaymentInformationResult – the output result
- IsPaymentExists – shows if there is a requested payment
- true – the payment with the specified ID for the specified reservation exists
- false – there is no requested payment
- PaymentInformationResult – an array for payment data
- InternalPaymentId – the payment ID in the Interlook system
- DogovorCode – the reservation code
- PaymentSum – the payment amount
- PaymentNationalSum – the amount of the payment in the national currency
- PaymentRateISOCode – the ISO code of the payment currency
- CreateDate – the date of payment
- ErrorCode – the error code
- 0 – NoError – no errors
- 1 – DogovorNotFound – the reservation with this code was not found
- 2 – InternalError – an internal error
- 3 – DogovorAnnulate – the reservation is canceled
- 4 – DogovorPayed – the reservation is paid
- 7 – ExistingPaymentID – the payment with such an external ID already exists
- 8 – IncorrectPaymentType – there are payments of prohibited types for the reservation
- 9 – NotAllowedPartnerKey – the partner on the reservation is not allowed
- 10 – FailureSignature – the signature error
- 11 – NoInvoices – there are no invoices for the reservation
- IsPaymentExists – shows if there is a requested payment
развернутьExample
GetCancellationPolicyInfoWithPenalty (Receiving the information on the calculation of penalties for the hotel)
|
This functionality is available starting from release 11.20 |
The method returns information about the calculation of penalties for the hotel.
The output of the method results is regulated by the license.
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
- DateFrom * – the start date of the stay
- DateTo * – the start date of the stay
- HotelKey * – the hotel ID
- PansionKey – the pansion ID
- AccommodationKey – the accommodation ID, optional if we transmit Pax
- RoomTypeKey – the room type ID
- RoomCategoryKey – ID of the room category
- Pax * – Pax by service
- Ages* – the list with the ages of children. If we are looking for accommodation without children, we transmit an empty parameter (<meg:Ages></meg:Ages>)
- CancellationDate – the cancellation date (if not specified, the current one is taken)
The returning result:
- GetCancellationPolicyInfoWithPenaltyResult – the output result
- CancellationPolicyInfoWithPenalty – an array of data
- HotelKey – the hotel ID
- HotelName – the name of the hotel
- AccomodatioKey – the accommodation ID
- AccomodatioName – the name of the accommodation
- RoomTypeKey – the room type ID
- RoomTypeName – the name of the room type
- RoomCategoryKey – ID of the room category
- RoomCategoryName – the name of the room category
- PansionKey – the pansion ID
- PansionName – the name of the food
- PolicyDescripion – the description of the cancellation policy and the full amount of the penalty
- CancellationDate – the cancellation date
- PolicyData – the cancellation date
- CancellationPolicyWithPenaltyValue – an array of data for calculating the penalty
- PolicyKey – the policy key
- DateFrom – the date "from"
- DateTo – not set
- PenaltyValue – the penalty value
- IsPercent – the parameter indicating that the penalty is in "%" (true) or in "nights" (false)
- PenaltyTotal – the total amount of the penalty
- CancellationPolicyWithPenaltyValue – an array of data for calculating the penalty
- CancellationPolicyInfoWithPenalty – an array of data
развернутьExample
CheckReservation (Receiving the information about the payment required for the reservation in the selected currency)
The method returns information about the payment required for the reservation in the selected currency.
Accepted request parameters ( * – required):
- UserToken * – Id of authentification (returns in request for method Connect)
- DgCode * – the voucher code
- CurrencyIsoCode * – the ISO code of the payment currency
The returning result:
- CheckReservationResult – the output result
- Amount – the payment amount
- RateCode – the ISO code of the payment currency
- NationalCurrencyPrice – the payment amount in national currency
- NationalRateCode – the ISO code of the national currency
- CustomCurrencyPrice – the payment amount in any currency
- CustomRateCode – the ISO code of any payment currency
- ErrorCode – the result code
- 0 – NoError – no errors
- 1 – DogovorNotFound – the reservation with this code was not found
- 2 – InternalError – an internal error
- 3 – DogovorAnnulate – the reservation is canceled
- 4 – DogovorPayed – the reservation is paid
- 7 – ExistingPaymentID – the payment with such an external ID already exists
- 8 – IncorrectPaymentType – there are payments of prohibited types for the reservation
- 9 – NotAllowedPartnerKey – the partner on the reservation is not allowed
- 10 – FailureSignature – the signature error
- 11 – NoInvoices – there are no invoices for the reservation
- FilialKey – the ID of the partner's branch
- BeginTourDate – the start date of the tour in the reservation
- EndTourDate – the end date of the tour package
развернутьExample
CreatePaymentForDogovor (Creating the reservation payment based on issued invoice)
The method creates the payment for the reservation that has an invoice.
Accepted request parameters ( * – required):
- Guid * – Id of authentification (returns in request for method Connect)
- DgKey * – the reservation key
- Payment * – the payment amount
The returning result:
- CreatePaymentForDogovorResult – the output result
- OrderId – the payment ID
If there is no created invoice for the reservation, we will receive the message: "There is no invoice".
развернутьExample
Метод работы с квотами
CheckQuota (Проверка доступности номера отеля на период)
Метод возвращает информацию о доступности номера отеля на период.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DateFrom – дата с
- DateTo – дата по
- HotelId * – ключ отеля
- RoomTypeId * – ключ типа комнаты (-1 для всех)
- RoomCategoryId * – ключ категории комнаты (-1 для всех)
Возвращаемый результат:
- ServiceResult – результат поиска
- QuotaSimpleInfo – массив данных
- RoomTypeId – ключ типа комнаты
- RoomCategoryId – ключ категории комнаты
- Quota – информация о квоте (0 – на запрос, 1 – есть квота, 2 – стоп)
- RoomVariantName – наименование варианта комнаты (комбинации из таблицы RoomVariant)
- Date – не заполняется
развернутьПример
GetQuotaInfo (Проверка доступности номера отеля на период с детализацией по дням)
Метод возвращает информацию о доступности номера отеля на период с детализацией по дням.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- DateFrom * – дата с
- DateTo * – дата по
- HotelId * – ключ отеля
- RoomTypeId * – ключ типа комнаты (-1 для всех)
- RoomCategoryId * – ключ категории комнаты (-1 для всех)
Возвращаемый результат:
- GetQuotaInfoResult – результат поиска
- QuotaSimpleInfo – массив данных
- RoomTypeId – ключ типа комнаты
- RoomCategoryId – ключ категории комнаты
- Quota – информация о квоте (0 – на запрос, 1 – есть квота, 2 – стоп)
- RoomVariantName – наименование варианта комнаты (комбинации из таблицы RoomVariant)
- Date – день
развернутьПример
GetChangeQuotaAndStop (Получение информации по квотам и стопам в отеле)
Метод передает информацию по квотам и стопам в отеле. Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- HotelKey * – ключ отеля
- Date – дата, с которой получаем изменения (если не отправляем, то берется текущая)
- UseRoomDescription * – как сопоставляем категорию и тип комнаты (через общее описание комнаты или по-отдельности)
- LoadQuaota * – загружать или нет изменения по квотам
- LoadStop * – загружать или нет изменения по стопам
Возвращаемый результат:
- GetChangeQuotaAndStopResult – результат поиска
- QuotaStopInfo – массив данных
- ID – не используется
- SvKey – ключ сервис класса (для отеля = 1)
- Code – ключ отеля
- SubCode1Name – название типа комнаты
- SubCode1 – ключ типа комнаты
- SubCode2 – не используется
- SubCode3Name – название категории комнаты
- SubCode3 – ключ категории комнаты
- RoomDescriptionID – ключ описания комнаты
- RoomDescriptionName – название описания комнаты
- Place – количество мест (2 и больше, 1 – мест мало или одно, 0 – нет мест в квоте, -1 – стоп отменен (если IsStop=true) или квота удалена(если IsStop=false)), -2 – стоп отменен и квот при этом нет)
- IsStop – стоит ли стоп на текущую дату
- Date – дата текущей квоты (стопа)
- UpdateDate – дата обновления
- Release – релиз-период
- QuotaStopInfo – массив данных
развернутьПример
GetHotelQuotaStopInfo (Получение информации по отелям, у которых были изменения в квотах или стопах с определенной даты)
Метод возвращает отели, у которых были изменения в квотах или стопах с определенной даты.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Date * – дата, с которой будем искать отели с измененными квотами или стопами
Возвращаемый результат:
- GetHotelQuotaStopResult – результат поиска
- HotelQuotaStopInfo – массив данных
- HotelKey – ключ отеля
- UpdateDateQuota – дата последнего изменения в квотах по отелю
- UpdateDateStop – дата последнего изменения в стопах по отелю
- HotelQuotaStopInfo – массив данных
развернутьПример
GetQuotaStop (Получение информации по установленным стопам на номера в отеле)
Метод возвращает информацию по установленным стопам на номера в отеле.
Принимаемые параметры запроса (* – обязательный):
- Guid * – идентификатор аутентификации (возвращается при запросе к методу Connect)
- Date * – дата, с которой будем искать отели с измененными квотами или стопами
- HotelKey * – ключ отеля
Возвращаемый результат:
- GetQuotaStopResult – результат поиска
- QuoteHotel – массив данных
- Code – ключ отеля
- StartDate – дата начала
- EndDate – дата окончания
- Date – дата
- CreateDate – дата создания
- ID – не используется
- IsRemove – удалена или нет
- Total – количество мест
- Sold – продано
- Free – свободно
- HotelKey – ключ отеля
- RoomTypeKey – ключ типа комнаты
- RoomCategoryKey – ключ категории комнаты
- QuoteType – тип квоты
- IsStopSale – установлен ли стоп на продажу
- RoomTypeId – ключ типа комнаты
- RoomCategoryId – ключ категории комнаты
- QuoteHotel – массив данных
развернутьПример
