CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetAllPropertyRatesAndRestrictionsPerMC

Returns the daily rental rates for all propeties of a specified MCUserID (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 Function Caches for 6 hours. This should be used for bulk rate 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) *Required
APIPassword (String) *Required
MCUserID (Integer) *Required

Error Responses:

GetAllPropertyRatesAndRestrictionsPerMC: Validation Error 1
GetPropertyRatesAndRestrictions: The MCUserID must be greater than 0.
GetPropertyRatesAndRestrictions: Could not obtain list of MC Properties (1)
GetPropertyRatesAndRestrictions: Could not obtain list of MC Properties (2)
GetPropertyRatesAndRestrictions: Could not obtain list of MC Properties (3)
GetPropertyRatesAndRestrictions: MC has No Configured Properties
GetAllPropertyRatesAndRestrictionsPerMC: Error - CS Relation could not be resolved.
GetAllPropertyRatesAndRestrictionsPerMC: Could not resolve MC.
GetAllPropertyRatesAndRestrictionsPerMC: Could not resolve query (1)
GetAllPropertyRatesAndRestrictionsPerMC: This User does not have permissions for this property.
GetPropertyRatesAndRestrictions: Validation Error 2 - Property has been deleted from the system.
GetAllPropertyRatesAndRestrictionsPerMC: Could not resolve query (2)
GetAllPropertyRatesAndRestrictionsPerMC: Could not resolve query (3)
GetAllPropertyRatesAndRestrictionsPerMC: Could not resolve query (4)
GetAllPropertyRatesAndRestrictionsPerMC: Unknown Error
GetPropertyRatesAndRestrictions: No response objects added to response object

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

<?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>
    <GetAllPropertyRatesAndRestrictionsPerMC xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
    </GetAllPropertyRatesAndRestrictionsPerMC>
  </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>
    <GetAllPropertyRatesAndRestrictionsPerMCResponse xmlns="http://xml.ciirus.com/">
      <GetAllPropertyRatesAndRestrictionsPerMCResult>
        <Rates>
          <PropertyID>int</PropertyID>
          <PropertyRates>
            <Rate xsi:nil="true" />
            <Rate xsi:nil="true" />
          </PropertyRates>
          <ErrorMsg>string</ErrorMsg>
        </Rates>
        <Rates>
          <PropertyID>int</PropertyID>
          <PropertyRates>
            <Rate xsi:nil="true" />
            <Rate xsi:nil="true" />
          </PropertyRates>
          <ErrorMsg>string</ErrorMsg>
        </Rates>
      </GetAllPropertyRatesAndRestrictionsPerMCResult>
    </GetAllPropertyRatesAndRestrictionsPerMCResponse>
  </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>
    <GetAllPropertyRatesAndRestrictionsPerMC xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
    </GetAllPropertyRatesAndRestrictionsPerMC>
  </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>
    <GetAllPropertyRatesAndRestrictionsPerMCResponse xmlns="http://xml.ciirus.com/">
      <GetAllPropertyRatesAndRestrictionsPerMCResult>
        <Rates>
          <PropertyID>int</PropertyID>
          <PropertyRates>
            <Rate xsi:nil="true" />
            <Rate xsi:nil="true" />
          </PropertyRates>
          <ErrorMsg>string</ErrorMsg>
        </Rates>
        <Rates>
          <PropertyID>int</PropertyID>
          <PropertyRates>
            <Rate xsi:nil="true" />
            <Rate xsi:nil="true" />
          </PropertyRates>
          <ErrorMsg>string</ErrorMsg>
        </Rates>
      </GetAllPropertyRatesAndRestrictionsPerMCResult>
    </GetAllPropertyRatesAndRestrictionsPerMCResponse>
  </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/GetAllPropertyRatesAndRestrictionsPerMC?APIUserName=string&APIPassword=string&MCUserID=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"?>
<ArrayOfRates xmlns="http://xml.ciirus.com/">
  <Rates>
    <PropertyID>int</PropertyID>
    <PropertyRates>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
    </PropertyRates>
    <ErrorMsg>string</ErrorMsg>
  </Rates>
  <Rates>
    <PropertyID>int</PropertyID>
    <PropertyRates>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
    </PropertyRates>
    <ErrorMsg>string</ErrorMsg>
  </Rates>
</ArrayOfRates>

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

APIUserName=string&APIPassword=string&MCUserID=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRates xmlns="http://xml.ciirus.com/">
  <Rates>
    <PropertyID>int</PropertyID>
    <PropertyRates>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
    </PropertyRates>
    <ErrorMsg>string</ErrorMsg>
  </Rates>
  <Rates>
    <PropertyID>int</PropertyID>
    <PropertyRates>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
      <Rate>
        <FromDate>dateTime</FromDate>
        <ToDate>dateTime</ToDate>
        <MinNightsStay>int</MinNightsStay>
        <MaxNightsStay>int</MaxNightsStay>
        <Rate>decimal</Rate>
        <RateType>string</RateType>
        <AllowedArrivalDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <AllowedDepartureDays d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </Rate>
    </PropertyRates>
    <ErrorMsg>string</ErrorMsg>
  </Rates>
</ArrayOfRates>

Parameter	Value
APIUserName:
APIPassword:
MCUserID: