CiirusXML15025


Click here for a complete list of operations.

GetDescriptionsHTML

Returns the HTML of the Description Set specified by this user for this property.

Use this function to get the description for the specified property. The description that is returned is in HTML format and may contain any HTML element: head, body, h1, p, a, etc.



Pass the following parameters:

  • APIUsername (String)
  • APIPassword (String)
  • PropertyID (integer)

If plaintext is what you are looking for, use the get description function called "GetDescriptionsPlainText"



Error Responses:

  • GetDescriptionsHTML: Validation Error 1
  • GetDescriptionsHTML: Validation Error 2 - Property has been deleted from the system
  • GetDescriptionsHTML: Validation Error 2
  • GetDescriptionsHTML: Error - DataSet not Populated
  • GetDescriptionsHTML: Error - The description is blank
  • GetDescriptionsHTML: Error - No Description Set Assigned
  • GetDescriptionsHTML: Error - The PropertyID MUST be greater than zero
  • GetDescriptionsHTML: Error - Unknown

Test

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

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

<?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>
    <GetDescriptionsHTML xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetDescriptionsHTML>
  </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>
    <GetDescriptionsHTMLResponse xmlns="http://xml.ciirus.com/">
      <GetDescriptionsHTMLResult>string</GetDescriptionsHTMLResult>
    </GetDescriptionsHTMLResponse>
  </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>
    <GetDescriptionsHTML xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetDescriptionsHTML>
  </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>
    <GetDescriptionsHTMLResponse xmlns="http://xml.ciirus.com/">
      <GetDescriptionsHTMLResult>string</GetDescriptionsHTMLResult>
    </GetDescriptionsHTMLResponse>
  </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/GetDescriptionsHTML?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"?>
<string xmlns="http://xml.ciirus.com/">string</string>

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/GetDescriptionsHTML 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"?>
<string xmlns="http://xml.ciirus.com/">string</string>