CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetPropertyRates

Returns the daily net rates for specified property (for date bands where the end date >= today ONLY).
Note: If the supplier has selected "Use Nightly Floor Rates" this is the wholesale rate. This is different than that nightly floor rate. The API only returns the selected nightly rate per night, regardless of rate types set by the user. If a rate is set as 0.00, this was defined by the user. Please contact the user and request they populate this data. As long as a rateband has been defined (even as 0.00) for the date period of a reservation and the user has set the property to be bookable online, the property can be booked and the quote will be calculated based on the user's defined rates.

Use this function to get a list of the property classes available, along with their ID’s (this ID is used to filter the search results in the GetProperties function)

Pass the following parameters:

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

Error Responses:

GetPropertyRates: Validation Error 1
GetPropertyRates: Validation Error 2 - Property has been deleted from the system.
GetPropertyRates: Validation Error 3 - Property has been deleted from the system.
GetPropertyRates: Validation Error 2
GetPropertyRates: Error - Could not resolve the Property's HostMC
GetPropertyRates: Error - Could not resolve the User's relationship to this Property
GetPropertyRates: Error - Could not Get CSSSAgent RateSetID could not be resolved.
GetPropertyRates: Error - Owners are not directly supported via the API. Please contact CiiRUS to configure a SuperSite Agent.
GetPropertyRates: Error - User has no Relation/permissions to this property.
GetPropertyRates: Error - User has unknown Relations/permissions to this property.
GetPropertyRates: Error - DataSet not Populated 1
GetPropertyRates: Error - No Rate Assigned by user. Please contact the user and request they populate this data.
GetPropertyRates: Error - No RateSet Resolved.
GetPropertyRates: Error - The type of rates for this assigned RateSet could not be determined.
GetPropertyRates: Error - DataSet not Populated 2
GetPropertyRates: 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.
GetPropertyRates: Error - 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 /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/GetPropertyRates"

<?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>
    <GetPropertyRates xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyRates>
  </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>
    <GetPropertyRatesResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyRatesResult>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <DailyRate>decimal</DailyRate>
        </Rate>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <DailyRate>decimal</DailyRate>
        </Rate>
      </GetPropertyRatesResult>
    </GetPropertyRatesResponse>
  </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>
    <GetPropertyRates xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyRates>
  </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>
    <GetPropertyRatesResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyRatesResult>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <DailyRate>decimal</DailyRate>
        </Rate>
        <Rate>
          <FromDate>dateTime</FromDate>
          <ToDate>dateTime</ToDate>
          <MinNightsStay>int</MinNightsStay>
          <DailyRate>decimal</DailyRate>
        </Rate>
      </GetPropertyRatesResult>
    </GetPropertyRatesResponse>
  </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/GetPropertyRates?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>
    <DailyRate>decimal</DailyRate>
  </Rate>
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <DailyRate>decimal</DailyRate>
  </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 /CiirusXML.15.025.asmx/GetPropertyRates 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>
    <DailyRate>decimal</DailyRate>
  </Rate>
  <Rate>
    <FromDate>dateTime</FromDate>
    <ToDate>dateTime</ToDate>
    <MinNightsStay>int</MinNightsStay>
    <DailyRate>decimal</DailyRate>
  </Rate>
</ArrayOfRate>

Parameter	Value
APIUserName:
APIPassword:
PropertyID: