CiirusXML15025


Click here for a complete list of operations.

GetReservationsForAllPropertiesPerMC

Returns a list of reservations per property by MCUserID with depart date >= today ONLY.

Use this function to get a list of the reservations in all properties of the specified MCUserID.

Only reservations where the departure date is greater than or equal to today’s date are returned.
Note: If you need to verify availabilty for a specific set of dates, please use, "IsPropertyAvailable". We also offer the alternate means of obtaiing availability: "GetAOATSPropertyNightlyRoomsToSell", "GetAllPropertyRatesAndRestrictionsPerMC", and "GetReservations" functions.

Note: This Function does NOT support Timeshare Properties.

Note: This Function Caches for 6 hours. This should be used for bulk availability updates only. We encourage one or two times a day updating the cache of these values in your thrid party database, and all other updates be al a carte style as requested by the user.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • MCUserID (Integer)
  • 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:

  • GetReservationsForAllPropertiesPerMC: Validation Error 1
  • GetReservationsForAllPropertiesPerMC: The MCUserID must be greater than 0.
  • GetReservationsForAllPropertiesPerMC: Could not obtain list of MC Properties (1)
  • GetReservationsForAllPropertiesPerMC: Could not obtain list of MC Properties (2)
  • GetReservationsForAllPropertiesPerMC: Could not obtain list of MC Properties (3)
  • GetReservationsForAllPropertiesPerMC: Validation Error 2
  • GetReservationsForAllPropertiesPerMC: Validation Error 2 - Property has been deleted from the system.
  • GetReservationsForAllPropertiesPerMC: Validation Error 3 - Property has been deleted from the system.
  • GetReservationsForAllPropertiesPerMC: Error - This is a Clone of a CalendarSync TimeShare property, but this child is not set as a Timeshare Property.
  • GetReservationsForAllPropertiesPerMC: Error - Could not determine if Property is TimeShare unit.
  • GetReservationsForAllPropertiesPerMC: Timeshare Properties are not supported by this Function.
  • GetReservationsForAllPropertiesPerMC: Error - Could not determine if Property is AOA unit.
  • GetReservationsForAllPropertiesPerMC: Error - Could not get Property AOA category (1).
  • GetReservationsForAllPropertiesPerMC: Error - Could not get Property AOA category (2).
  • GetReservationsForAllPropertiesPerMC: AOA category not set by user (1).
  • GetReservationsForAllPropertiesPerMC: AOA category not set by user (2).
  • GetReservationsForAllPropertiesPerMC: Error - DataSet not Populated
  • GetReservationsForAllPropertiesPerMC: Error - No Images exist for this property at this time. Please contact the user and request they populate this data.
  • GetReservationsForAllPropertiesPerMC: This property contains demo images. Please contact the user and request they populate this data.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUsername:
APIPassword:
MCUserID:
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/GetReservationsForAllPropertiesPerMC"

<?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>
    <GetReservationsForAllPropertiesPerMC xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetReservationsForAllPropertiesPerMC>
  </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>
    <GetReservationsForAllPropertiesPerMCResponse xmlns="http://xml.ciirus.com/">
      <GetReservationsForAllPropertiesPerMCResult>
        <UnitReservations>
          <PropertyID>int</PropertyID>
          <Reservations>
            <Reservations xsi:nil="true" />
            <Reservations xsi:nil="true" />
          </Reservations>
          <ErrorMsg>string</ErrorMsg>
        </UnitReservations>
        <UnitReservations>
          <PropertyID>int</PropertyID>
          <Reservations>
            <Reservations xsi:nil="true" />
            <Reservations xsi:nil="true" />
          </Reservations>
          <ErrorMsg>string</ErrorMsg>
        </UnitReservations>
      </GetReservationsForAllPropertiesPerMCResult>
    </GetReservationsForAllPropertiesPerMCResponse>
  </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>
    <GetReservationsForAllPropertiesPerMC xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
      <xmlMsg>string</xmlMsg>
      <jSonMsg>string</jSonMsg>
    </GetReservationsForAllPropertiesPerMC>
  </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>
    <GetReservationsForAllPropertiesPerMCResponse xmlns="http://xml.ciirus.com/">
      <GetReservationsForAllPropertiesPerMCResult>
        <UnitReservations>
          <PropertyID>int</PropertyID>
          <Reservations>
            <Reservations xsi:nil="true" />
            <Reservations xsi:nil="true" />
          </Reservations>
          <ErrorMsg>string</ErrorMsg>
        </UnitReservations>
        <UnitReservations>
          <PropertyID>int</PropertyID>
          <Reservations>
            <Reservations xsi:nil="true" />
            <Reservations xsi:nil="true" />
          </Reservations>
          <ErrorMsg>string</ErrorMsg>
        </UnitReservations>
      </GetReservationsForAllPropertiesPerMCResult>
    </GetReservationsForAllPropertiesPerMCResponse>
  </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/GetReservationsForAllPropertiesPerMC?APIUsername=string&APIPassword=string&MCUserID=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"?>
<ArrayOfUnitReservations xmlns="http://xml.ciirus.com/">
  <UnitReservations>
    <PropertyID>int</PropertyID>
    <Reservations>
      <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>
    </Reservations>
    <ErrorMsg>string</ErrorMsg>
  </UnitReservations>
  <UnitReservations>
    <PropertyID>int</PropertyID>
    <Reservations>
      <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>
    </Reservations>
    <ErrorMsg>string</ErrorMsg>
  </UnitReservations>
</ArrayOfUnitReservations>

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

APIUsername=string&APIPassword=string&MCUserID=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"?>
<ArrayOfUnitReservations xmlns="http://xml.ciirus.com/">
  <UnitReservations>
    <PropertyID>int</PropertyID>
    <Reservations>
      <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>
    </Reservations>
    <ErrorMsg>string</ErrorMsg>
  </UnitReservations>
  <UnitReservations>
    <PropertyID>int</PropertyID>
    <Reservations>
      <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>
    </Reservations>
    <ErrorMsg>string</ErrorMsg>
  </UnitReservations>
</ArrayOfUnitReservations>