CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetPoolHeatSettings

Returns the rules for calculating the cost for PoolHeat on a per property basis.
Note: This function caches responses for 1 minute.

Pass the following parameters:

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

Error Responses:

GetPoolHeatSettings: Validation Error 1
GetPoolHeatSettings: Error - CS Relation could not be resolved.
GetPoolHeatSettings: You do not have access rights to this Property (1).
GetPoolHeatSettings: You do not have access rights to this Property (2).
GetPoolHeatSettings: Could not resolve query.
GetPoolHeatSettings: 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/GetPoolHeatSettings"

<?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>
    <GetPoolHeatSettings xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPoolHeatSettings>
  </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>
    <GetPoolHeatSettingsResponse xmlns="http://xml.ciirus.com/">
      <GetPoolHeatSettingsResult>
        <HasPrivatePool>boolean</HasPrivatePool>
        <PoolHeatable>boolean</PoolHeatable>
        <PoolHeatIncludedInPrice>boolean</PoolHeatIncludedInPrice>
        <DailyCharge>decimal</DailyCharge>
        <MinimumNumberOfDaysToCharge>int</MinimumNumberOfDaysToCharge>
        <ChargeTax1OnPoolHeat>boolean</ChargeTax1OnPoolHeat>
        <ChargeTax2OnPoolHeat>boolean</ChargeTax2OnPoolHeat>
        <ChargeTax3OnPoolHeat>boolean</ChargeTax3OnPoolHeat>
        <ErrorMsg>string</ErrorMsg>
      </GetPoolHeatSettingsResult>
    </GetPoolHeatSettingsResponse>
  </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>
    <GetPoolHeatSettings xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPoolHeatSettings>
  </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>
    <GetPoolHeatSettingsResponse xmlns="http://xml.ciirus.com/">
      <GetPoolHeatSettingsResult>
        <HasPrivatePool>boolean</HasPrivatePool>
        <PoolHeatable>boolean</PoolHeatable>
        <PoolHeatIncludedInPrice>boolean</PoolHeatIncludedInPrice>
        <DailyCharge>decimal</DailyCharge>
        <MinimumNumberOfDaysToCharge>int</MinimumNumberOfDaysToCharge>
        <ChargeTax1OnPoolHeat>boolean</ChargeTax1OnPoolHeat>
        <ChargeTax2OnPoolHeat>boolean</ChargeTax2OnPoolHeat>
        <ChargeTax3OnPoolHeat>boolean</ChargeTax3OnPoolHeat>
        <ErrorMsg>string</ErrorMsg>
      </GetPoolHeatSettingsResult>
    </GetPoolHeatSettingsResponse>
  </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/GetPoolHeatSettings?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"?>
<PoolHeatSettings xmlns="http://xml.ciirus.com/">
  <HasPrivatePool>boolean</HasPrivatePool>
  <PoolHeatable>boolean</PoolHeatable>
  <PoolHeatIncludedInPrice>boolean</PoolHeatIncludedInPrice>
  <DailyCharge>decimal</DailyCharge>
  <MinimumNumberOfDaysToCharge>int</MinimumNumberOfDaysToCharge>
  <ChargeTax1OnPoolHeat>boolean</ChargeTax1OnPoolHeat>
  <ChargeTax2OnPoolHeat>boolean</ChargeTax2OnPoolHeat>
  <ChargeTax3OnPoolHeat>boolean</ChargeTax3OnPoolHeat>
  <ErrorMsg>string</ErrorMsg>
</PoolHeatSettings>

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/GetPoolHeatSettings 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"?>
<PoolHeatSettings xmlns="http://xml.ciirus.com/">
  <HasPrivatePool>boolean</HasPrivatePool>
  <PoolHeatable>boolean</PoolHeatable>
  <PoolHeatIncludedInPrice>boolean</PoolHeatIncludedInPrice>
  <DailyCharge>decimal</DailyCharge>
  <MinimumNumberOfDaysToCharge>int</MinimumNumberOfDaysToCharge>
  <ChargeTax1OnPoolHeat>boolean</ChargeTax1OnPoolHeat>
  <ChargeTax2OnPoolHeat>boolean</ChargeTax2OnPoolHeat>
  <ChargeTax3OnPoolHeat>boolean</ChargeTax3OnPoolHeat>
  <ErrorMsg>string</ErrorMsg>
</PoolHeatSettings>

Parameter	Value
APIUserName:
APIPassword:
PropertyID: