Place a booking

Use this function to place a booking. The booking is created with the rate calculated based on the parameters you pass.

• APIUsername (String) *Required
• APIPassword (String) *Required
• BookingDetails Class Object Parameters *Required
  • ArrivalDate (String, dd MMM yyyy) *Required
    Booking arrival date in format ‘dd MMM yyyy’
  • DepartureDate (String, dd MMM yyyy) *Required
    Booking Departure date in format ‘dd MMM yyyy’
  • PropertyID (Integer) *Required
    The CiiRUS PropertyID of the Property you are trying to place a booking for the selected dates.
  • GuestName (String) *Required
    The lead guest name for this reservation.
  • GuestEmailAddress (String) *Required
    The lead guest's e-mail for this reservation.
  • GuestTelephone (String) *Required
    The lead guest's telephone for this reservation.
  • GuestAddress (String) *Required
    The lead guest's address for this reservation. (Billing Address)
  • Array of GuestList Class Objects *Required
    • Name (String) *Required
    • Age (Integer) *Required
  • PoolHeatRequired (Boolean) *Required
  • xmlMsg (String) *Required
    -Pass blank string unless otherwise discussed with your CiiRUS technical point of contact. Below are optional "specialRequest" additional options.

    <specialRequest>
    <UserID>11006</UserID>{If using this message, Required. Replace 11006 with your API user UserID - (refference GetManagementCompanyList fn(x))} 
    <BookingComment>This is a Comment Test</BookingComment>
    </specialRequest>

    Note: Please pass your xmlMsg as a URL encoded string (percentage encoded values only accepted)

  • jSonMsg (String) *Required
    -Pass blank string unless otherwise discussed with your CiiRUS technical point of contact.

• MakeBooking: Validation Error 1
• MakeBooking: Error - You do not have permission to add a booking. Please Contact CiiRUS.
• MakeBooking: Validation Error 2 - Property has been deleted from the system.
• MakeBooking: Validation Error 3 - Property has been deleted from the system.
• MakeBooking: Validation Error 2
• MakeBooking: Error - Property not enabled for online booking. Please contact the supplier to enable this property.
• MakeBooking: Error - Unkown Error 2
• MakeBooking: Error - Arrival Date must be >= today
• MakeBooking: Error - Departure Date must be >= tomorrow
• MakeBooking: Error - Departure Date must be > Arrival Date
• MakeBooking: Error - The User Relation to this property could not be resolved.
• The Guest Name (at index: (i)) exceeded the maximum number of characters allowed (28 chars). This value was truncated.
  (i) = 0 based index possition in array of objects passed to the GuestList Array of objects parameter
• The Lead Guest Name exceeded the maximum number of characters allowed (95 chars). This value was truncated.
• The Guest E-mail exceeded the maximum number of characters allowed (48 chars). This value was truncated.
• The Guest Telephone exceeded the maximum number of characters allowed (32 chars). This value was truncated.
• The Guest Address exceeded the maximum number of characters allowed (75 chars). This value was truncated.
• Another reservation already exists overlapping your selected dates 1
• Another reservation already exists overlapping your selected dates 2
• Another reservation already exists overlapping your selected dates 3
• This property has been deleted.
• Error - Could not Contact CiiRUS Booking Engine.
• Error - Cannot determine if this is an AOA Property.
• Error - Error - Could not resolve AOAcategory.
• Error placing booking
• The booking was not placed
• Error at MakeBooking (Phase (i))
  Note: (i) = integer representing phase in Booking function that an unknown exception occured
• MakeBooking: The booking request does not match minimum night stay requirements set by the inventory supplier. Please book a different property or contact the unit supplier.

Additional Error Messages may be returned. If you recieve an alternate response, and are unsure why, or what it means, please contact your CiiRUS technical point of contact for more information.

CiiRUS offers two booking methods. This is the simpler (prefered) method. If this function does not meet the needs of your integration, please contact CiiRUS specifically outlining the lacking functionality. The alternate Booking method may provide this functionality, or the request may not yet be supported via the API. Either way, we would like to hear your feedback so that we can work towards a solution for all API partners for such matters.

Note: All input objects require an instance of the object is specified. For null or nothing, blank values of (String :"" or int: 0) respective datatypes should be included. For the Guestlist object, ages are required only for children (under 18). If no age is supplied, please pass -1 for the age value. THe GuestLIst array with 0 guest objects is a valid input, but the array of guests must be specified.