CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

CancelBooking

This can be used to CancelBooking an existing BookingID to which your user has access.

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required
BookingID (Integer) *Required

Error Responses:

CancelBooking: Validation Error 1
CancelBooking: Error - You do not have rights to cancel a booking. Please contact you CiiRUS technical point of contact for more information.
CancelBooking: Error - It could not be determined if this booking has already been canceled (1).
CancelBooking: Error - It could not be determined if this booking has already been canceled (2).
CancelBooking: Error - It could not be determined if this booking has already been canceled (3).
CancelBooking: Error - It could not be determined if this booking has already been canceled (4).
CancelBooking: Error - This booking may no longer be active on the system. (1).
CancelBooking: Error - This booking may no longer be active on the system. (2).
CancelBooking: Error - This booking may no longer be active on the system. (3).
CancelBooking: Error - You do not have access to this booking
CancelBooking: Error - The propertyID of the specified booking could not be resolved.
CancelBooking: Error - CS Relation could not be resolved.
CancelBooking: Error - Could not resolve the User's relationship to this Property.
CancelBooking: Error - You do not have rights to cancel a booking. This must be enabled by your CiiRUS technical point of contact for this Property Supplier.
CancelBooking: Error - Booking not Cancelled.
CancelBooking: Error - Unkown Error (1)
CancelBooking: Error - Unkown Error (2)

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /XMLadditionalfunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/CancelBooking"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CancelBooking xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
    </CancelBooking>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <CancelBookingResponse xmlns="http://xml.ciirus.com/">
      <CancelBookingResult>string</CancelBookingResult>
    </CancelBookingResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /XMLadditionalfunctions15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CancelBooking xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <BookingID>int</BookingID>
    </CancelBooking>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <CancelBookingResponse xmlns="http://xml.ciirus.com/">
      <CancelBookingResult>string</CancelBookingResult>
    </CancelBookingResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /XMLadditionalfunctions15.025.asmx/CancelBooking?APIUsername=string&APIPassword=string&BookingID=string HTTP/1.1
Host: api.ciirus.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /XMLadditionalfunctions15.025.asmx/CancelBooking HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUsername=string&APIPassword=string&BookingID=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<string xmlns="http://xml.ciirus.com/">string</string>

Parameter	Value
APIUsername:
APIPassword:
BookingID: