Table of Contents

booking form - general rules

WARNING: When filling the form fields do not use local language characters. Local language characters must be converted to their ASCII equivalents - “ó” → “o” etc.

To simplify, only a selected fragment of returned form is explained, but same rules apply to the rest of responce.

<conditions>
  <type>checkbox</type>
  <checked>0</checked>
  <value>1</value>
</conditions>
<Person>
  <data>
    <lastname>
      <type>text</type>
      <value/>
    </lastname>
    <name>
      <type>text</type>
      <value/>
    </name>
    <birthdate>
      <type>text</type>
      <value>18.10.1980</value>
    </birthdate>
    <passport>
      <type>text</type>
      <value/>
    </passport>
    <price>
      <type>text</type>
      <value>1889</value>
    </price>
    <zipcode>
      <type>text</type>
      <value/>
    </zipcode>
    <city>
      <type>text</type>
      <value/>
    </city>
    <street>
      <type>text</type>
      <value/>
    </street>
    <phone>
      <type>text</type>
      <value/>
    </phone>
    <email>
      <type>text</type>
      <value/>
    </email>
    <gender>
      <type>select</type>
      <desc>
        <data>Pan</data>
        <data>Pani</data>
      </desc>
      <values>
        <data>H</data>
        <data>F</data>
      </values>
      <selected>H</selected>
    </gender>
  </data>
  <data>(...)</data>
</Person>

Params:

Element nameDescription
Conditions, Persons, … Form field name
type Field type (coresponds to types available in HTML), possible values:
checkbox, text, select, radio, hidden
checked In case of field with type=checkbox means the field is checked by default.
value Curent value
data In case of arrays containing many elements (such as list of trip participants) is used to store subsequent array elements.
desc List of descriptions for select field.
Subsequent descriptions from desc are assigned to coresponding values from values, similar as in HTML:
<option value="(value from values)">(value from desc)</option>
values List of values for field of type select
selected Currently selected value for field of type select.

When sending form, the values should be sent in abridged form, for example field:

<conditions>
  <type>checkbox</type>
  <checked>0</checked>
  <value>1</value>
</conditions>

is send as:

<conditions>1</conditions>

booking form - field

hints

text filed, containing information directly from Tour-operator, equivalent in MerlinX:

forminfo

Params:

Element nameAttributeDescription
ReservationMode-Type of booking, possible types:
1 – normal booking
0 – optional booking
conditions-Has client accepted booking conditions:
1 – yes
0 - no
check_price-If =1 allows for checking of price taking into account child age.
Person-List of trip participants
Client-Client personal data
add_service-List of additional services
client_land-Region of residence of the payer (required for some operators)
client_birthdate-Date of birth of the payer (required for some operators)
ext_conditions-Does the client accept additional information from the Tour-operator (included in the hints section)
1 - Yes
0 - No
Equivalent in MerlinX:
marketing_condition-Has customer consent to the processing of personal data for marketing purposes
1 - Yes
0 - No
Equivalent in MerlinX:
skok_condition-Has the customer has consent to the processing of personal data,
1 - Yes
0 - No
Equivalent in MerlinX:

person

contains information about particiants:

Field nameDescriptionSuggested format of data verification ( REGEX1) )Example valueAdditional info
lastnameLastname-Kowalski
nameName-Jan
birthdateBirthdate
/^\d{2}\.\d{2}\.\d{4}$/
25.12.1989For children and infants age is required in ranges:
- infants: up to 2 years (including)
- children: 2-16 years (including)
passportPassport-1234567
zipcodeZip code
/^[0-9]{2}-[0-9]{3}$/
12-345
cityCity-Warszawa
streetStreet
/^[\S]+?[^0-9]+? [0-9a-z]{1,3}(\/[0-9]{1,2})?$/
3-go Maja 32/4
phonePhote
/^[\(\)\-\+\/ 0-9]+$/
(0-71) 123 456
emailEmail
/^[^ ]+@[^ ]+$/
test@test.com
genderGender-HGender code corresponding to adults / children / infants may vary depending on the tour-operator.

client

payer, equivalent in MerlinX:

