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.

The following operations are supported. For a formal definition, please review the Service Description.

Method List

DoBooking
Gets the Booking or Enquiry form, Makes Booking or Enquiry and return BookingResult

GetAccommodationTypeList
Gets the listing of Occupancy accommodation type and return them as Occupancy.TakeABreakService.AccommodationType Class.

GetAffiliateInfo
Get Affiliate Info.

GetCountryList
Gets the listing of Occupancy countries and return them as Occupancy.TakeABreakService.Country Class.

GetDetailsOfProperties
Gets the detail information of Occupancy property and return them full property detail as Occupancy.TakeABreakService.Property Class.

GetFacilityList
Gets the listing of Occupancy facilities and return them as Occupancy.TakeABreakService.Facility Class.

GetLocalityList
Gets the listing of Occupancy localities and return them as Occupancy.TakeABreakService.Locality Class.

GetLocalityName
Gets the name of a Occupancy locality and return them as a String.

GetPropertiesList
Gets the listing of Occupancy properties(including other countries) and return them basic property detail as Occupancy.TakeABreakService.Property Class.

GetPropertyAvailabilityInfo
Get Property Availability Info and return as PropertyAvailabilityWSResult Class.

GetPropertyList
Gets the listing of Occupancy properties and return them basic property detail as Occupancy.TakeABreakService.Property Class.

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

GetRegionName
Gets the name of a Occupancy region and return them as a String.

GetStateList
Gets the listing of Occupancy state and return them as Occupancy.TakeABreakService.State Class.

GetStateListByCountry
Gets the listing of country states except Australia and return them as Occupancy.TakeABreakService.State Class.

GetStateName
Gets the name of a Occupancy state and return them as a String.

Method Description

DoBooking

Returns status of Booking/Enquiry

[C#]
public string DoBooking(int ReferrerId, string UserName, string password, int propertyID, int numAdults, int numChildren, string firstName, string lastName,string fromDate, string toDate, string email, string phone, string customerComment, string operatorQuestionResponse,string requireLinen, string isBooking, decimal estimatedPrice, string address, string city, int countryID, string state)

[Visual Basic]
public Function DoBooking(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal password As String, ByVal propertyID As Integer, ByVal numAdults As Integer, ByVal numChildren As Integer, ByVal firstName As String, ByVal lastName As String,ByVal fromDate As String, ByVal toDate As String, ByVal email As String, ByVal phone As String, ByVal customerComment As String, ByVal operatorQuestionResponse As String,ByVal requireLinen As String, ByVal isBooking As String, ByVal address As String, ByVal city As String, ByVal countryID As Integer, ByVal state As String) As String

[Java]
public string DoBooking(int ReferrerId, string UserName, string password, int propertyID, int numAdults, int numChildren, string firstName, string lastName,string fromDate, string toDate, string email, string phone, string customerComment,string requireLinen, string isBookingstring address, string city, int countryID, string state)

[UML]
DoBooking (ReferrerId: Integer, UserName: String, password: String, propertyID: Integer, numAdults: Integer, numChildren: Integer, firstName: String, lastName: String, fromDate: String, toDate: String, email: String, phone: String, customerComment: String, requireLinen: String, isBooking: String, address: String, city: String, countryID: Integer, state: String) As String

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
PropertyId	Property ID
NumAdults	Customer Number of Adults
NumChildren	Customer Number of Children
FirstName	Customer First Name
LastName	Customer Last Name
From	Booking From Date(dd/MM/yyyy)
To	Booking To Date (dd/MM/yyyy)
Email	Customer Email Address
Phone	Customer Phone Number
CustomerComment	Customer Comment or question. Eg: Do you have BBQ facility?
RequireLinen	Require Linen(yes/no)
Address	Customer Address
City	Customer City
CountryID	Customer Country ID
State	Customer State

Return Value
A BookingResult.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetAffiliateInfo?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&propertyID=yourpropertyID&numAdults=yournumAdults&numChildren=yournumChildren&firstName=yourfirstName&lastName=yourlastName&from=yourfromDate&to=yourtoDate&email=youremail&phone=yourphone&customerComment=yourcustomerComment&requireLinen=yourrequireLinen&estimatedPrice=yourestimatedPrice&address=youraddress&city=yourcity&countryID=yourcountryID&state=yourstate

GetAccommodationTypeList

Returns a list of accommodation types.

[C#]
public Accommodation[] GetAccommodationTypeList(int ReferrerId, string UserName, string Password)

[Visual Basic]
public Function GetAccommodationTypeList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String) As AccommodationType()

[Java]
public AccommodationType[] GetAccommodationTypeList(int ReferrerId, string UserName, string Password)

[UML]
GetAccommodationTypeList(ReferrerId: Integer, UserName: String, Password: String) : Accommodation[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system

Return Value
An array of AccommodationType.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetAccommodationTypeList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword

GetAffiliateInfo

Returns an affiliate object.

[C#]
public Affiliate GetAffiliateInfo(int ReferrerId, string UserName, string Password)

[Visual Basic]
public Function GetAffiliateInfo(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String) As Affiliate()

[Java]
public Affiliate GetAffiliateInfo(int ReferrerId, string UserName, string Password)

[UML]
GetAffiliateInfo (ReferrerId: Integer, UserName: String, Password: String) : Affiliate

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system

Return Value
An Affiliate.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetAffiliateInfo?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword

GetCountryList

Returns a list of countries.

[C#]
public Country[] GetCountryList(int ReferrerId, string UserName, string Password)

[Visual Basic]
public Function GetCountryList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String) As Country()

[Java]
public Country[] GetCountryList(int ReferrerId, string UserName, string Password)

[UML]
GetCountryList(ReferrerId: Integer, UserName: String, Password: String) : Country[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system

Return Value
An array of Country.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetCountryList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword

GetDetailsOfProperties

Returns Returns a list of properties with some more detail information.

[C#]
public Property[] GetDetailsOfProperties(string ReferrerId, string UserName, string Password, string LocalityId, string RegionId, string StateId, string PropertyIds)

[Visual Basic]
public Function GetDetailsOfProperties(ByVal ReferrerId As String, ByVal UserName As String, ByVal Password As String, ByVal LocalityId As String, ByVal RegionId As String, ByVal StateId As String, ByVal PropertyIds As String) As Property()

[Java]
public Property[] GetDetailsOfProperties(string ReferrerId, string UserName, string Password, string LocalityId, string RegionId, string StateId, string PropertyIds)

[UML]
GetDetailsOfProperties(ReferrerId: String, UserName: String, Password: String, LocalityId: String, RegionId: String, StateId: String, PropertyIds: String) : Property[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
LocalityID	The Locality ID in which you want to list its properties
RegionID	The Region ID in which you want to list its properties
StateID	The State ID in which you want to list its properties
PropertyIds	The Property Ids in which you want to list its properties

Return Value
An array of Porperty.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetDetailsOfProperties?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&stateid=stateid®ionid=regionid&LocalityId=localityid&PropertyIds=propertyids

GetFacilityList

Returns a list of facilities.

[C#]
public Facility[] GetFacilityList(int ReferrerId, string UserName, string Password)

[Visual Basic]
public Function GetFacilityList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String) As Facility()

[Java]
public Facility[] GetFacilityList(int ReferrerId, string UserName, string Password)

[UML]
GetFacilityList(ReferrerId: Integer, UserName: String, Password: String) : Facility[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system

Return Value
An array of Facility.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetFacilityList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword

GetLocalityList

Returns a list of localities for a given Region ID.

[C#]
public Locality[] GetLocalityList(int ReferrerId, string UserName, string Password, int RegionId)

[Visual Basic]
public Function GetLocalityList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal RegionId As Integer) As Locality()

[Java]
public Locality[] GetLocalityList(int ReferrerId, string UserName, string Password, int RegionId)

[UML]
GetLocalityList (ReferrerId: Integer, UserName: String, Password: String, RegionId: Integer) : Locality[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
RegionID	The Region ID in which you want to list its localities

Return Value
An array of Locality.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetLocalityList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword®ionid=regionid

GetLocalityName

Returns a locality name for a given Locality ID.

[C#]
public string GetLocalityName(int ReferrerId, string UserName, string Password, int LocalityId)

[Visual Basic]
public Function GetLocalityName(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal LocalityId As Integer) As String

[Java]
public string GetLocalityName(int ReferrerId, string UserName, string Password, int LocalityId)

[UML]
GetLocalityName (ReferrerId: Integer, UserName: String, Password: String, LocalityId: Integer) : String

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
LocalityID	The Locality ID of that locality you want to find

Return Value
An Locality name.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetLocalityName?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&LocalityId=localityid

GetPropertiesList

Returns a list of properties for a given Country ID, or StateID, or RegionID, or Locality ID.

[C#]
public Property[] GetPropertiesList(int ReferrerId, string UserName, string Password, int CountryId, int LocalityId, int RegionId, int StateId, int AccommodationTypeId, int FacilityId)

[Visual Basic]
public Function GetPropertiesList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal LocalityId As Integer, ByVal RegionId As Integer, ByVal StateId As Integer, ByVal CountryId As Integer, ByVal AccommodationTypeId As Integer, ByVal FacilityId As Integer) As Property()

[Java]
public Property[] GetPropertiesList(int ReferrerId, string UserName, string Password, int CountryId, int LocalityId, int RegionId, int StateId, int AccommodationTypeId, int FacilityId)

[UML]
GetPropertiesList(ReferrerId: Integer, UserName: String, Password: String, LocalityId: Integer, RegionId: Integer, StateId: Integer, CountryId: Integer, AccommodationTypeId: Integer, FacilityId: Integer) : Property[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
LocalityID	The Locality ID in which you want to list its properties
RegionID	The Region ID in which you want to list its properties
StateID	The State ID in which you want to list its properties
CountryID	The Country ID in which you want to list its properties
AccommodationTypeID	The AccommodationType ID in which you want to list its properties
FacilityID	The Facility ID in which you want to list its properties

Return Value
An array of Porperty.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetPropertiesList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&CountryId=countryid&stateid=stateid®ionid=regionid&LocalityId=localityid&AccommodationTypeId=accommodationtypeid&FacilityId=facilityid

GetPropertyAvailabilityInfo

Returns property Availability information.

[C#]
public PropertyAvailabilityWSResult GetPropertyAvailabilityInfo(int ReferrerId, string UserName, string password, int propertyId, string arrival, string departure, int numAdults, int numChildren)

[Visual Basic]
public Function GetPropertyAvailabilityInfo(ByVal ReferrerId As int, ByVal UserName As string, ByVal password As string, ByVal propertyId As int, ByVal arrival As string, ByVal departure As string, ByVal numAdults As int, ByVal numChildren As int) As PropertyAvailabilityWSResult()

[Java]
public PropertyAvailabilityWSResult GetPropertyAvailabilityInfo(int ReferrerId, string UserName, string password, int propertyId, string arrival, string departure, int numAdults, int numChildren)

[UML]
GetPropertyAvailabilityInfo(ReferrerId: Integer, UserName: String, password: String, propertyId: Integer, arrival: String, departure: String, numAdults: Integer, numChildren: Integer) : PropertyAvailabilityWSResult[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
PropertyId	Property ID
Arrival	Booking From Date(dd/MM/yyyy)
Departure	Booking To Date (dd/MM/yyyy)
NumAdults	Customer Number of Adults
NumChildren	Customer Number of Children

Return Value
A PropertyAvailabilityResult.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetPropertyAvailabilityInfo?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&propertyId=propertyId&arrival=arrival&departure=departure&numAdults=numAdults&numChildren=numChildren

GetPropertyList

Returns a list of properties for a given Locality ID or Region ID or State ID.

[C#]
public Property[] GetPropertyList(int ReferrerId, string UserName, string Password, int LocalityId, int RegionId, int StateId, int AccommodationTypeId, int FacilityId)

[Visual Basic]
public Function GetPropertyList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal LocalityId As Integer, ByVal RegionId As Integer, ByVal StateId As Integer, ByVal AccommodationTypeId As Integer, ByVal FacilityId As Integer) As Property()

[Java]
public Property[] GetPropertyList(int ReferrerId, string UserName, string Password, int LocalityId, int RegionId, int StateId, int AccommodationTypeId, int FacilityId)

[UML]
GetPropertyList(ReferrerId: Integer, UserName: String, Password: String, LocalityId: Integer, RegionId: Integer, StateId: Integer, AccommodationTypeId: Integer, FacilityId: Integer) : Property[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
LocalityID	The Locality ID in which you want to list its properties
RegionID	The Region ID in which you want to list its properties
StateID	The State ID in which you want to list its properties
AccommodationTypeID	The AccommodationType ID in which you want to list its properties
FacilityID	The Facility ID in which you want to list its properties

Return Value
An array of Porperty.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetPropertyList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&StateId=stateid&RegionId=regionid&LocalityId=localityid&AccommodationTypeId=accommodationtypeid&FacilityId=facilityid

GetRegionList

Returns a list of regions for a given State ID.

[C#]
public Region[] GetRegionList(int ReferrerId, string UserName, string Password, int StateId)

[Visual Basic]
public Function GetRegionList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal StateId As Integer) As Region()

[Java]
public Region[] GetRegionList(int ReferrerId, string UserName, string Password, int StateId)

[UML]
GetRegionList(ReferrerId: Integer, UserName: String, Password: String, StateId: Integer) : Region[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
StateID	The State ID in which you want to list its regions

Return Value
An array of Region.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetRegionList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&stateid=stateid

GetRegionName

Returns a region name for a given Region ID.

[C#]
public string GetRegionName(int ReferrerId, string UserName, string Password, int RegionId)

[Visual Basic]
public Function GetRegionName(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal RegionId As Integer) As String

[Java]
public string GetRegionName(int ReferrerId, string UserName, string Password, int RegionId)

[UML]
GetRegionName(ReferrerId: Integer, UserName: String, Password: String, RegionId: Integer) : String

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
RegionID	The Region ID of that region you want to find

Return Value
An Region name.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetRegionName?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword®ionid=regionid

GetStateList

Returns a list of states.

[C#]
public State[] GetStateList(int ReferrerId, string UserName, string Password)

[Visual Basic]
public Function GetStateList(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String) As State()

[Java]
public State[] GetStateList(int ReferrerId, string UserName, string Password)

[UML]
GetStateList(ReferrerId: Integer, UserName: String, Password: String) : State[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system

Return Value
An array of State.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetStateList?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword

GetStateListByCountry

Returns a list of states for a country.

[C#]
public State[] GetStateListByCountry(int ReferrerId, string UserName, string Password, int CountryId)

[Visual Basic]
public Function GetStateListByCountry(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal CountryId As Integer) As State()

[Java]
public State[] GetStateListByCountry(int ReferrerId, string UserName, string Password, int CountryId)

[UML]
GetStateListByCountry(ReferrerId: Integer, UserName: String, Password: String, CountryId: Integer) : State[]

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
CountryID	The Country ID of that state you want to find

Return Value
An array of State.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetStateListByCountry?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&CountryID=countryid

GetStateName

Returns a state name for a given State ID.

[C#]
public string GetStateName(int ReferrerId, string UserName, string Password, int StateId)

[Visual Basic]
public Function GetStateName(ByVal ReferrerId As Integer, ByVal UserName As String, ByVal Password As String, ByVal StateId As Integer) As String

[Java]
public string GetStateName(int ReferrerId, string UserName, string Password, int StateId)

[UML]
GetStateName(ReferrerId: Integer, UserName: String, Password: String, StateId: Integer) : String

Parameter	Description
ReferrerId	Your Referrer ID
UserName	Your name that allows access to the web service system
Password	Your password that allows access to the web service system
StateID	The State ID of that state you want to find

Return Value
An State name.

Example Reference
http://www.takeabreak.com.au/TABWebService/service.asmx/GetStateName?ReferrerId=yourreferrerid&UserName=yourusername&Password=yourpassword&stateid=stateid

Class Description

Affiliate

Attribute	Description
Id	The affiliate id
CompanyName	The affiliate company name
ContactFirstname	The affiliate contact first name
ContactSurname	The affiliate contact surname name
Email	The affiliate email
RateFlat	The affiliate rate flat
RatePct	The affiliate rate percentage

Property

Attribute	Description
PropertyId	The Property ID
propertyName	The Property Name
localityId	The Location ID of the property
localityName	The Location Name of the property
regionId	The Region ID of the property
regionName	The Region Name of the property
stateId	The State ID of the property
stateName	The State Name of the property
lowPrice	The low price of the property
highPrice	The high price of the property
numberOfPersonsForPrice	Maximum number of guests that can be accommodated
numberOfNightsForPrice	The nights include in the price of the property
numberOfBedrooms	The number of bedroom
numberOfBathrooms	The number of bath room
maximumPersonsAccommodated	The maximum of person for the property
shortDescription	The short descript of the property
detailsLink	The detail link for the property
propertyImages	The property image objects
PropertyFacilities	The property facility objects
PropertyTypes	The property accomodation type objects
PropertyGoogleMap	The property google map objects
StarRating	The property star rating
PropertyCalendarURL	The property calendar url
PropertyWebsiteURL	The property website url
BookNowLink	The link to the BookNow web page

Property Image

Attribute	Description
ImageName	The image name
ImageURL	The image URL

Locality

Attribute	Description
LocalityID	The Locality ID
Name	The name of the locality
URL	The URL of the locality

Region

Attribute	Description
RegionID	The Region ID of that region you want to find
Name	The name of the region
URL	The URL of the region

State

Attribute	Description
StateID	The State ID in which you want to list its regions
Name	The name of the state
URL	The URL of the state

AccommodationType

Attribute	Description
TypeID	The Accommodation Type ID
TypeName	The name of the type

Facility

Attribute	Description
FacilityID	The Facility ID
FacilityName	The name of the facility

Manage

Attribute	Description
ManageID	The Property Management ID
ManageName	The name of the Property Management type(returns OwnerManager, RealEstateAgent, ServicedApartment, OnSiteManager)

Guest

Attribute	Description
GuestScore	Guest Review Score
GuestComments	Guest Review Comments

Theme

Attribute	Description
ThemeID	The Theme ID
ThemeName	The Theme Name

BookingResult

Attribute	Description
BookingID	The Booking ID
BookingMessage	The Booking Message

PropertyAvailabilityWSResult

Attribute	Description
PropertyID	The Property ID
Available	Available
Description	Description
gmax	Maximum Allowed Nights
gmin	Minimum Allowed Nights
price	price
total	total