CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

GetAllReservations

This can be used to return all reservations stored for the property specified. This will include historic actrive reservations only. Cancelled bookings will not be returned.

This function "GetAllReservations" differs from the function "GetReservations" in other CiiRUS API Endpoints.
"GetReservations" - Returns a list of active reservations with depart date >= today for one specified property ONLY.
"GetAllReservations" - This can be used to return all reservations accessable to this API User for All Properties in the account. This will include active reservations with depart date >= today only. Cancelled bookings will not be returned.
Note: This function caches responses for 10 minutes.
-If you are trying to update future availability, you can get more upto date data with the function "GetReservations " offered in an alternate CiiRUS endpoint.
-If you need to verify availabilty for a specific date range, please use, "IsPropertyAvailable ".
Note: Any reservation returned with a BookingID of zero is a system calculated date range of non-availability. This is not a booking for a guest or a BlackOutDate.



Pass the following parameters:

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



Error Responses:

  • CancelBooking: Validation Error 1
  • GetAllReservations: Error - Could not resolve populate dataset
  • GetAllReservations: Error - Could not resolve MinDaysBeforeArrival
  • GetAllReservations: Error - Unknown Error

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUsername:
APIPassword:
xmlMsg:
jSonMsg:

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/GetAllReservations"

<?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>
    <GetAllReservations xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetAllReservations>
  </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>
    <GetAllReservationsResponse xmlns="http://xml.ciirus.com/">
      <GetAllReservationsResult>
        <Reservation>
          <PropertyID>int</PropertyID>
          <BookingID>int</BookingID>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
        </Reservation>
        <Reservation>
          <PropertyID>int</PropertyID>
          <BookingID>int</BookingID>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
        </Reservation>
      </GetAllReservationsResult>
    </GetAllReservationsResponse>
  </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>
    <GetAllReservations xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetAllReservations>
  </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>
    <GetAllReservationsResponse xmlns="http://xml.ciirus.com/">
      <GetAllReservationsResult>
        <Reservation>
          <PropertyID>int</PropertyID>
          <BookingID>int</BookingID>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
        </Reservation>
        <Reservation>
          <PropertyID>int</PropertyID>
          <BookingID>int</BookingID>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
        </Reservation>
      </GetAllReservationsResult>
    </GetAllReservationsResponse>
  </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/GetAllReservations?APIUsername=string&APIPassword=string&xmlMsg=string&jSonMsg=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"?>
<ArrayOfReservation xmlns="http://xml.ciirus.com/">
  <Reservation>
    <PropertyID>int</PropertyID>
    <BookingID>int</BookingID>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
  </Reservation>
  <Reservation>
    <PropertyID>int</PropertyID>
    <BookingID>int</BookingID>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
  </Reservation>
</ArrayOfReservation>

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/GetAllReservations HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUsername=string&APIPassword=string&xmlMsg=string&jSonMsg=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfReservation xmlns="http://xml.ciirus.com/">
  <Reservation>
    <PropertyID>int</PropertyID>
    <BookingID>int</BookingID>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
  </Reservation>
  <Reservation>
    <PropertyID>int</PropertyID>
    <BookingID>int</BookingID>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
  </Reservation>
</ArrayOfReservation>