CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetPropertyClasses

Returns a list of Property Classes, e.g. Standard, Superior etc.

Use this function to get a list of the property classes available, along with their ID’s (this ID is used to filter the search results in the GetProperties function)

Pass the following parameters:

APIUsername (String) *Required
APIPassword (String) *Required

Error Responses:

GetPropertyClasses: Validation Error 1
GetPropertyClasses: Error - DataSet not Populated
GetPropertyClasses: No Properties to which you have access have been assigned a class designation by the supplier(s). Please contact the user and request they populate this data.
GetPropertyClasses: Error - Unkown 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 /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/GetPropertyClasses"

<?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>
    <GetPropertyClasses xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
    </GetPropertyClasses>
  </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>
    <GetPropertyClassesResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyClassesResult>
        <PropertyClasses>
          <ID>int</ID>
          <PropertyClass>string</PropertyClass>
        </PropertyClasses>
        <PropertyClasses>
          <ID>int</ID>
          <PropertyClass>string</PropertyClass>
        </PropertyClasses>
      </GetPropertyClassesResult>
    </GetPropertyClassesResponse>
  </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>
    <GetPropertyClasses xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
    </GetPropertyClasses>
  </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>
    <GetPropertyClassesResponse xmlns="http://xml.ciirus.com/">
      <GetPropertyClassesResult>
        <PropertyClasses>
          <ID>int</ID>
          <PropertyClass>string</PropertyClass>
        </PropertyClasses>
        <PropertyClasses>
          <ID>int</ID>
          <PropertyClass>string</PropertyClass>
        </PropertyClasses>
      </GetPropertyClassesResult>
    </GetPropertyClassesResponse>
  </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/GetPropertyClasses?APIUsername=string&APIPassword=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"?>
<ArrayOfPropertyClasses xmlns="http://xml.ciirus.com/">
  <PropertyClasses>
    <ID>int</ID>
    <PropertyClass>string</PropertyClass>
  </PropertyClasses>
  <PropertyClasses>
    <ID>int</ID>
    <PropertyClass>string</PropertyClass>
  </PropertyClasses>
</ArrayOfPropertyClasses>

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

APIUsername=string&APIPassword=string

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

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

Parameter	Value
APIUsername:
APIPassword: