CiirusXMLAdditionalFunctions15025


Click here for a complete list of operations.

AddBlackoutDates

Adds a Black Out Date for a given property and date range

Use this function to block off calendar days without placing a reservation. This holds no financials and schedules no cleans. This is only for a period of non-availability.
Note:This is ONLY an (MC/PM/Native) User accessable function.
Note: A Response of 0 would only occur if an unhanddled error occured.
Note: No date validation occurs as no responsability to a guest is implied by a blackout date. This can be added overlapping reservations already placed, but will prevent future reservations from being committed to a property's availability calendar.
Note: A Response of -1 would only occur if these dates have already been booked.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • MCUserID (Integer)
  • PropertyID (Integer)
  • GuestName (String)
  • dteArrive (String - dd MMM yyyy)
  • dteDepart (String - dd MMM yyyy)



Error Responses:

  • AddBlackoutDates: Validation Error 1
  • AddBlackoutDates: Validation Error 2 - This is ONLY an (MC/PM/Native) User accessable function.
  • AddBlackoutDates: Error - CS Relation could not be resolved.
  • AddBlackoutDates: Error - Availability for this property could not be determined.
  • AddBlackoutDates: Error - Could not resolve the MC for the property.
  • AddBlackoutDates: Error - The Black Out Date was not added.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
APIUserName:
APIPassword:
MCUserID:
PropertyID:
GuestName:
dteArrive:
dteDepart:

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

<?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>
    <AddBlackoutDates xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
      <PropertyID>int</PropertyID>
      <GuestName>string</GuestName>
      <dteArrive>dateTime</dteArrive>
      <dteDepart>dateTime</dteDepart>
    </AddBlackoutDates>
  </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>
    <AddBlackoutDatesResponse xmlns="http://xml.ciirus.com/">
      <AddBlackoutDatesResult>int</AddBlackoutDatesResult>
    </AddBlackoutDatesResponse>
  </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>
    <AddBlackoutDates xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <MCUserID>int</MCUserID>
      <PropertyID>int</PropertyID>
      <GuestName>string</GuestName>
      <dteArrive>dateTime</dteArrive>
      <dteDepart>dateTime</dteDepart>
    </AddBlackoutDates>
  </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>
    <AddBlackoutDatesResponse xmlns="http://xml.ciirus.com/">
      <AddBlackoutDatesResult>int</AddBlackoutDatesResult>
    </AddBlackoutDatesResponse>
  </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/AddBlackoutDates?APIUserName=string&APIPassword=string&MCUserID=string&PropertyID=string&GuestName=string&dteArrive=string&dteDepart=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"?>
<int xmlns="http://xml.ciirus.com/">int</int>

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

APIUserName=string&APIPassword=string&MCUserID=string&PropertyID=string&GuestName=string&dteArrive=string&dteDepart=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

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