CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetImageList2

Returns a list of URLs for Images associated with specified property

Use this function to get a string array of URLs to images for the specified property.

Pass the following parameters:

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

Error Responses:

GetImageList2: Validation Error 1
GetImageList2: Validation Error 2
GetImageList2: Validation Error 2 - Property has been deleted from the system.
GetImageList2: Validation Error 3 - Property has been deleted from the system.
GetImageList2: Error - DataSet not Populated
GetImageList2: Error - No Images exist for this property at this time. Please contact the user and request they populate this data.
GetImageList2: This property contains demo images. Please contact the user and request they populate this data.

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

<?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>
    <GetImageList2 xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetImageList2>
  </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>
    <GetImageList2Response xmlns="http://xml.ciirus.com/">
      <GetImageList2Result>
        <ImageObj>
          <ID>int</ID>
          <ImageURL>string</ImageURL>
          <Description>string</Description>
        </ImageObj>
        <ImageObj>
          <ID>int</ID>
          <ImageURL>string</ImageURL>
          <Description>string</Description>
        </ImageObj>
      </GetImageList2Result>
    </GetImageList2Response>
  </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>
    <GetImageList2 xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
      <PropertyID>int</PropertyID>
    </GetImageList2>
  </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>
    <GetImageList2Response xmlns="http://xml.ciirus.com/">
      <GetImageList2Result>
        <ImageObj>
          <ID>int</ID>
          <ImageURL>string</ImageURL>
          <Description>string</Description>
        </ImageObj>
        <ImageObj>
          <ID>int</ID>
          <ImageURL>string</ImageURL>
          <Description>string</Description>
        </ImageObj>
      </GetImageList2Result>
    </GetImageList2Response>
  </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/GetImageList2?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"?>
<ArrayOfImageObj xmlns="http://xml.ciirus.com/">
  <ImageObj>
    <ID>int</ID>
    <ImageURL>string</ImageURL>
    <Description>string</Description>
  </ImageObj>
  <ImageObj>
    <ID>int</ID>
    <ImageURL>string</ImageURL>
    <Description>string</Description>
  </ImageObj>
</ArrayOfImageObj>

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/GetImageList2 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"?>
<ArrayOfImageObj xmlns="http://xml.ciirus.com/">
  <ImageObj>
    <ID>int</ID>
    <ImageURL>string</ImageURL>
    <Description>string</Description>
  </ImageObj>
  <ImageObj>
    <ID>int</ID>
    <ImageURL>string</ImageURL>
    <Description>string</Description>
  </ImageObj>
</ArrayOfImageObj>

Parameter	Value
APIUserName:
APIPassword:
PropertyID: