CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetTermsAndConditions

Returns the Terms and Conditions 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:

GetTermsAndConditions: Validation Error 1
GetTermsAndConditions: Error - CS Relation could not be resolved.
GetTermsAndConditions: You do not have access rights to this Property (1).
GetTermsAndConditions: You do not have access rights to this Property (2).
GetTermsAndConditions: Could not resolve query (1).
GetTermsAndConditions: Could not resolve query. No Terms have been defined for this Property.
GetTermsAndConditions: Could not resolve query (2).
GetTermsAndConditions: Non-Standard Data Response
GetTermsAndConditions: 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/GetTermsAndConditions"

<?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>
    <GetTermsAndConditions xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetTermsAndConditions>
  </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>
    <GetTermsAndConditionsResponse xmlns="http://xml.ciirus.com/">
      <GetTermsAndConditionsResult>
        <HTMLTerms>string</HTMLTerms>
        <PlainTextTerms>string</PlainTextTerms>
        <CancellationPolicy>string</CancellationPolicy>
        <LocalCharges>string</LocalCharges>
        <ErrorMessage>string</ErrorMessage>
      </GetTermsAndConditionsResult>
    </GetTermsAndConditionsResponse>
  </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>
    <GetTermsAndConditions xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetTermsAndConditions>
  </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>
    <GetTermsAndConditionsResponse xmlns="http://xml.ciirus.com/">
      <GetTermsAndConditionsResult>
        <HTMLTerms>string</HTMLTerms>
        <PlainTextTerms>string</PlainTextTerms>
        <CancellationPolicy>string</CancellationPolicy>
        <LocalCharges>string</LocalCharges>
        <ErrorMessage>string</ErrorMessage>
      </GetTermsAndConditionsResult>
    </GetTermsAndConditionsResponse>
  </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/GetTermsAndConditions?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"?>
<Terms xmlns="http://xml.ciirus.com/">
  <HTMLTerms>string</HTMLTerms>
  <PlainTextTerms>string</PlainTextTerms>
  <CancellationPolicy>string</CancellationPolicy>
  <LocalCharges>string</LocalCharges>
  <ErrorMessage>string</ErrorMessage>
</Terms>

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/GetTermsAndConditions 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"?>
<Terms xmlns="http://xml.ciirus.com/">
  <HTMLTerms>string</HTMLTerms>
  <PlainTextTerms>string</PlainTextTerms>
  <CancellationPolicy>string</CancellationPolicy>
  <LocalCharges>string</LocalCharges>
  <ErrorMessage>string</ErrorMessage>
</Terms>

Parameter	Value
APIUsername:
APIPassword:
PropertyID: