CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetPropertyRatesAndRestrictions

Returns the daily rental rates for specified property (for date bands where the end date >= today)
Note: All daily and weekly rates set in the app are returned as a nightly rate.
Note: Monthly RateSets are NOT Supported via the API.
Note: If 0 rates, this is either defined/not defined by the supplier, or the supplier has selected/unselected use "nightly floor rate" (the wholesale rate)
Note: RateTypes are as follows:

0 - Weekly Rate ((AKA Weekly Retail) rates based per 7 day date range)
1 - Daily ((AKA Nightly Retail) rates based per night)
2 - Floor ((AKA Wholesale) rates based per night)

**Zero rates should not be booked***
Note: This should be used as getting values on an al a carte basis only. This should only be called to verrify rates at the time a guest visits this specific property/is about to book. All Bulk rate updates should use the function "GetAllPropertyRatesAndRestrictionsPerMC"

Pass the following parameters:

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

Error Responses:

GetPropertyRatesAndRestrictions: Validation Error 1
GetPropertyRatesAndRestrictions: Validation Error 2
GetPropertyRatesAndRestrictions: Validation Error 2 - Property has been deleted from the system.
GetPropertyRatesAndRestrictions: Validation Error 3 - Property has been deleted from the system.
GetPropertyRatesAndRestrictions: Error - CS Relation could not be resolved.
GetPropertyRatesAndRestrictions: You do not have access rights to this Property (1).
GetPropertyRatesAndRestrictions: You do not have access rights to this Property (2).
GetPropertyRatesAndRestrictions: Could not resolve MC.
GetPropertyRatesAndRestrictions: Could not resolve query (1)
GetPropertyRatesAndRestrictions: This User does not have permissions for this property.
GetPropertyRatesAndRestrictions: Could not resolve query (2)
GetPropertyRatesAndRestrictions: Could not resolve query (3)
GetPropertyRatesAndRestrictions: Could not resolve query (4)
GetPropertyRatesAndRestrictions: Monthly Rates Not Supported via API. Monthly Rates Set By User. Please contact the Unit Supplier to configure a supported rate type for your channel.
GetPropertyRatesAndRestrictions: Unknown Error

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

<?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>
    <GetPropertyRatesAndRestrictions xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyRatesAndRestrictions>
  </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>
    <GetPropertyRatesAndRestrictionsResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyRatesAndRestrictionsResult>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <MaxNightsStay>int</MaxNightsStay>
          <Rate>decimal</Rate>
          <RateType>string</RateType>
          <AllowedArrivalDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedArrivalDays>
          <AllowedDepartureDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedDepartureDays>
        </Rate>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <MaxNightsStay>int</MaxNightsStay>
          <Rate>decimal</Rate>
          <RateType>string</RateType>
          <AllowedArrivalDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedArrivalDays>
          <AllowedDepartureDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedDepartureDays>
        </Rate>
      </GetPropertyRatesAndRestrictionsResult>
    </GetPropertyRatesAndRestrictionsResponse>
  </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>
    <GetPropertyRatesAndRestrictions xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyRatesAndRestrictions>
  </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>
    <GetPropertyRatesAndRestrictionsResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyRatesAndRestrictionsResult>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <MaxNightsStay>int</MaxNightsStay>
          <Rate>decimal</Rate>
          <RateType>string</RateType>
          <AllowedArrivalDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedArrivalDays>
          <AllowedDepartureDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedDepartureDays>
        </Rate>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <MaxNightsStay>int</MaxNightsStay>
          <Rate>decimal</Rate>
          <RateType>string</RateType>
          <AllowedArrivalDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedArrivalDays>
          <AllowedDepartureDays>
            <Mon>boolean</Mon>
            <Tues>boolean</Tues>
            <Wed>boolean</Wed>
            <Thurs>boolean</Thurs>
            <Fri>boolean</Fri>
            <Sat>boolean</Sat>
            <Sun>boolean</Sun>
          </AllowedDepartureDays>
        </Rate>
      </GetPropertyRatesAndRestrictionsResult>
    </GetPropertyRatesAndRestrictionsResponse>
  </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/GetPropertyRatesAndRestrictions?APIUserName=string&APIPassword=string&PropertyID=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"?>
<ArrayOfRate xmlns="http://xml.ciirus.com/">
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <MaxNightsStay>int</MaxNightsStay>
    <Rate>decimal</Rate>
    <RateType>string</RateType>
    <AllowedArrivalDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedArrivalDays>
    <AllowedDepartureDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedDepartureDays>
  </Rate>
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <MaxNightsStay>int</MaxNightsStay>
    <Rate>decimal</Rate>
    <RateType>string</RateType>
    <AllowedArrivalDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedArrivalDays>
    <AllowedDepartureDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedDepartureDays>
  </Rate>
</ArrayOfRate>

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

APIUserName=string&APIPassword=string&PropertyID=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRate xmlns="http://xml.ciirus.com/">
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <MaxNightsStay>int</MaxNightsStay>
    <Rate>decimal</Rate>
    <RateType>string</RateType>
    <AllowedArrivalDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedArrivalDays>
    <AllowedDepartureDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedDepartureDays>
  </Rate>
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <MaxNightsStay>int</MaxNightsStay>
    <Rate>decimal</Rate>
    <RateType>string</RateType>
    <AllowedArrivalDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedArrivalDays>
    <AllowedDepartureDays>
      <Mon>boolean</Mon>
      <Tues>boolean</Tues>
      <Wed>boolean</Wed>
      <Thurs>boolean</Thurs>
      <Fri>boolean</Fri>
      <Sat>boolean</Sat>
      <Sun>boolean</Sun>
    </AllowedDepartureDays>
  </Rate>
</ArrayOfRate>

Parameter	Value
APIUserName:
APIPassword:
PropertyID: