Occupancy Logo  
          

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


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

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
PropertyIdProperty ID
NumAdultsCustomer Number of Adults
NumChildrenCustomer Number of Children
FirstNameCustomer First Name
LastNameCustomer Last Name
FromBooking From Date(dd/MM/yyyy)
To Booking To Date (dd/MM/yyyy)
EmailCustomer Email Address
PhoneCustomer Phone Number
CustomerCommentCustomer Comment or question. Eg: Do you have BBQ facility?
RequireLinenRequire Linen(yes/no)
AddressCustomer Address
CityCustomer City
CountryIDCustomer Country ID
StateCustomer 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour 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

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
LocalityIDThe Locality ID in which you want to list its properties
RegionIDThe Region ID in which you want to list its properties
StateIDThe State ID in which you want to list its properties
PropertyIdsThe 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
RegionIDThe 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

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
LocalityIDThe 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
LocalityIDThe Locality ID in which you want to list its properties
RegionIDThe Region ID in which you want to list its properties
StateIDThe State ID in which you want to list its properties
CountryIDThe Country ID in which you want to list its properties
AccommodationTypeIDThe AccommodationType ID in which you want to list its properties
FacilityIDThe 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
PropertyIdProperty ID
ArrivalBooking From Date(dd/MM/yyyy)
Departure Booking To Date (dd/MM/yyyy)
NumAdultsCustomer Number of Adults
NumChildrenCustomer 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
LocalityIDThe Locality ID in which you want to list its properties
RegionIDThe Region ID in which you want to list its properties
StateIDThe State ID in which you want to list its properties
AccommodationTypeIDThe AccommodationType ID in which you want to list its properties
FacilityIDThe 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
StateIDThe 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

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
RegionIDThe 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour 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[]

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
CountryIDThe 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

ParameterDescription
ReferrerIdYour Referrer ID
UserNameYour name that allows access to the web service system
PasswordYour password that allows access to the web service system
StateIDThe 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

AttributeDescription
IdThe affiliate id
CompanyNameThe affiliate company name
ContactFirstnameThe affiliate contact first name
ContactSurnameThe affiliate contact surname name
EmailThe affiliate email
RateFlatThe affiliate rate flat
RatePctThe affiliate rate percentage



Property

AttributeDescription
PropertyIdThe Property ID
propertyNameThe Property Name
localityIdThe Location ID of the property
localityNameThe Location Name of the property
regionIdThe Region ID of the property
regionNameThe Region Name of the property
stateIdThe State ID of the property
stateNameThe State Name of the property
lowPriceThe low price of the property
highPriceThe high price of the property
numberOfPersonsForPriceMaximum number of guests that can be accommodated
numberOfNightsForPriceThe nights include in the price of the property
numberOfBedroomsThe number of bedroom
numberOfBathroomsThe number of bath room
maximumPersonsAccommodatedThe maximum of person for the property
shortDescriptionThe short descript of the property
detailsLinkThe detail link for the property
propertyImagesThe property image objects
PropertyFacilitiesThe property facility objects
PropertyTypesThe property accommodation type objects
PropertyGoogleMapThe property google map objects
StarRatingThe property star rating
PropertyCalendarURLThe property calendar url
PropertyWebsiteURLThe property website url
BookNowLinkThe link to the BookNow web page



Property Image

AttributeDescription
ImageNameThe image name
ImageURLThe image URL



Locality

AttributeDescription
LocalityIDThe Locality ID
NameThe name of the locality
URLThe URL of the locality



Region

AttributeDescription
RegionIDThe Region ID of that region you want to find
NameThe name of the region
URLThe URL of the region



State

AttributeDescription
StateIDThe State ID in which you want to list its regions
NameThe name of the state
URLThe URL of the state



AccommodationType

AttributeDescription
TypeIDThe Accommodation Type ID
TypeNameThe name of the type



Facility

AttributeDescription
FacilityIDThe Facility ID
FacilityNameThe name of the facility



Manage

AttributeDescription
ManageIDThe Property Management ID
ManageNameThe name of the Property Management type(returns OwnerManager, RealEstateAgent, ServicedApartment, OnSiteManager)



Guest

AttributeDescription
GuestScoreGuest Review Score
GuestCommentsGuest Review Comments



Theme

AttributeDescription
ThemeIDThe Theme ID
ThemeNameThe Theme Name



BookingResult

AttributeDescription
BookingIDThe Booking ID
BookingMessageThe Booking Message



PropertyAvailabilityWSResult

AttributeDescription
PropertyIDThe Property ID
AvailableAvailable
DescriptionDescription
gmaxMaximum Allowed Nights
gminMinimum Allowed Nights
priceprice
totaltotal

 Copyright © 2003-2014 Occupancy.com (ACN 109 691 929). All rights reserved.