CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetStaticPropertyDetails

This function returns an object containing details about a request property supplier.

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required
PropertyIds (Args() of Integer. 50 Max) *Required

Error Responses:

GetManagementCompanyDetails: Request limited to 50 properties per call.
GetManagementCompanyDetails: Validation Error 1
GetManagementCompanyDetails: Validation Error 2
User does not have rights to property.

Test

The test form is only available for methods with primitive types as parameters.

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 /CiirusXML.15.025.asmx HTTP/1.1
Host: api.ciirus.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://xml.ciirus.com/GetStaticPropertyDetails"

<?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>
    <GetStaticPropertyDetails xmlns="http://xml.ciirus.com/">
      <ApiUsername>string</ApiUsername>
      <ApiPassword>string</ApiPassword>
      <PropertyIds>
        <int>int</int>
        <int>int</int>
      </PropertyIds>
    </GetStaticPropertyDetails>
  </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>
    <GetStaticPropertyDetailsResponse xmlns="http://xml.ciirus.com/">
      <GetStaticPropertyDetailsResult>
        <StaticPropertyDetails>
          <PropertyId>int</PropertyId>
          <McUserId>int</McUserId>
          <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
          <TenStarRating>decimal</TenStarRating>
          <TimeZoneInfo>
            <TimeZone>string</TimeZone>
            <OffsetFromUtc>string</OffsetFromUtc>
            <Abbreviation>string</Abbreviation>
          </TimeZoneInfo>
          <BusinessTaxId>string</BusinessTaxId>
          <ErrorMessage>string</ErrorMessage>
          <Amenities>
            <anyType />
            <anyType />
          </Amenities>
          <Attributes>
            <anyType />
            <anyType />
          </Attributes>
        </StaticPropertyDetails>
        <StaticPropertyDetails>
          <PropertyId>int</PropertyId>
          <McUserId>int</McUserId>
          <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
          <TenStarRating>decimal</TenStarRating>
          <TimeZoneInfo>
            <TimeZone>string</TimeZone>
            <OffsetFromUtc>string</OffsetFromUtc>
            <Abbreviation>string</Abbreviation>
          </TimeZoneInfo>
          <BusinessTaxId>string</BusinessTaxId>
          <ErrorMessage>string</ErrorMessage>
          <Amenities>
            <anyType />
            <anyType />
          </Amenities>
          <Attributes>
            <anyType />
            <anyType />
          </Attributes>
        </StaticPropertyDetails>
      </GetStaticPropertyDetailsResult>
    </GetStaticPropertyDetailsResponse>
  </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 /CiirusXML.15.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>
    <GetStaticPropertyDetails xmlns="http://xml.ciirus.com/">
      <ApiUsername>string</ApiUsername>
      <ApiPassword>string</ApiPassword>
      <PropertyIds>
        <int>int</int>
        <int>int</int>
      </PropertyIds>
    </GetStaticPropertyDetails>
  </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>
    <GetStaticPropertyDetailsResponse xmlns="http://xml.ciirus.com/">
      <GetStaticPropertyDetailsResult>
        <StaticPropertyDetails>
          <PropertyId>int</PropertyId>
          <McUserId>int</McUserId>
          <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
          <TenStarRating>decimal</TenStarRating>
          <TimeZoneInfo>
            <TimeZone>string</TimeZone>
            <OffsetFromUtc>string</OffsetFromUtc>
            <Abbreviation>string</Abbreviation>
          </TimeZoneInfo>
          <BusinessTaxId>string</BusinessTaxId>
          <ErrorMessage>string</ErrorMessage>
          <Amenities>
            <anyType />
            <anyType />
          </Amenities>
          <Attributes>
            <anyType />
            <anyType />
          </Attributes>
        </StaticPropertyDetails>
        <StaticPropertyDetails>
          <PropertyId>int</PropertyId>
          <McUserId>int</McUserId>
          <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
          <TenStarRating>decimal</TenStarRating>
          <TimeZoneInfo>
            <TimeZone>string</TimeZone>
            <OffsetFromUtc>string</OffsetFromUtc>
            <Abbreviation>string</Abbreviation>
          </TimeZoneInfo>
          <BusinessTaxId>string</BusinessTaxId>
          <ErrorMessage>string</ErrorMessage>
          <Amenities>
            <anyType />
            <anyType />
          </Amenities>
          <Attributes>
            <anyType />
            <anyType />
          </Attributes>
        </StaticPropertyDetails>
      </GetStaticPropertyDetailsResult>
    </GetStaticPropertyDetailsResponse>
  </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 /CiirusXML.15.025.asmx/GetStaticPropertyDetails?ApiUsername=string&ApiPassword=string&PropertyIds=string&PropertyIds=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"?>
<ArrayOfStaticPropertyDetails xmlns="http://xml.ciirus.com/">
  <StaticPropertyDetails>
    <PropertyId>int</PropertyId>
    <McUserId>int</McUserId>
    <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
    <TenStarRating>decimal</TenStarRating>
    <TimeZoneInfo>
      <TimeZone>string</TimeZone>
      <OffsetFromUtc>string</OffsetFromUtc>
      <Abbreviation>string</Abbreviation>
    </TimeZoneInfo>
    <BusinessTaxId>string</BusinessTaxId>
    <ErrorMessage>string</ErrorMessage>
    <Amenities>
      <anyType />
      <anyType />
    </Amenities>
    <Attributes>
      <anyType />
      <anyType />
    </Attributes>
  </StaticPropertyDetails>
  <StaticPropertyDetails>
    <PropertyId>int</PropertyId>
    <McUserId>int</McUserId>
    <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
    <TenStarRating>decimal</TenStarRating>
    <TimeZoneInfo>
      <TimeZone>string</TimeZone>
      <OffsetFromUtc>string</OffsetFromUtc>
      <Abbreviation>string</Abbreviation>
    </TimeZoneInfo>
    <BusinessTaxId>string</BusinessTaxId>
    <ErrorMessage>string</ErrorMessage>
    <Amenities>
      <anyType />
      <anyType />
    </Amenities>
    <Attributes>
      <anyType />
      <anyType />
    </Attributes>
  </StaticPropertyDetails>
</ArrayOfStaticPropertyDetails>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /CiirusXML.15.025.asmx/GetStaticPropertyDetails HTTP/1.1
Host: api.ciirus.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ApiUsername=string&ApiPassword=string&PropertyIds=string&PropertyIds=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfStaticPropertyDetails xmlns="http://xml.ciirus.com/">
  <StaticPropertyDetails>
    <PropertyId>int</PropertyId>
    <McUserId>int</McUserId>
    <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
    <TenStarRating>decimal</TenStarRating>
    <TimeZoneInfo>
      <TimeZone>string</TimeZone>
      <OffsetFromUtc>string</OffsetFromUtc>
      <Abbreviation>string</Abbreviation>
    </TimeZoneInfo>
    <BusinessTaxId>string</BusinessTaxId>
    <ErrorMessage>string</ErrorMessage>
    <Amenities>
      <anyType />
      <anyType />
    </Amenities>
    <Attributes>
      <anyType />
      <anyType />
    </Attributes>
  </StaticPropertyDetails>
  <StaticPropertyDetails>
    <PropertyId>int</PropertyId>
    <McUserId>int</McUserId>
    <MinimumHoursBeforeCheckIn>int</MinimumHoursBeforeCheckIn>
    <TenStarRating>decimal</TenStarRating>
    <TimeZoneInfo>
      <TimeZone>string</TimeZone>
      <OffsetFromUtc>string</OffsetFromUtc>
      <Abbreviation>string</Abbreviation>
    </TimeZoneInfo>
    <BusinessTaxId>string</BusinessTaxId>
    <ErrorMessage>string</ErrorMessage>
    <Amenities>
      <anyType />
      <anyType />
    </Amenities>
    <Attributes>
      <anyType />
      <anyType />
    </Attributes>
  </StaticPropertyDetails>
</ArrayOfStaticPropertyDetails>