Service Web Service

Affiliate API

Welcome to the Occupancy Affiliate API web service. If you require technical assistance please contact affiliates@occupancy.com, our affiliate support team would be happy to assist.

TakeABreak Web Service->GetRegionList

GetRegionList

Gets the listing of Occupancy regions and return them as Occupancy.TakeABreakService.Region Class.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
ReferrerId:
UserName:
password:
StateId:

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 /TABWebService/Service.asmx HTTP/1.1
Host: www.takeabreak.com.au
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetRegionList"

<?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>
    <GetRegionList xmlns="http://tempuri.org/">
      <ReferrerId>int</ReferrerId>
      <UserName>string</UserName>
      <password>string</password>
      <StateId>int</StateId>
    </GetRegionList>
  </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>
    <GetRegionListResponse xmlns="http://tempuri.org/">
      <GetRegionListResult>
        <Region>
          <Name>string</Name>
          <RegionID>int</RegionID>
          <URL>string</URL>
        </Region>
        <Region>
          <Name>string</Name>
          <RegionID>int</RegionID>
          <URL>string</URL>
        </Region>
      </GetRegionListResult>
    </GetRegionListResponse>
  </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 /TABWebService/Service.asmx HTTP/1.1
Host: www.takeabreak.com.au
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>
    <GetRegionList xmlns="http://tempuri.org/">
      <ReferrerId>int</ReferrerId>
      <UserName>string</UserName>
      <password>string</password>
      <StateId>int</StateId>
    </GetRegionList>
  </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>
    <GetRegionListResponse xmlns="http://tempuri.org/">
      <GetRegionListResult>
        <Region>
          <Name>string</Name>
          <RegionID>int</RegionID>
          <URL>string</URL>
        </Region>
        <Region>
          <Name>string</Name>
          <RegionID>int</RegionID>
          <URL>string</URL>
        </Region>
      </GetRegionListResult>
    </GetRegionListResponse>
  </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 /TABWebService/Service.asmx/GetRegionList?ReferrerId=string&UserName=string&password=string&StateId=string HTTP/1.1
Host: www.takeabreak.com.au

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRegion xmlns="http://tempuri.org/">
  <Region>
    <Name>string</Name>
    <RegionID>int</RegionID>
    <URL>string</URL>
  </Region>
  <Region>
    <Name>string</Name>
    <RegionID>int</RegionID>
    <URL>string</URL>
  </Region>
</ArrayOfRegion>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /TABWebService/Service.asmx/GetRegionList HTTP/1.1
Host: www.takeabreak.com.au
Content-Type: application/x-www-form-urlencoded
Content-Length: length

ReferrerId=string&UserName=string&password=string&StateId=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfRegion xmlns="http://tempuri.org/">
  <Region>
    <Name>string</Name>
    <RegionID>int</RegionID>
    <URL>string</URL>
  </Region>
  <Region>
    <Name>string</Name>
    <RegionID>int</RegionID>
    <URL>string</URL>
  </Region>
</ArrayOfRegion>