CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetAOATSPropertyNightlyRoomsToSell

Returns the number of rooms in the AOA category, the bookings placed, and the rooms available per day. Availability for Timeshare units is managed on a per channel basis, usually by the CiiRUS system.

Note: This function is limited to ranges of nights between 0 and 30 inclusive.

Use this function to get quanitity of rooms to sell or sold per night for a specified date range

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required
PropertyID (integer) *Required
MinimumDateInRange (String, dd MMM yyyy) *Required
MaximumDateInRange (String, dd MMM yyyy) *Required

Error Responses:

GetAOATSPropertyNightlyRoomsToSell: Validation Error 1
GetAOATSPropertyNightlyRoomsToSell: Validation Error 2 - Property has been deleted from the system.
GetAOATSPropertyNightlyRoomsToSell: Validation Error 3 - Property has been deleted from the system.
GetAOATSPropertyNightlyRoomsToSell: Validation Error 2
GetAOATSPropertyNightlyRoomsToSell: Error - Unkown Error 2
GetAOATSPropertyNightlyRoomsToSell: Error - Property not enabled for online booking. Please contact the supplier to enable this property.
GetAOATSPropertyNightlyRoomsToSell: Error - Departure Date must be at least 1 night after the Minimum Date
GetAOATSPropertyNightlyRoomsToSell: Error - Invalid days in range (AOA)
GetAOATSPropertyNightlyRoomsToSell: Error - Departure Date must be at least 1 night after the Minimum Date, and Minimum Date must be greater than or equal to Today's date.
GetAOATSPropertyNightlyRoomsToSell: Error - Requested Availability range too large. (Max Range: 30 nights)
GetAOATSPropertyNightlyRoomsToSell: Error - This Function is only for use with AOA or TimeShare properties
GetAOATSPropertyNightlyRoomsToSell: Error - DataSet not Populated(AOA)
GetAOATSPropertyNightlyRoomsToSell: Error - DataSet not Populated (AOA - NumRoomsInCat)(1)
GetAOATSPropertyNightlyRoomsToSell: Error - DataSet not Populated (AOA - NumRoomsInCat)(2)
GetAOATSPropertyNightlyRoomsToSell: Error - invalid propertyID

Note: AvailabilitySignature is a returned integer value. When converted from an integer to binary, the binary is a (bit) true/false representation of availability. If this is used, if the first char is a 0 you must trim the first char in the string (the 0's place of the binary string): this will always be 0 and if not trimmed would skew your index. The 1's place in the binary string is your MinimumDateInRange. The only case the first 0 should mean anything (not be trimmed), is if the AvailabilitySignature before it is converted to binary is equal to 0. This would mean that no availability could be determeined for your requested range. Trim the 1 char at the last possition in the string if the remaining count of chars in the string is greater than your requested number of nights. This removes what acts as a place holder to ensure the binary string includes a bit for each day in range; otherwise, if the range ended in 0(s) these would not be part of the binary string generated from the integer of the AailabilitySignature.
-Convert integer to binary and trim first char if 0 and last chars of binary string if length of string is greater than nights in range by one. This is if the property has avialability per day starting at the 0 index night object (the StartDate value) forward in time to the end of the range. Note: Use StartDate to set the beginning date for your loop to the end of range. Use the DayOffset value of each night object to add that number of days to the StartDate to get the date for that night. (StartDate + DayOffset, interval in days)

Test

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

Parameter	Value
APIUsername:
APIPassword:
PropertyID:
MinimumDateInRange:
MaximumDateInRange:

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

<?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>
    <GetAOATSPropertyNightlyRoomsToSell xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <MinimumDateInRange>string</MinimumDateInRange>
      <MaximumDateInRange>string</MaximumDateInRange>
    </GetAOATSPropertyNightlyRoomsToSell>
  </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>
    <GetAOATSPropertyNightlyRoomsToSellResponse xmlns="http://xml.ciirus.com/">
      <GetAOATSPropertyNightlyRoomsToSellResult>
        <MaxRoomsInCategory>int</MaxRoomsInCategory>
        <ResponseDateTime>dateTime</ResponseDateTime>
        <ErrorMsgs>string</ErrorMsgs>
        <AvailabilitySignature>int</AvailabilitySignature>
        <PropertyID>int</PropertyID>
        <StartDate>dateTime</StartDate>
        <Nights>
          <night>
            <DayOffset>int</DayOffset>
            <RoomsInCategory>int</RoomsInCategory>
            <RoomsSold>int</RoomsSold>
            <RoomsAvailable>int</RoomsAvailable>
          </night>
          <night>
            <DayOffset>int</DayOffset>
            <RoomsInCategory>int</RoomsInCategory>
            <RoomsSold>int</RoomsSold>
            <RoomsAvailable>int</RoomsAvailable>
          </night>
        </Nights>
      </GetAOATSPropertyNightlyRoomsToSellResult>
    </GetAOATSPropertyNightlyRoomsToSellResponse>
  </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>
    <GetAOATSPropertyNightlyRoomsToSell xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <MinimumDateInRange>string</MinimumDateInRange>
      <MaximumDateInRange>string</MaximumDateInRange>
    </GetAOATSPropertyNightlyRoomsToSell>
  </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>
    <GetAOATSPropertyNightlyRoomsToSellResponse xmlns="http://xml.ciirus.com/">
      <GetAOATSPropertyNightlyRoomsToSellResult>
        <MaxRoomsInCategory>int</MaxRoomsInCategory>
        <ResponseDateTime>dateTime</ResponseDateTime>
        <ErrorMsgs>string</ErrorMsgs>
        <AvailabilitySignature>int</AvailabilitySignature>
        <PropertyID>int</PropertyID>
        <StartDate>dateTime</StartDate>
        <Nights>
          <night>
            <DayOffset>int</DayOffset>
            <RoomsInCategory>int</RoomsInCategory>
            <RoomsSold>int</RoomsSold>
            <RoomsAvailable>int</RoomsAvailable>
          </night>
          <night>
            <DayOffset>int</DayOffset>
            <RoomsInCategory>int</RoomsInCategory>
            <RoomsSold>int</RoomsSold>
            <RoomsAvailable>int</RoomsAvailable>
          </night>
        </Nights>
      </GetAOATSPropertyNightlyRoomsToSellResult>
    </GetAOATSPropertyNightlyRoomsToSellResponse>
  </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/GetAOATSPropertyNightlyRoomsToSell?APIUsername=string&APIPassword=string&PropertyID=string&MinimumDateInRange=string&MaximumDateInRange=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"?>
<RoomsToSellResponse xmlns="http://xml.ciirus.com/">
  <MaxRoomsInCategory>int</MaxRoomsInCategory>
  <ResponseDateTime>dateTime</ResponseDateTime>
  <ErrorMsgs>string</ErrorMsgs>
  <AvailabilitySignature>int</AvailabilitySignature>
  <PropertyID>int</PropertyID>
  <StartDate>dateTime</StartDate>
  <Nights>
    <night>
      <DayOffset>int</DayOffset>
      <RoomsInCategory>int</RoomsInCategory>
      <RoomsSold>int</RoomsSold>
      <RoomsAvailable>int</RoomsAvailable>
    </night>
    <night>
      <DayOffset>int</DayOffset>
      <RoomsInCategory>int</RoomsInCategory>
      <RoomsSold>int</RoomsSold>
      <RoomsAvailable>int</RoomsAvailable>
    </night>
  </Nights>
</RoomsToSellResponse>

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

APIUsername=string&APIPassword=string&PropertyID=string&MinimumDateInRange=string&MaximumDateInRange=string

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

<?xml version="1.0" encoding="utf-8"?>
<RoomsToSellResponse xmlns="http://xml.ciirus.com/">
  <MaxRoomsInCategory>int</MaxRoomsInCategory>
  <ResponseDateTime>dateTime</ResponseDateTime>
  <ErrorMsgs>string</ErrorMsgs>
  <AvailabilitySignature>int</AvailabilitySignature>
  <PropertyID>int</PropertyID>
  <StartDate>dateTime</StartDate>
  <Nights>
    <night>
      <DayOffset>int</DayOffset>
      <RoomsInCategory>int</RoomsInCategory>
      <RoomsSold>int</RoomsSold>
      <RoomsAvailable>int</RoomsAvailable>
    </night>
    <night>
      <DayOffset>int</DayOffset>
      <RoomsInCategory>int</RoomsInCategory>
      <RoomsSold>int</RoomsSold>
      <RoomsAvailable>int</RoomsAvailable>
    </night>
  </Nights>
</RoomsToSellResponse>