CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetReservations

Returns a list of reservations with depart date >= today ONLY.

Use this function to get a list of the reservations in the specified property.

Only reservations where the departure date is greater than or equal to today’s date are returned.
Note: This function caches responses for 1 minute. If you need to verify availabilty for a specific date range, please use, "IsPropertyAvailable ".

Note: This Function does NOT support Timeshare Properties.

Pass the following parameters:

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

Error Responses:

GetReservations: Validation Error 1
GetReservations: Validation Error 2
GetReservations: Validation Error 2 - Property has been deleted from the system.
GetReservations: Validation Error 3 - Property has been deleted from the system.
GetReservations: Error - This is a Clone of a CalendarSync TimeShare property, but this child is not set as a Timeshare Property.
GetReservations: Error - Could not determine if Property is TimeShare unit.
GetReservations: Timeshare Properties are not supported by this Function.
GetReservations: Error - Could not determine if Property is AOA unit.
GetReservations: Error - Could not get Property AOA category (1).
GetReservations: Error - Could not get Property AOA category (2).
GetReservations: AOA category not set by user (1).
GetReservations: AOA category not set by user (2).
GetReservations: Error - DataSet not Populated

Test

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

Parameter	Value
APIUsername:
APIPassword:
PropertyID:
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 /CiirusXML.15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/GetReservations"

<?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>
    <GetReservations xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetReservations>
  </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>
    <GetReservationsResponse xmlns="http://xml.ciirus.com/">
      <GetReservationsResult>
        <Reservations>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
          <BookingID>int</BookingID>
          <HasPoolHeat>boolean</HasPoolHeat>
          <GuestName>string</GuestName>
          <specialResponse>string</specialResponse>
        </Reservations>
        <Reservations>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
          <BookingID>int</BookingID>
          <HasPoolHeat>boolean</HasPoolHeat>
          <GuestName>string</GuestName>
          <specialResponse>string</specialResponse>
        </Reservations>
      </GetReservationsResult>
    </GetReservationsResponse>
  </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 /CiirusXML.15.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>
    <GetReservations xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetReservations>
  </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>
    <GetReservationsResponse xmlns="http://xml.ciirus.com/">
      <GetReservationsResult>
        <Reservations>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
          <BookingID>int</BookingID>
          <HasPoolHeat>boolean</HasPoolHeat>
          <GuestName>string</GuestName>
          <specialResponse>string</specialResponse>
        </Reservations>
        <Reservations>
          <ArrivalDate>dateTime</ArrivalDate>
          <DepartureDate>dateTime</DepartureDate>
          <BookingID>int</BookingID>
          <HasPoolHeat>boolean</HasPoolHeat>
          <GuestName>string</GuestName>
          <specialResponse>string</specialResponse>
        </Reservations>
      </GetReservationsResult>
    </GetReservationsResponse>
  </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 /CiirusXML.15.025.asmx/GetReservations?APIUsername=string&APIPassword=string&PropertyID=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"?>
<ArrayOfReservations xmlns="http://xml.ciirus.com/">
  <Reservations>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
    <BookingID>int</BookingID>
    <HasPoolHeat>boolean</HasPoolHeat>
    <GuestName>string</GuestName>
    <specialResponse>string</specialResponse>
  </Reservations>
  <Reservations>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
    <BookingID>int</BookingID>
    <HasPoolHeat>boolean</HasPoolHeat>
    <GuestName>string</GuestName>
    <specialResponse>string</specialResponse>
  </Reservations>
</ArrayOfReservations>

HTTP POST

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

POST /CiirusXML.15.025.asmx/GetReservations HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

APIUsername=string&APIPassword=string&PropertyID=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"?>
<ArrayOfReservations xmlns="http://xml.ciirus.com/">
  <Reservations>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
    <BookingID>int</BookingID>
    <HasPoolHeat>boolean</HasPoolHeat>
    <GuestName>string</GuestName>
    <specialResponse>string</specialResponse>
  </Reservations>
  <Reservations>
    <ArrivalDate>dateTime</ArrivalDate>
    <DepartureDate>dateTime</DepartureDate>
    <BookingID>int</BookingID>
    <HasPoolHeat>boolean</HasPoolHeat>
    <GuestName>string</GuestName>
    <specialResponse>string</specialResponse>
  </Reservations>
</ArrayOfReservations>