|
||
| 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->GetPropertyList
GetPropertyList
Gets the listing of Occupancy properties and return them basic property detail as Occupancy.TakeABreakService.Property Class.
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 /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/GetPropertyList"
<?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>
<GetPropertyList xmlns="http://tempuri.org/">
<ReferrerId>int</ReferrerId>
<UserName>string</UserName>
<password>string</password>
<StateId>int</StateId>
<RegionId>int</RegionId>
<LocalityId>int</LocalityId>
<AccommodationTypeId>int</AccommodationTypeId>
<FacilityId>int</FacilityId>
</GetPropertyList>
</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>
<GetPropertyListResponse xmlns="http://tempuri.org/">
<GetPropertyListResult>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage xsi:nil="true" />
<PropertyImage xsi:nil="true" />
</PropertyImages>
<PropertyFacilities>
<Facility xsi:nil="true" />
<Facility xsi:nil="true" />
</PropertyFacilities>
<PropertyTypes>
<AccommodationType xsi:nil="true" />
<AccommodationType xsi:nil="true" />
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage xsi:nil="true" />
<PropertyImage xsi:nil="true" />
</PropertyImages>
<PropertyFacilities>
<Facility xsi:nil="true" />
<Facility xsi:nil="true" />
</PropertyFacilities>
<PropertyTypes>
<AccommodationType xsi:nil="true" />
<AccommodationType xsi:nil="true" />
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
</GetPropertyListResult>
</GetPropertyListResponse>
</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>
<GetPropertyList xmlns="http://tempuri.org/">
<ReferrerId>int</ReferrerId>
<UserName>string</UserName>
<password>string</password>
<StateId>int</StateId>
<RegionId>int</RegionId>
<LocalityId>int</LocalityId>
<AccommodationTypeId>int</AccommodationTypeId>
<FacilityId>int</FacilityId>
</GetPropertyList>
</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>
<GetPropertyListResponse xmlns="http://tempuri.org/">
<GetPropertyListResult>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage xsi:nil="true" />
<PropertyImage xsi:nil="true" />
</PropertyImages>
<PropertyFacilities>
<Facility xsi:nil="true" />
<Facility xsi:nil="true" />
</PropertyFacilities>
<PropertyTypes>
<AccommodationType xsi:nil="true" />
<AccommodationType xsi:nil="true" />
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage xsi:nil="true" />
<PropertyImage xsi:nil="true" />
</PropertyImages>
<PropertyFacilities>
<Facility xsi:nil="true" />
<Facility xsi:nil="true" />
</PropertyFacilities>
<PropertyTypes>
<AccommodationType xsi:nil="true" />
<AccommodationType xsi:nil="true" />
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
</GetPropertyListResult>
</GetPropertyListResponse>
</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/GetPropertyList?ReferrerId=string&UserName=string&password=string&StateId=string&RegionId=string&LocalityId=string&AccommodationTypeId=string&FacilityId=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"?>
<ArrayOfProperty xmlns="http://tempuri.org/">
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
</PropertyImages>
<PropertyFacilities>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
</PropertyFacilities>
<PropertyTypes>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
</PropertyImages>
<PropertyFacilities>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
</PropertyFacilities>
<PropertyTypes>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
</ArrayOfProperty>
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/GetPropertyList 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&RegionId=string&LocalityId=string&AccommodationTypeId=string&FacilityId=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfProperty xmlns="http://tempuri.org/">
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
</PropertyImages>
<PropertyFacilities>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
</PropertyFacilities>
<PropertyTypes>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
<Property>
<PropertyID>int</PropertyID>
<PropertyName>string</PropertyName>
<PropertyUnitID>int</PropertyUnitID>
<LocalityID>int</LocalityID>
<LocalityName>string</LocalityName>
<RegionID>int</RegionID>
<RegionName>string</RegionName>
<StateID>int</StateID>
<StateName>string</StateName>
<LowPrice>decimal</LowPrice>
<HighPrice>decimal</HighPrice>
<NumberOfPersonsForPrice>int</NumberOfPersonsForPrice>
<NumberOfNightsForPrice>int</NumberOfNightsForPrice>
<NumberOfBedrooms>int</NumberOfBedrooms>
<NumberOfBathrooms>int</NumberOfBathrooms>
<MaximumPersonsAccommodated>int</MaximumPersonsAccommodated>
<ShortDescription>string</ShortDescription>
<LongDescription>string</LongDescription>
<Rooms>string</Rooms>
<Rates>string</Rates>
<Specials>string</Specials>
<LastMinuteDeals>string</LastMinuteDeals>
<OperatorQuestion>string</OperatorQuestion>
<DetailsLink>string</DetailsLink>
<PropertyWebsiteURL>string</PropertyWebsiteURL>
<StarRating>string</StarRating>
<PropertyImages>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
<PropertyImage>
<ImageName>string</ImageName>
<ImageURL>string</ImageURL>
</PropertyImage>
</PropertyImages>
<PropertyFacilities>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
<Facility>
<FacilityId>int</FacilityId>
<FacilityName>string</FacilityName>
</Facility>
</PropertyFacilities>
<PropertyTypes>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
<AccommodationType>
<TypeDirectory>string</TypeDirectory>
<TypeID>int</TypeID>
<TypeName>string</TypeName>
</AccommodationType>
</PropertyTypes>
<PropertyGoogleMap>
<Longitude>double</Longitude>
<Latitude>double</Latitude>
<CenterX>double</CenterX>
<CenterY>double</CenterY>
<Zoom>int</Zoom>
</PropertyGoogleMap>
<PropertyCalendarURL>string</PropertyCalendarURL>
<MinimumNightsStay>string</MinimumNightsStay>
<ModifiedDate>dateTime</ModifiedDate>
</Property>
</ArrayOfProperty>
|
Copyright © 2003-2013 Occupancy.com (ACN 109 691 929). All rights reserved. |