CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetExtras

Returns a list of both manditory and optional extras with the rules for calculating the extras cost. Extras apply on a per property basis.
-Manditory Extras are extras that are required by the MC with each booking for the specified property unless otherwise agreed/contracted. The "MakeBooking" function adds these automatically. The "AddBooking" function requires these are added using this function.
-Optional Extras are extras that are optional additions to each booking for the specified property unless otherwise agreed/contracted. The "MakeBooking" does not accept optional extras, but this function can be used after the reservation has been placed to add them by BookingID. The "AddBooking" function requires these are added using this function is specified by the guest.
Note: This function caches responses for 1 minute.

Pass the following parameters:

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

Error Responses:

GetExtras: Validation Error 1
GetExtras: Error - CS Relation could not be resolved.
GetExtras: You do not have access rights to this Property (1).
GetExtras: You do not have access rights to this Property (2).
GetExtras: Error - Could not determine Host MC.
GetExtras: This query could not be resolved.
GetExtras: No Extras Configured for this Property.
GetExtras: 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/GetExtras"

<?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>
    <GetExtras xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetExtras>
  </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>
    <GetExtrasResponse xmlns="http://xml.ciirus.com/">
      <GetExtrasResult>
        <RowCount>int</RowCount>
        <Extras>
          <PropertyExtras>
            <PropertyID>int</PropertyID>
            <ItemCode>string</ItemCode>
            <ItemDescription>string</ItemDescription>
            <FlatFee>boolean</FlatFee>
            <FlatFeeAmount>decimal</FlatFeeAmount>
            <DailyFee>boolean</DailyFee>
            <DailyFeeAmount>decimal</DailyFeeAmount>
            <PercentageFee>boolean</PercentageFee>
            <Percentage>decimal</Percentage>
            <Mandatory>boolean</Mandatory>
            <MinimumCharge>decimal</MinimumCharge>
            <ChargeTax1>boolean</ChargeTax1>
            <ChargeTax2>boolean</ChargeTax2>
            <ChargeTax3>boolean</ChargeTax3>
          </PropertyExtras>
          <PropertyExtras>
            <PropertyID>int</PropertyID>
            <ItemCode>string</ItemCode>
            <ItemDescription>string</ItemDescription>
            <FlatFee>boolean</FlatFee>
            <FlatFeeAmount>decimal</FlatFeeAmount>
            <DailyFee>boolean</DailyFee>
            <DailyFeeAmount>decimal</DailyFeeAmount>
            <PercentageFee>boolean</PercentageFee>
            <Percentage>decimal</Percentage>
            <Mandatory>boolean</Mandatory>
            <MinimumCharge>decimal</MinimumCharge>
            <ChargeTax1>boolean</ChargeTax1>
            <ChargeTax2>boolean</ChargeTax2>
            <ChargeTax3>boolean</ChargeTax3>
          </PropertyExtras>
        </Extras>
        <ErrorMsg>string</ErrorMsg>
      </GetExtrasResult>
    </GetExtrasResponse>
  </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>
    <GetExtras xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetExtras>
  </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>
    <GetExtrasResponse xmlns="http://xml.ciirus.com/">
      <GetExtrasResult>
        <RowCount>int</RowCount>
        <Extras>
          <PropertyExtras>
            <PropertyID>int</PropertyID>
            <ItemCode>string</ItemCode>
            <ItemDescription>string</ItemDescription>
            <FlatFee>boolean</FlatFee>
            <FlatFeeAmount>decimal</FlatFeeAmount>
            <DailyFee>boolean</DailyFee>
            <DailyFeeAmount>decimal</DailyFeeAmount>
            <PercentageFee>boolean</PercentageFee>
            <Percentage>decimal</Percentage>
            <Mandatory>boolean</Mandatory>
            <MinimumCharge>decimal</MinimumCharge>
            <ChargeTax1>boolean</ChargeTax1>
            <ChargeTax2>boolean</ChargeTax2>
            <ChargeTax3>boolean</ChargeTax3>
          </PropertyExtras>
          <PropertyExtras>
            <PropertyID>int</PropertyID>
            <ItemCode>string</ItemCode>
            <ItemDescription>string</ItemDescription>
            <FlatFee>boolean</FlatFee>
            <FlatFeeAmount>decimal</FlatFeeAmount>
            <DailyFee>boolean</DailyFee>
            <DailyFeeAmount>decimal</DailyFeeAmount>
            <PercentageFee>boolean</PercentageFee>
            <Percentage>decimal</Percentage>
            <Mandatory>boolean</Mandatory>
            <MinimumCharge>decimal</MinimumCharge>
            <ChargeTax1>boolean</ChargeTax1>
            <ChargeTax2>boolean</ChargeTax2>
            <ChargeTax3>boolean</ChargeTax3>
          </PropertyExtras>
        </Extras>
        <ErrorMsg>string</ErrorMsg>
      </GetExtrasResult>
    </GetExtrasResponse>
  </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/GetExtras?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"?>
<GetExtrasResult xmlns="http://xml.ciirus.com/">
  <RowCount>int</RowCount>
  <Extras>
    <PropertyExtras>
      <PropertyID>int</PropertyID>
      <ItemCode>string</ItemCode>
      <ItemDescription>string</ItemDescription>
      <FlatFee>boolean</FlatFee>
      <FlatFeeAmount>decimal</FlatFeeAmount>
      <DailyFee>boolean</DailyFee>
      <DailyFeeAmount>decimal</DailyFeeAmount>
      <PercentageFee>boolean</PercentageFee>
      <Percentage>decimal</Percentage>
      <Mandatory>boolean</Mandatory>
      <MinimumCharge>decimal</MinimumCharge>
      <ChargeTax1>boolean</ChargeTax1>
      <ChargeTax2>boolean</ChargeTax2>
      <ChargeTax3>boolean</ChargeTax3>
    </PropertyExtras>
    <PropertyExtras>
      <PropertyID>int</PropertyID>
      <ItemCode>string</ItemCode>
      <ItemDescription>string</ItemDescription>
      <FlatFee>boolean</FlatFee>
      <FlatFeeAmount>decimal</FlatFeeAmount>
      <DailyFee>boolean</DailyFee>
      <DailyFeeAmount>decimal</DailyFeeAmount>
      <PercentageFee>boolean</PercentageFee>
      <Percentage>decimal</Percentage>
      <Mandatory>boolean</Mandatory>
      <MinimumCharge>decimal</MinimumCharge>
      <ChargeTax1>boolean</ChargeTax1>
      <ChargeTax2>boolean</ChargeTax2>
      <ChargeTax3>boolean</ChargeTax3>
    </PropertyExtras>
  </Extras>
  <ErrorMsg>string</ErrorMsg>
</GetExtrasResult>

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/GetExtras 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"?>
<GetExtrasResult xmlns="http://xml.ciirus.com/">
  <RowCount>int</RowCount>
  <Extras>
    <PropertyExtras>
      <PropertyID>int</PropertyID>
      <ItemCode>string</ItemCode>
      <ItemDescription>string</ItemDescription>
      <FlatFee>boolean</FlatFee>
      <FlatFeeAmount>decimal</FlatFeeAmount>
      <DailyFee>boolean</DailyFee>
      <DailyFeeAmount>decimal</DailyFeeAmount>
      <PercentageFee>boolean</PercentageFee>
      <Percentage>decimal</Percentage>
      <Mandatory>boolean</Mandatory>
      <MinimumCharge>decimal</MinimumCharge>
      <ChargeTax1>boolean</ChargeTax1>
      <ChargeTax2>boolean</ChargeTax2>
      <ChargeTax3>boolean</ChargeTax3>
    </PropertyExtras>
    <PropertyExtras>
      <PropertyID>int</PropertyID>
      <ItemCode>string</ItemCode>
      <ItemDescription>string</ItemDescription>
      <FlatFee>boolean</FlatFee>
      <FlatFeeAmount>decimal</FlatFeeAmount>
      <DailyFee>boolean</DailyFee>
      <DailyFeeAmount>decimal</DailyFeeAmount>
      <PercentageFee>boolean</PercentageFee>
      <Percentage>decimal</Percentage>
      <Mandatory>boolean</Mandatory>
      <MinimumCharge>decimal</MinimumCharge>
      <ChargeTax1>boolean</ChargeTax1>
      <ChargeTax2>boolean</ChargeTax2>
      <ChargeTax3>boolean</ChargeTax3>
    </PropertyExtras>
  </Extras>
  <ErrorMsg>string</ErrorMsg>
</GetExtrasResult>

Parameter	Value
APIUserName:
APIPassword:
PropertyID: