CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetManagementCompanyList

Returns a list of all management companies that supply you with properties

Use this function to get a list of the management companies that supply properties to you. Your own company will always be returned in this list, so even if you have no suppliers then at least 1 record will be returned with your User ID and company name.

Pass the following parameters:

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

Error Responses:

GetManagementCompanyList: Validation Error 1
GetManagementCompanyList: Error - DataSet not Populated
GetManagementCompanyList: 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/GetManagementCompanyList"

<?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>
    <GetManagementCompanyList xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
    </GetManagementCompanyList>
  </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>
    <GetManagementCompanyListResponse xmlns="http://xml.ciirus.com/">
      <GetManagementCompanyListResult>
        <ManagementCompanies>
          <MCUserID>int</MCUserID>
          <MCCompanyName>string</MCCompanyName>
          <MCContactEmail>string</MCContactEmail>
        </ManagementCompanies>
        <ManagementCompanies>
          <MCUserID>int</MCUserID>
          <MCCompanyName>string</MCCompanyName>
          <MCContactEmail>string</MCContactEmail>
        </ManagementCompanies>
      </GetManagementCompanyListResult>
    </GetManagementCompanyListResponse>
  </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>
    <GetManagementCompanyList xmlns="http://xml.ciirus.com/">
      <APIUserName>string</APIUserName>
      <APIPassword>string</APIPassword>
    </GetManagementCompanyList>
  </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>
    <GetManagementCompanyListResponse xmlns="http://xml.ciirus.com/">
      <GetManagementCompanyListResult>
        <ManagementCompanies>
          <MCUserID>int</MCUserID>
          <MCCompanyName>string</MCCompanyName>
          <MCContactEmail>string</MCContactEmail>
        </ManagementCompanies>
        <ManagementCompanies>
          <MCUserID>int</MCUserID>
          <MCCompanyName>string</MCCompanyName>
          <MCContactEmail>string</MCContactEmail>
        </ManagementCompanies>
      </GetManagementCompanyListResult>
    </GetManagementCompanyListResponse>
  </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/GetManagementCompanyList?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"?>
<ArrayOfManagementCompanies xmlns="http://xml.ciirus.com/">
  <ManagementCompanies>
    <MCUserID>int</MCUserID>
    <MCCompanyName>string</MCCompanyName>
    <MCContactEmail>string</MCContactEmail>
  </ManagementCompanies>
  <ManagementCompanies>
    <MCUserID>int</MCUserID>
    <MCCompanyName>string</MCCompanyName>
    <MCContactEmail>string</MCContactEmail>
  </ManagementCompanies>
</ArrayOfManagementCompanies>

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/GetManagementCompanyList 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"?>
<ArrayOfManagementCompanies xmlns="http://xml.ciirus.com/">
  <ManagementCompanies>
    <MCUserID>int</MCUserID>
    <MCCompanyName>string</MCCompanyName>
    <MCContactEmail>string</MCContactEmail>
  </ManagementCompanies>
  <ManagementCompanies>
    <MCUserID>int</MCUserID>
    <MCCompanyName>string</MCCompanyName>
    <MCContactEmail>string</MCContactEmail>
  </ManagementCompanies>
</ArrayOfManagementCompanies>

Parameter	Value
APIUserName:
APIPassword: