Home > Channel Management > RMS Online API > 1.6 Booking Cancel Request and Response

1.6 Booking Cancel Request and Response

Overview

This article will take you through the elements of a Booking Cancel Request and Response.

Feature

The Booking Cancel request allows you to cancel a specific online booking.

Request Elements

Element Name   Element Description Attributes Required
RMSBookingCancelRQ   Root element.  Containing the request for a booking cancellation.   Yes
AgentId RMSBookingCancelRQ The agent code of the RMS agent enquiring.   Yes
RMSClientId RMSBookingCancelRQ The RMS Client Id of the property being searched.   Yes
BookingReference RMSBookingCancelRQ The RMS Booking ID of the booking to cancel.   Yes
Test RMSBookingCancelRQ If this element is present, the booking will be cancelled from the training database of the requesting property.   No

Example Request

<RMSBookingCancelRQ>
  <AgentId>1</AgentId>
  <RMSClientId>3038</RMSClientId>
  <BookingReference>1897119</BookingReference>
</RMSBookingCancelRQ>

Response Elements

Element Name Parent Element Element Description Attributes
RMSBookingCancelRS   Root element.  Containing the response for a booking cancellation.  
Success RMSBookingCancelRS The element returned if cancellation was successful.  
Error RMSBookingCancelRS The element returned if cancellation was unsuccessful.  
Id Error The Id of the error.  
Message Error The description of the error.  

Example Response - Successful

<RMSBookingCancelRS>
  <Success />
</RMSBookingCancelRS>

Example Response - Failed

<RMSBookingCancelRS>
  <Error>
    <Id>-601</Id>
    <Message>Error Message.</Message>
  </Error>
|</RMSBookingCancelRS>

Related

RMS Online API
This guide provides an overview of product features and related technologies. In addition, it contains recommendations on best practices, tutorials for getting started, and troubleshooting information for common situations.
1.1 Property Details Request and Response
This article will take you through the elements of a Property Details Request and Response.
1.2 Room Type Details Request and Response
This article will take you through the elements of a Room Type Request and Response.
1.3 Availability Rates Request and Response
This article will take you through the elements of a Availability / Rates Request and Response.
1.4 Booking Quote Request and Response
This article will take you through the elements of a Booking Quote Request and Response.
1.5 Booking Request and Response
This article will take you through the elements of a Booking Request and Response.
2.1 Terms and Definitions
This article will take you through the terms and definitions of the RMS Online Schema.
RMS API Technical Information
This article will provide your web page developer the technical information required to write to the RMS API Schema.



 

You must to post a comment.
Last modified
09:34, 15 May 2015

Tags

Classifications

This page has no classifications.
For support assistance with this article, click once on the Live Support image below
 
btn_LS_on.png