Field nameDescriptionSuggested format of data verification ( REGEX2) )Example valueAdditional information
lastnameLastname-Kowalski
nameName-Jan
streetStreet
/^[\S]+?[^0-9]+? [0-9a-z]{1,3}(\/[0-9]{1,2})?$/
3-go Maja 32/4
zipcodeZip code
/^[0-9]{2}-[0-9]{3}$/
12-345
cityCity-Warszawa
phonePhone
/^[\(\)\-\+\/ 0-9]+$/
(0-71) 123 456
workphoneWork phone
/^[\(\)\-\+\/ 0-9]+$/
0-71/ 123 456
cellphoneCell phone
/^[\(\)\-\+\/ 0-9]+$/
0 601 602 603
faxFax
/^[\(\)\-\+\/ 0-9]+$/
(0-71) 123 456
emailEmail
/^[^ ]+@[^ ]+$/
test@test.com
paymenttypePayment type-6The field used with the organizers of a group of “Triada” (In the rest of the organizers is not returned).
Possible values ​​3):
6 - Full payment 100%
2 - Standard payment 40%
8 - Advance “Zielona Karta 45%”

Equivalent in MerlinX:
genderGender-Pan
countryCountry-Polska

wishes

Client wishes.

<wishes>
  <type>select</type>
  <desc>
    <data>adjacent rooms pls</data>
    <data>baby cot pls</data>
    <data>close to</data>
    <data>first floor pls</data>
    <data>grandlit pls</data>
    <data>ground floor pls</data>
    <data>handicap.</data>
    <data>highest possible floor pls</data>
    <data>honeymoon</data>
    <data>not groundfloor pls</data>
    <data>quiet situated pls</data>
    <data>room with bath tube pls</data>
    <data>room with shower pls</data>
    <data>separated beds pls</data>
  </desc>
  <values>
    <data>adjacent rooms pls</data>
    <data>baby cot pls</data>
    <data>close to</data>
    <data>first floor pls</data>
    <data>grandlit pls</data>
    <data>ground floor pls</data>
    <data>handicap.</data>
    <data>highest possible floor pls</data>
    <data>honeymoon</data>
    <data>not groundfloor pls</data>
    <data>quiet situated pls</data>
    <data>room with bath tube pls</data>
    <data>room with shower pls</data>
    <data>separated beds pls</data>
  </values>
</wishes>

payment

payment information:

Automatically after a change, fields “sums up” the “rest” should be followed up and recalculated automatically. With offers of “LAST” and with a close date of departure, the field is not for editing and field reservation fee amounts to a total amount for the event.

Fields:

Field nameDescription
reservepay[0][0]The amount of the reservation fee
reservepay[0][1]Date of payment for the reservation fee
prepayment[0][0]The amount of the advance rate
prepayment[0][1]Date of payment to the rate of advance
prepayment[0][2]The amount of rest
prepayment[0][3]Date of payment for the rest
prepayment[0][4]-

Example:

<reservepay>
  <data>
    <data>
      <type>text</type>
      <value>0</value>
    </data>
    <data>
      <type>text</type>
      <value>29-10-10</value>
    </data>
  </data>
</reservepay>
<prepayment>
  <data>
    <data>
      <type>text</type>
      <value>1000</value>
    </data>
    <data>
      <type>hidden</type>
      <value>29-10-2010</value>
    </data>
    <data>
      <type>hidden</type>
      <value>2650</value>
    </data>
    <data>
      <type>hidden</type>
      <value>14-12-2010</value>
    </data>
    <data>
      <type>hidden</type>
      <value>1</value>
    </data>
  </data>
</prepayment>


loyalty

Loyalty programs, equivalent in MerlinX:

add_service

Additional services, equivalent in MerlinX:

WARNING: Selecting a additional service can cause a change in the total price of the trip, and changing the amounts in payment section (payment).
It is recommended to re-check the total price and rates of payment section, by sending action check with selected additional services.

Parameters:

Field namedescription
numberNumber of selected service
allocationAn array assignment of passengers to the service.
Subsequent array indices should include membership number that is assigned to the service.
Participant number corresponds to its position in the list of participants (array Person).

If the fields in allocation are of type hidden, this means that for a given service is not possible to assign the individual tour participants for selected service.
fromDTDate from which to begin service
toDTDate to which the service will last
typeType of Service on MerlinX booking mask
codeCode of Service on MerlinX booking mask
accomodation
shift- (always empty)
lenLength of service in days (the difference between fromDT - toDT)
textDescription of service
excludeIndexCode List (from field code), separated by a comma, or services that can not be booked at the same time to the service
amountAmount of payment

Przykład:

<add_service>
  <data>
    <number>1</number>
    <allocation>
      <data>1</data>
      <data>2</data>
    </allocation>
    <fromDT>220211</fromDT>
    <toDT>020311</toDT>
    <type>V</type>
    <code>GNC_USLUGA< /code>
    <accomodation></accomodation>
    <shift></shift>
    <len>8</len>
    <text>Gwarancja Niezmiennosci Ceny</text>
    <excludeIndex></excludeIndex>
  </data>
</add_service>
3)
NOTE: These values ​​may change. Current list is always returned in the information from the organizer - field “Hints”