CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

IsPropertyAvailable

Check if stated property has availabilty for chosen dates. Returns True if there is availabity.

Use this function to do a real-time check if the specified property is available.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • PropertyID (integer)
  • ArrivalDate (String, dd MMM yyyy)
  • DepartureDate (String, dd MMM yyyy)



Error Responses:

  • IsPropertyAvailable: Validation Error 1
  • IsPropertyAvailable: Validation Error 2 - Property has been deleted from the system.
  • IsPropertyAvailable: Validation Error 3 - Property has been deleted from the system.
  • IsPropertyAvailable: Validation Error 2
  • IsPropertyAvailable: Error - Property not enabled for online booking. Please contact the supplier to enable this property.
  • IsPropertyAvailable: Error - Invalid arrival or departure date.
  • IsPropertyAvailable: Error - The minimum night stay could not be resolved for this date range.
  • IsPropertyAvailable: Error - The AOA Property Status could not be resolved for this date range.
  • IsPropertyAvailable: Error - DataSet not Populated(A)
  • IsPropertyAvailable: Error - DataSet not Populated(AOA)
  • IsPropertyAvailable: Error - DataSet not Populated
  • IsPropertyAvailable: Error - Unkown Error 1
  • IsPropertyAvailable: Error - Unkown Error 2
  • IsPropertyAvailable: Error - The Allowed Arrival Days Could not be established.
  • IsPropertyAvailable: Error - The Allowed Departure Days Could not be established.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUsername:
APIPassword:
PropertyID:
ArrivalDate:
DepartureDate:

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

<?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>
    <IsPropertyAvailable xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <ArrivalDate>string</ArrivalDate>
      <DepartureDate>string</DepartureDate>
    </IsPropertyAvailable>
  </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>
    <IsPropertyAvailableResponse xmlns="http://xml.ciirus.com/">
      <IsPropertyAvailableResult>boolean</IsPropertyAvailableResult>
    </IsPropertyAvailableResponse>
  </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>
    <IsPropertyAvailable xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
      <ArrivalDate>string</ArrivalDate>
      <DepartureDate>string</DepartureDate>
    </IsPropertyAvailable>
  </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>
    <IsPropertyAvailableResponse xmlns="http://xml.ciirus.com/">
      <IsPropertyAvailableResult>boolean</IsPropertyAvailableResult>
    </IsPropertyAvailableResponse>
  </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/IsPropertyAvailable?APIUsername=string&APIPassword=string&PropertyID=string&ArrivalDate=string&DepartureDate=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"?>
<boolean xmlns="http://xml.ciirus.com/">boolean</boolean>

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

APIUsername=string&APIPassword=string&PropertyID=string&ArrivalDate=string&DepartureDate=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<boolean xmlns="http://xml.ciirus.com/">boolean</boolean>