CiirusXML15025 Web Service

CiirusXML15025

Click here for a complete list of operations.

GetCommunities

Returns the Communities available to your account as related to one or more properties for which you have permissions.

Use this function to get a list of communities that apply to the properties that are available to you.
Note: This function caches responses for 1 minute.

Pass the following parameters:

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

Error Responses:

GetCommunities: Validation Error 1
GetCommunities: Validation Error 2
GetCommunities: Error - DataSet not Populated
GetCommunities: Error - No Communities have been assigned to properties in your account yet. Please contact the user and request they populate this data.
GetCommunities: Error - Unknown

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

<?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>
    <GetCommunities xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
    </GetCommunities>
  </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>
    <GetCommunitiesResponse xmlns="http://xml.ciirus.com/">
      <GetCommunitiesResult>
        <Communities>
          <CommunityID>int</CommunityID>
          <CommunityName>string</CommunityName>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Communities>
        <Communities>
          <CommunityID>int</CommunityID>
          <CommunityName>string</CommunityName>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Communities>
      </GetCommunitiesResult>
    </GetCommunitiesResponse>
  </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>
    <GetCommunities xmlns="http://xml.ciirus.com/">
      <APIUsername>string</APIUsername>
      <APIPassword>string</APIPassword>
    </GetCommunities>
  </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>
    <GetCommunitiesResponse xmlns="http://xml.ciirus.com/">
      <GetCommunitiesResult>
        <Communities>
          <CommunityID>int</CommunityID>
          <CommunityName>string</CommunityName>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Communities>
        <Communities>
          <CommunityID>int</CommunityID>
          <CommunityName>string</CommunityName>
          <Latitude>decimal</Latitude>
          <Longitude>decimal</Longitude>
        </Communities>
      </GetCommunitiesResult>
    </GetCommunitiesResponse>
  </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/GetCommunities?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"?>
<ArrayOfCommunities xmlns="http://xml.ciirus.com/">
  <Communities>
    <CommunityID>int</CommunityID>
    <CommunityName>string</CommunityName>
    <Latitude>decimal</Latitude>
    <Longitude>decimal</Longitude>
  </Communities>
  <Communities>
    <CommunityID>int</CommunityID>
    <CommunityName>string</CommunityName>
    <Latitude>decimal</Latitude>
    <Longitude>decimal</Longitude>
  </Communities>
</ArrayOfCommunities>

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/GetCommunities 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"?>
<ArrayOfCommunities xmlns="http://xml.ciirus.com/">
  <Communities>
    <CommunityID>int</CommunityID>
    <CommunityName>string</CommunityName>
    <Latitude>decimal</Latitude>
    <Longitude>decimal</Longitude>
  </Communities>
  <Communities>
    <CommunityID>int</CommunityID>
    <CommunityName>string</CommunityName>
    <Latitude>decimal</Latitude>
    <Longitude>decimal</Longitude>
  </Communities>
</ArrayOfCommunities>

Parameter	Value
APIUsername:
APIPassword: