CiirusXMLAdditionalFunctions15025 Web Service

CiirusXMLAdditionalFunctions15025

Click here for a complete list of operations.

GetPropertyPermissions

Returns the PropertyPermissions of the propertyID passed tothis function relative to your API User.

Use this function to get the permissions and/or the relationship settings of this Property defined in the CiiRUS system relative to your API User.

Pass the following parameters:

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

Error Responses:

GetPropertyPermissions: Validation Error 1
Error - Invalid PropertyID
Error (1000) The MC could not be determined for this property.
Error (1001) This property has been orphaned, and does not have an MC.
Error (1010) No agent relation is configured between the supplier and the agent. Please contact Ciirus.
Error (1011) Could not resolve agent relation. Please contact Ciirus.
Error (1012) This property has been deleted. Please contact the inventory supplier.
Error (1012-CS) This property has been deleted. Please contact the inventory supplier.
Error (1013) It could not be determined if this property is a CalendarSync Clone.
Error (2000) It could not be determined if this property is a CalendarSync Clone.
Warning - No AOA category has been assigned to this property. This inventory cannot not be booked. Please contact the supplier.
Error (3000) It could not be determined if this property is a AOA Property.
Error (4000) Home owner accounts are not directly supported by the API. Please contact CiiRUS to set up a SuperSite User.
Error (5000) The Management Company has not enabled this property for your user.
Error (6000) You have not enabled these properties to accept them into your feed. Please log into the Windows application to complete this action.
Error (7000) The MC has enabled the property for this API User, but you have not accepted this property in the SuperSites area of the CiiRUS windows application.
Error (8000) The MC may have disabled the property from the feed. The MC user for this property has not enabled this property for your feed, but you have accepted this property in the SuperSites area of the CiiRUS windows application.
Error (9000) Too few records exist relating this Property to your user. Please contact the supplier to configure this property for your channel.
Error (10,000) Error determining Agent Relationship.
Error (11,000) Too many records exist relating this Property to your user. Please contact Ciirus.
Error (12,000) This is a Clone of a CalendarSync TimeShare property, but this child is not set as a Timeshare Property.
Error (13,000) Could not determine if Property is TimeShare unit.
Error (14000) This is a Clone of a CalendarSync property, but this child is set as a Timeshare Property and not the Master.
Error (15000) The MC may have disabled the clone property from the feed. The MC user for this property has not enabled this property for your feed, but you have accepted this property in the SuperSites area of the CiiRUS windows application.

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

<?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>
    <GetPropertyPermissions xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyPermissions>
  </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>
    <GetPropertyPermissionsResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyPermissionsResult>
        <PropertyID>int</PropertyID>
        <MCEnableProperty>boolean</MCEnableProperty>
        <AgentEnableProperty>boolean</AgentEnableProperty>
        <AgentUserID>int</AgentUserID>
        <MCUserID>int</MCUserID>
        <NativeProperty>boolean</NativeProperty>
        <CalendarSyncProperty>boolean</CalendarSyncProperty>
        <AOAProperty>boolean</AOAProperty>
        <ErrorMsg>string</ErrorMsg>
        <TimeShare>boolean</TimeShare>
        <OnlineBookingAllowed>boolean</OnlineBookingAllowed>
      </GetPropertyPermissionsResult>
    </GetPropertyPermissionsResponse>
  </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>
    <GetPropertyPermissions xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetPropertyPermissions>
  </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>
    <GetPropertyPermissionsResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyPermissionsResult>
        <PropertyID>int</PropertyID>
        <MCEnableProperty>boolean</MCEnableProperty>
        <AgentEnableProperty>boolean</AgentEnableProperty>
        <AgentUserID>int</AgentUserID>
        <MCUserID>int</MCUserID>
        <NativeProperty>boolean</NativeProperty>
        <CalendarSyncProperty>boolean</CalendarSyncProperty>
        <AOAProperty>boolean</AOAProperty>
        <ErrorMsg>string</ErrorMsg>
        <TimeShare>boolean</TimeShare>
        <OnlineBookingAllowed>boolean</OnlineBookingAllowed>
      </GetPropertyPermissionsResult>
    </GetPropertyPermissionsResponse>
  </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/GetPropertyPermissions?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"?>
<PropertyPermissions xmlns="http://xml.ciirus.com/">
  <PropertyID>int</PropertyID>
  <MCEnableProperty>boolean</MCEnableProperty>
  <AgentEnableProperty>boolean</AgentEnableProperty>
  <AgentUserID>int</AgentUserID>
  <MCUserID>int</MCUserID>
  <NativeProperty>boolean</NativeProperty>
  <CalendarSyncProperty>boolean</CalendarSyncProperty>
  <AOAProperty>boolean</AOAProperty>
  <ErrorMsg>string</ErrorMsg>
  <TimeShare>boolean</TimeShare>
  <OnlineBookingAllowed>boolean</OnlineBookingAllowed>
</PropertyPermissions>

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/GetPropertyPermissions 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"?>
<PropertyPermissions xmlns="http://xml.ciirus.com/">
  <PropertyID>int</PropertyID>
  <MCEnableProperty>boolean</MCEnableProperty>
  <AgentEnableProperty>boolean</AgentEnableProperty>
  <AgentUserID>int</AgentUserID>
  <MCUserID>int</MCUserID>
  <NativeProperty>boolean</NativeProperty>
  <CalendarSyncProperty>boolean</CalendarSyncProperty>
  <AOAProperty>boolean</AOAProperty>
  <ErrorMsg>string</ErrorMsg>
  <TimeShare>boolean</TimeShare>
  <OnlineBookingAllowed>boolean</OnlineBookingAllowed>
</PropertyPermissions>

Parameter	Value
APIUsername:
APIPassword:
PropertyID: