API Definition

Overview

Communication Protocol

The communication protocol between properties and GalapagosGDS API consists of HTTPS (HTTP Secure) transactions with embedded JSON documents. Note the following:

  • Only HTTPS posts to GalapagosGDS’s secure server are supported. Using HTTP will not work (GalapagosGDS API servers are not configured to accept posts over unsecured HTTP).
  • Communication is synchronous -- on the same socket, GalapagosGDS API reads the request and issues a positive or negative response, depending on whether GalapagosGDS API is able to process the request or not.
  • Content-Type of the HTTP Request Header should be: “text/JSON”.
  • Only connecting via our URLs is supported. GalapagosGDS does not support connection directly via IP Address, as this address is subject to change without notice. If the GalapagosGDS partner generally prefers IP Addresses for communication performance reasons, it may consider implementing an address caching strategy to reduce DNS lookups for the URLs. Additionally, if partner whitelists outbound connections, it must do so using a URL pattern rather than an IP range, as GalapagosGDS cannot guarantee a specific IP range / subnet.

Create booking Request (CB RQ)

CB RQ Schema Complete Definition

Legend: O = Optional

Level Element / @Attribute Data Type Number of occur. Description
0 reference_number number 1 Reference number - if booking details is to be updated
0 boat_id number 1 Boat to be booked
0 tour_id number 1 Tour to be booked
0 departure_date date 1 Departure date of the booking
0 agency_id number 1 Agency that is responsible for the booking
0 type string 1 Type of the booking
0 hold_expiration date 1 Hold expiration date
0 adults number 1 Number of adults
0 children number 1 Number of children
0 cabins array 1 An array that hold cabin and its guests
1@cabin_idarrayanycabin_id to hold the cabin data
2@passport_numberstringanyPassport number of the guest
2@first_namestringanyFirst name of the guest
2@middle_namestringanyMiddle name of the guest
2@last_namestringanyLast name of the guest
2@genderstringanyGender of the guest
2@date_of_birthstringanyDate of birth of the guest
2@emailstringanyEmail of the guest
2@phonestringanyPhone number of the guest
2@mobilestringanyMobile number of the guest
2@is_family_or_group_headerstringanyIs the guest is in a group
2@dietary_requirementsstringanyDietary requirements
2@other_requirementsstringanyOther requirements
2@complementary_informationstringanyOther information