rentals unitedrm.rentalsunited.com/api/ruspecification.pdfvilla

RENTALSUNITED

http://www.RentalsUnited.com

RENTALS UNITEDXML API – v1.20200106

XML API version1.20200106ContactEmil [email protected]: emil.majkowski

Tomasz Szulę[email protected]

mailto:[email protected]


RENTALSUNITED


Index1. API methods reference ..................................................................................................................... 4 1.1. Abbreviatons in API .................................................................................................................. 4

2. Pull methods ..................................................................................................................................... 4 2.1. Dictonaries methods ................................................................................................................ 4 2.1.1. List statuses ....................................................................................................................... 5 2.1.2. List property types ............................................................................................................ 5 2.1.3. List OTA property types ..................................................................................................... 6 2.1.4. List locaton types .............................................................................................................. 7 2.1.5. List locatons ...................................................................................................................... 8 2.1.6. Get locaton details ........................................................................................................... 9 2.1.7. Get locaton by name ...................................................................................................... 10 2.1.8. Get locaton by coordinates ............................................................................................ 11 2.1.9. Get cites and number of propertes ............................................................................... 12 2.1.10. List cites and currencies ............................................................................................... 13 2.1.11. List destnatons ............................................................................................................ 15 2.1.12. List distance units .......................................................................................................... 16 2.1.13. List compositon rooms ................................................................................................. 17 2.1.14. List amenites ................................................................................................................ 18 2.1.15. List amenites available for room .................................................................................. 19 2.1.16. List image types ............................................................................................................. 20 2.1.17. List payment methods ................................................................................................... 21 2.1.18. List reservaton statuses ................................................................................................ 22 2.1.19. List deposit types .......................................................................................................... 23 2.1.20. List languages ................................................................................................................ 24 2.1.21. List property external statuses ...................................................................................... 25 2.1.22. List changeover types .................................................................................................... 26 2.1.23. List additonal fee kinds ................................................................................................. 27 2.1.24. List additonal fee discriminators .................................................................................. 28 2.1.25. List additonal fee types ................................................................................................ 29 2.1.26. List created users ........................................................................................................... 30 2.1.27. List cancelaton types .................................................................................................... 31 2.1.28. List quote modes. .......................................................................................................... 32

2.2. Statc property data ................................................................................................................ 34 2.2.1. List propertes ................................................................................................................. 34 2.2.2. List owner's propertes .................................................................................................... 35 2.2.3. List propertes by creaton date ...................................................................................... 37 2.2.4. List specifc property ....................................................................................................... 39 2.2.5. List buildings .................................................................................................................... 49 2.2.6. List all owners .................................................................................................................. 50 2.2.7. Get owner details ............................................................................................................ 52 2.2.8. List owner agents ............................................................................................................ 53 2.2.9. List property external listng ........................................................................................... 54 2.2.10. Allowed Propertes Count ............................................................................................. 56

2.3. Property Reviews .................................................................................................................... 57 2.3.1. List reviews for property ................................................................................................. 57

2.4. Availability and prices ............................................................................................................. 58 2.4.1. List property blocks ......................................................................................................... 58 2.4.2. List propertes blocks ...................................................................................................... 60

RENTALSUNITED


2.4.3. List property availability calendar ................................................................................... 62 2.4.4. List property min stay ...................................................................................................... 63 2.4.5. List property base price ................................................................................................... 65 2.4.6. List property prices .......................................................................................................... 66 2.4.7. Get property price ........................................................................................................... 68 2.4.8. Get property avb price .................................................................................................... 70 2.4.9. Get propertes avb price ................................................................................................. 71 2.4.10. List property discounts .................................................................................................. 73 2.4.11. List reservatons ............................................................................................................ 75 2.4.12. List own reservatons .................................................................................................... 80 2.4.13. Get reservaton by ID .................................................................................................... 83 2.4.14. List property change log ................................................................................................ 86 2.4.15. List propertes change log ............................................................................................. 88 2.4.16. List property price changes ........................................................................................... 90 2.4.17. List property availability changes .................................................................................. 91 2.4.18. Get Leads ....................................................................................................................... 92 2.4.19. Get Changeover Days .................................................................................................... 94 2.4.20. List Reservatons issing P S apping ....................................................................... 95 2.4.21. List reservatons for owner ........................................................................................... 97

3. Push methods ............................................................................................................................... 102 3.1. Statc property data .............................................................................................................. 102 3.1.1. Put building ................................................................................................................... 102 3.1.2. Put owner ...................................................................................................................... 103 3.1.3. Put property .................................................................................................................. 104 3.1.4. Set propertes status ..................................................................................................... 115 3.1.5. Put property external listng ......................................................................................... 116 3.1.6. Put property review ...................................................................................................... 118 3.1.7. Push standard number of guests .................................................................................. 119

3.2. Availability and prices ........................................................................................................... 121 3.2.1. Upload availability ......................................................................................................... 121 3.2.2. Put min stay ................................................................................................................... 122 3.2.3. Put changeover days ..................................................................................................... 124 3.2.4. Put base price ................................................................................................................ 125 3.2.5. Put prices ....................................................................................................................... 126 3.2.6. Put long stay discounts ................................................................................................. 129 3.2.7. Put last minute discounts .............................................................................................. 131 3.2.8. How is the price calculated? ......................................................................................... 132

3.3. Reservatons .......................................................................................................................... 138 3.3.1. Put reservaton on hold [DEPRECATED] ........................................................................ 138 3.3.2. Put propertes on hold .................................................................................................. 139 3.3.3. Put confrmed reservaton [DEPRECATED] .................................................................... 141 3.3.4. Put confrmed reservatons ........................................................................................... 143 3.3.5. Cancel reservaton ......................................................................................................... 149 3.3.6. Archive reservaton ....................................................................................................... 150 3.3.7. Put Lead ........................................................................................................................ 151 3.3.8. Push odifyStay ........................................................................................................... 153

3.4. User management ................................................................................................................ 154 3.4.1. Create user .................................................................................................................... 154

4. Live Notfcaton echanism (LN ) ............................................................................................. 156 4.1. Overview ............................................................................................................................... 156

RENTALSUNITED


4.2. Details ................................................................................................................................... 156 4.3. API ethods ......................................................................................................................... 156 4.3.1. List Change Types .......................................................................................................... 156 4.3.2. Subscribe for notfcatons request ............................................................................... 158 4.3.3. List subscriptons ........................................................................................................... 159

5. Reservaton Live Notfcaton echanism (RLN ) ....................................................................... 160 5.1. Enabling RLN ...................................................................................................................... 160 5.1.1. Request ......................................................................................................................... 160 5.1.2. Example ......................................................................................................................... 161 5.1.3. Response ....................................................................................................................... 161 5.1.4. Example ......................................................................................................................... 161

5.2. Confrmed reservaton .......................................................................................................... 161 5.2.1. Example ......................................................................................................................... 164

5.3. Cancellaton of the reservaton/lead .................................................................................... 164 5.3.1. Example ......................................................................................................................... 165

5.4. New Lead ............................................................................................................................. 165 5.4.1. Example ........................................................................................................................ 166

6. Credit Card policy ......................................................................................................................... 167 7. Recommended integraton scenario ............................................................................................ 167 7.1. Propertes upload ................................................................................................................. 167 7.1.1. Defnitons ..................................................................................................................... 167 7.1.2. Inital operatons ........................................................................................................... 167 7.1.3. Workfow ....................................................................................................................... 167

7.2. Receiving reservatons and leads for you propertes ............................................................ 168 8. Change log .................................................................................................................................... 168

1. API methods referenceThis secton contains a detailed reference of API methods provided by this API version. ost usage scenarios will require that your applicaton implements only a subset of the methods described in this chapter.

1.1. Abbreviations in APIAbbreviatio DescriptioC Container element andatory elementO Optonal element

2. Pull methodsThis secton contains detailed informaton about the methods that allow you to download data from the RU system.

2.1. Dictionaries methodsThis secton contains informaton about the predefned values used in the RU system.

RENTALSUNITED


2.1.1. List statuses

2.1.1.1. UsageThis method returns all statuses (with their descriptons) that are used in response messages.

2.1.1.2. RequestXML Path Data Type Type Descriptio

Pull_ListStatuses_RQ C Root elementPull_ListStatuses_RQ/Authentcaton C, Authentcaton detailsPull_ListStatuses_RQ/Authentcaton/UserName

String(50) Provided by RU

Pull_ListStatuses_RQ/Authentcaton/Password


2.1.1.2.1. Example<Pull_ListStatuses_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListStatuses_RQ>

2.1.1.3. ResponseXML Path Data Type Type DescriptioPull_ListStatuses_RS C Root elementPull_ListStatuses_RS/Status String(100

) Status descripton

Pull_ListStatuses_RS/Status@ID Integer Status IDPull_ListStatuses_RS/Statuses C A collecton of statusesPull_ListStatuses_RS/Statuses/StatusInfo String(100

) Status descripton

Pull_ListStatuses_RS/Statuses/StatusInfo@ID Integer Status ID

2.1.1.3.1. Example<Pull_ListStatuses_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Statuses> <StatusInfo ID="0">Success</Status> <StatusInfo ID="1">Error</Status> </Statuses></Pull_ListStatuses_RS>

2.1.2. List property types

2.1.2.1. UsageThis method returns all property types depending on their number of rooms. Use this method to identfy a property type.

RENTALSUNITED


Pull_ListPropTypes_RQ C Root elementPull_ListPropTypes_RQ/Authentcaton C, Authentcaton detailsPull_ListPropTypes_RQ/Authentcaton/UserName


Pull_ListPropTypes_RQ/Authentcaton/Password


2.1.2.2.1. Example<Pull_ListPropTypes_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListPropTypes_RQ>

2.1.2.3. ResponseXML Path Data Type Type DescriptioPull_ListPropTypes_RS C Root elementPull_ListPropTypes_RS/Status String(100

) See ListStatuses

Pull_ListPropTypes_RS/Status@ID Integer See ListStatusesPull_ListPropTypes_RS/PropertyTypes C, A collecton of property

typesPull_ListPropTypes_RS/PropertyTypes/PropertyType

String(50) Descripton of property type

Pull_ListPropTypes_RS/PropertyTypes/PropertyTypes@PropertyTypeID

Integer Property's unique ID type

2.1.2.3.1. Example<Pull_ListPropTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyTypes> <PropertyType PropertyTypeID=”1”>Studio</PropertyType> <PropertyType PropertyTypeID=”2”>One bedroom</PropertyType> <PropertyType PropertyTypeID=”3”>Two bedroom</PropertyType> <PropertyType PropertyTypeID=”4”>Three bedroom</PropertyType> <PropertyType PropertyTypeID=”12”>Four bedroom</PropertyType> </PropertyTypes></Pull_ListPropTypes_RS>

2.1.3. List OTA property types

2.1.3.1. UsageThis method returns property types in accordance to Open Travel Alliance standards.


Pull_ListOTAPropTypes_RQ C Root elementPull_ListOTAPropTypes_RQ/Authentcaton C, Authentcaton detailsPull_ListOTAPropTypes_RQ/Authentcaton/U String (50) Provided by RU

RENTALSUNITED


serNamePull_ListOTAPropTypes_RQ/Authentcaton/Password


2.1.3.2.1. Example<Pull_ListOTAPropTypes_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListOTAPropTypes_RQ>

2.1.3.3. ResponseXML Path Data Type Type DescriptioPull_ListOTAPropTypes_RS C Root elementPull_ListOTAPropTypes_RS/Status String

(100) See ListStatuses

Pull_ListOTAPropTypes_RS/Status@ID Integer See ListStatusesPull_ListOTAPropTypes_RS/PropertyTypes C, A collecton of property

typesPull_ListOTAPropTypes_RS/PropertyTypes/PropertyTypes/PropertyType

String (50) Descripton of property type

Pull_ListOTAPropTypes_RS/PropertyTypes/PropertyTypes@PropertyTypeID

Integer The code that uniquely identfes a single property type

Pull_ListOTAPropTypes_RS/PropertyTypes/PropertyTypes@OTACode

Integer Property Type Code according to Open Travel Alliance standard

2.1.3.3.1. Example<Pull_ListOTAPropTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyTypes> <PropertyType PropertyTypeID="3" OTACode="3">Apartment</PropertyType> <PropertyType PropertyTypeID="20" OTACode="20">Hotel</PropertyType> <PropertyType PropertyTypeID="35" OTACode="35">Villa</PropertyType> </PropertyTypes></Pull_ListOTAPropTypes_RS>

2.1.4. List location types

2.1.4.1. UsageThis method returns types of property locaton details.

2.1.4.2. RequestXML Path Data Type Type DescriptioPull_ListLocatonTypes_RQ C Root elementPull_ListLocatonTypes_RQ/Authentcaton C, Authentcaton detailsPull_ListLocatonTypes_RQ/Authentcaton/UserName


Pull_ListLocatonTypes_RQ/Authentcaton/Password

RENTALSUNITED


2.1.4.2.1. Example<Pull_ListLocatonTypes_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListLocatonTypes_RQ>

2.1.4.3. ResponseXML Path Data Type Type DescriptioPull_ListLocatonTypes_RS C Root elementPull_ListLocatonTypes_RS/Status String(100

) See ListStatuses

Pull_ListLocatonTypes_RS/Status@ID Integer See ListStatusesPull_ListLocatonTypes_RS/LocatonTypes C, A collecton of all locaton

typesPull_ListLocatonTypes_RS/LocatonTypes/LocatonType

String(50) A descripton of the locaton type

Pull_ListLocatonTypes_RS/LocatonTypes/LocatonType@LocatonTypeID

Integer The code that uniquely identfes a single locaton type

2.1.4.3.1. Example<Pull_ListLocatonTypes_RS> <Status ID="0">Success</Status> <ResponseId>0123456789ABCDEF0123456789ABCDEF</ResponseId> <LocatonTypes> <LocatonType LocatonTypeID="1">Contnent</LocatonType> <LocatonType LocatonTypeID=”2”>Country</LocatonType> <LocatonType LocatonTypeID=”3”>Region</LocatonType> <LocatonType LocatonTypeID=”4”>City</LocatonType> <LocatonType LocatonTypeID=”5”>District</LocatonType> </LocatonTypes></Pull_ListLocatonTypes_RS>

2.1.5. List locations

2.1.5.1. UsageThis method returns all locatons.

2.1.5.2. RequestXML Path Data Type Type DescriptioPull_ListLocatons_RQ C Root elementPull_ListLocatons_RQ/Authentcaton C Authentcaton detailsPull_ListLocatons_RQ/Authentcaton/UserName


Pull_ListLocatons_RQ/Authentcaton/Password


2.1.5.2.1. Example<Pull_ListLocatons_RQ> <Authentcaton>

RENTALSUNITED


<UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListLocatons_RQ>

2.1.5.3. ResponseXML Path Data Type Type DescriptioPull_ListLocatons_RS C Root elementPull_ListLocatons_RS/Status String(100

) See ListStatuses

Pull_ListLocatons_RS/Status@ID Integer See ListStatusesPull_ListLocatons_RS/Locatons C, A collecton of locatonsPull_ListLocatons_RS/Locatons/Locaton String(50) A descripton of the

locatonPull_ListLocatons_RS/Locatons/Locaton@LocatonID

Integer Locaton's unique ID

Pull_ListLocatons_RS/Locatons/Locaton@LocatonTypeID


Pull_ListLocatons_RS/Locatons/Locaton@ParentLocatonID

Integer The code that identfes the locaton containing the selected locaton

2.1.5.3.1. Example<Pull_ListLocatons_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Locatons> <Locaton LocatonID="1" LocatonTypeID="1" ParentLocatonID="0">Europe</Locaton> <Locaton LocatonID="100" LocatonTypeID="2" ParentLocatonID="1">Spain</Locaton> <Locaton LocatonID="200" LocatonTypeID="3" ParentLocatonID="100">Catalonia</Locaton> <Locaton LocatonID="500" LocatonTypeID="4" ParentLocatonID="200">Barcelona</Locaton> <Locaton LocatonID="800" LocatonTypeID="5" ParentLocatonID="500">Gracia</Locaton> </Locatons></Pull_ListLocatons_RS>

2.1.6. Get location details

2.1.6.1. UsageThis method returns the locaton details in a parent-child way. All of the locatons that are in parent-child connecton with the requested locaton will be returned.

2.1.6.2. RequestXML Path Data Type Type DescriptioPull_GetLocatonDetails_RQ C Root elementPull_GetLocatonDetails_RQ/Authentcaton C, Authentcaton detailsPull_GetLocatonDetails_RQ/Authentcaton/UserName


Pull_GetLocatonDetails_RQ/Authentcaton/Password


Pull_GetLocatonDetails_RQ/LocatonID Integer Locaton's unique ID

RENTALSUNITED


2.1.6.2.1. Example<Pull_GetLocatonDetails_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LocatonID>500</LocatonID></Pull_GetLocatonDetails_RQ>

2.1.6.3. ResponseXML Path Data Type Type DescriptioPull_GetLocatonDetails_RS C Root elementPull_GetLocatonDetails_RS/Status String


Pull_GetLocatonDetails_RS/Status@ID Integer See ListStatusesPull_GetLocatonDetails_RS/Locatons C A collecton of locatonsPull_GetLocatonDetails_RS/Locatons/Locaton

String(50)

A descripton of the locaton

Pull_GetLocatonDetails_RS/Locatons/Locaton@LocatonID

Integer Locaton's single ID

Pull_GetLocatonDetails_RS/Locatons/Locaton@LocatonTypeID


Pull_GetLocatonDetails_RS/Locatons/Locaton@ParentLocatonID

Integer The code that identtes the locaton containing the selected locaton

2.1.6.3.1. Example<Pull_GetLocatonDetails_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Locatons> <Locaton LocatonID="1" LocatonTypeID="6" ParentLocatonID="-1">Worldwide</Locaton> <Locaton LocatonID="2" LocatonTypeID="1" ParentLocatonID="1">Europe</Locaton> <Locaton LocatonID="10" LocatonTypeID="2" ParentLocatonID="2" >Belgium</Locaton> <Locaton LocatonID="10054" LocatonTypeID="3" ParentLocatonID="10" >Wallonia</Locaton> <Locaton LocatonID="500" LocatonTypeID="4" ParentLocatonID="10054" >Dufet</Locaton> </Locatons></Pull_GetLocatonDetails_RS>

2.1.7. Get location by name

2.1.7.1. UsageThis method fnds a locaton using the specifed name.

2.1.7.2. RequestXML Path Data Type Type DescriptioPull_GetLocatonByName_RQ C Root elementPull_GetLocatonByName_RQ/Authentcaton C, Authentcaton detailsPull_GetLocatonByName_RQ/Authentcaton/UserName


Pull_GetLocatonByName_RQ/Authentcaton String(50) Provided by RU

RENTALSUNITED


/PasswordPull_GetLocatonByName_RQ/LocatonName String(50) Locaton name

2.1.7.2.1. Example<Pull_GetLocatonByName_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LocatonName> Łomża</LocatonName></Pull_GetLocatonByName_RQ>

2.1.7.3. ResponseXML Path Data Type Type DescriptioPull_GetLocatonByName_RS C Root elementPull_GetLocatonByName_RS/Status String


Pull_GetLocatonByName_RS/Status@ID Integer See ListStatusesPull_GetLocatonByName_RS/LocatonID Integer A collecton of locatonsPull_GetLocatonDetails_RS/Locatons/Locaton

String(50)

Locaton's unique ID

2.1.7.3.1. Example<Pull_GetLocatonByName_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <LocatonID>321</Locatons></Pull_GetLocatonByName_RS>

2.1.8. Get location by coordinates

2.1.8.1. UsageThis method fnds a locaton using the specifed geographical coordinates.

2.1.8.2. RequestXML Path Data Type Type DescriptioPull_GetLocatonByCoordinates_RQ C Root elementPull_GetLocatonByCoordinates_RQ/Authentcaton

C, Authentcaton details

Pull_GetLocatonByCoordinates_RQ/Authentcaton/UserName


Pull_GetLocatonByCoordinates_RQ/Authentcaton/Password


Pull_GetLocatonByCoordinates_RQ/Lattude Decimal LattudePull_GetLocatonByCoordinates_RQ/Longitude

Decimal Longitude

2.1.8.2.1. Example<Pull_GetLocatonByCoordinates_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton>

RENTALSUNITED


<Lattude>10.12312</Lattude> <Longitude>22.23123</Longitude></Pull_GetLocatonByCoordinates_RQ>

2.1.8.3. ResponseXML Path Data Type Type DescriptioPull_GetLocatonByCoordinates_RS C Root elementPull_GetLocatonByCoordinates_RS/Status String


Pull_GetLocatonByCoordinates_RS/Status@ID

Integer See ListStatuses

Pull_GetLocatonByCoordinates_RS/Locatons/Locaton

Collecton of informaton

Pull_GetLocatonByCoordinates_RS/LocatonID


Pull_GetLocatonByCoordinates_RS/Locatons/Distance

Decimal Distance between the coordinates and that locaton's center

2.1.8.3.1. Example<Pull_GetLocatonByCoordinates_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Locaton LocatonID="321" Distance="3.32">Test locaton</Locaton></Pull_GetLocatonByCoordinates_RS>

2.1.9. Get cities and number of properties

2.1.9.1. UsageThis method returns the number of actve propertes in each city. Cites with no actve propertes are ignored.

2.1.9.2. RequestXML Path Data Type Type DescriptioPull_ListCitesProps_RQ C Root elementPull_ListCitesProps_RQ/Authentcaton C, Authentcaton detailsPull_ListCitesProps_RQ/Authentcaton/UserName


Pull_ListCitesProps_RQ/Authentcaton/Password


2.1.9.2.1. Example<Pull_ListCitesProps_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListCitesProps_RQ>

2.1.9.3. ResponseXML Path Data Type Type Descriptio

RENTALSUNITED


Pull_ListCitesProps_RS C Root elementPull_ListCitesProps_RS/Status String


Pull_ListCitesProps_RS/Status@ID Integer See ListStatusesPull_ListCitesProps_RS/CitesProps C A collecton of cites

(locatons with city type)Pull_ListCitesProps_RS/CitesProps/CityProps Integer The number of actve

propertes in the specifed city

Pull_ListCitesProps_RS/CitesProps/CityProps@LocatonID


2.1.9.3.1. Example<Pull_ListCitesProps_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <CitesProps> <CityProps LocatonID="1">10</CityProps> <CityProps LocatonID="2">1</CityProps> <CityProps LocatonID="8">3</CityProps> </CitesProps></Pull_ListCitesProps_RS>

2.1.10. List cities and currencies

2.1.10.1. UsageThis method returns currency informaton. RU defnes the currency for each city (Locatons with LocatonTypeID=4). You have to upload the prices (nightly prices, cancellaton fees, additonal fees etc.) in the proper currency i.e. for propertes located in Barcelona you have to upload the prices inEUR. The link between the city and the currency is fxed (you do not have to update it periodically).

Please note: The city's district has the same currency as the parent city.

2.1.10.2. RequestXML Path Data Type Type DescriptioPull_ListCurrenciesWithCites_RQ C Root elementPull_ListCurrenciesWithCites_RQ/Authentcaton


Pull_ListCurrenciesWithCites_RQ/Authentcaton/UserName


Pull_ListCurrenciesWithCites_RQ/Authentcaton/Password


2.1.10.2.1. Example<Pull_ListCurrenciesWithCites_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListCurrenciesWithCites_RQ>

RENTALSUNITED


Pull_ListCurrenciesWithCites_RS C Root elementPull_ListCurrenciesWithCites_RS/Status String


Pull_ListCurrenciesWithCites_RS/Status@ID Integer See ListStatusesPull_ListCurrenciesWithCites_RS/Currencies C, A collecton of currenciesPull_ListCurrenciesWithCites_RQ/Currencies/Currency

A single currency with the cites informaton

Pull_ListCurrenciesWithCites_RS/Currencies/Currency@CurrencyCode

String(3) The code that uniquely identfes a single currency, its ISO 4217code

Pull_ListCurrenciesWithCites_RQ/Currencies/Currency/Locatons

C, A collecton of cites where the currency applies

Pull_ListCurrenciesWithCites_RQ/Currencies/Currency/Locatons/LocatonID

Integer Locaton's unique ID (it's always a city, LocatonTypeID=4)

2.1.10.3.1. Example<Pull_ListCurrenciesWithCites_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Currencies> <Currency CurrencyCode="AUD"> <Locatons> <LocatonID>8694</LocatonID> <LocatonID>8718</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="CAD"> <Locatons> <LocatonID>5032</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="CHF"> <Locatons> <LocatonID>7222</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="EUR"> <Locatons> <LocatonID>7048</LocatonID> <LocatonID>3206</LocatonID> <LocatonID>4898</LocatonID> <LocatonID>5964</LocatonID> <LocatonID>3191</LocatonID> <LocatonID>8752</LocatonID> <LocatonID>2958</LocatonID> <LocatonID>3119</LocatonID> <LocatonID>2986</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="GBP"> <Locatons> <LocatonID>7752</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="PLN">

RENTALSUNITED


<Locatons> <LocatonID>5319</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="USD"> <Locatons> <LocatonID>5514</LocatonID> </Locatons> </Currency> <Currency CurrencyCode="ZAR"> <Locatons> <LocatonID>6169</LocatonID> </Locatons> </Currency> </Currencies></Pull_ListCurrenciesWithCites_RS>

2.1.11. List destinations

2.1.11.1. UsageThis method returns all destnaton types.

2.1.11.2. RequestXML Path Data Type Type DescriptioPull_ListDestnatons_RQ C Root elementPull_ListDestnatons_RQ/Authentcaton C, Authentcaton detailsPull_ListDestnatons_RQ/Authentcaton/UserName


Pull_ListDestnatons_RQ/Authentcaton/Password


2.1.11.2.1. Example<Pull_ListDestnatons_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListDestnatons_RQ>

2.1.11.3. ResponseXML Path Data Type Type DescriptioPull_ListDestnatons_RS C Root elementPull_ListDestnatons_RS/Status String


Pull_ListDestnatons_RS/Status@ID Integer See ListStatusesPull_ListDestnatons_RS/Destnatons C, A collecton of destnatonsPull_ListDestnatons_RQ/Destnatons/Destnaton

String (200)

A descripton of the destnaton

Pull_ListDestnatons_RS/Destnatons/Destnaton@DestnatonID

Integer The code that uniquely identfes a single destnaton

RENTALSUNITED


2.1.11.3.1. Example<Pull_ListDestnatons_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Destnatons> <Destnaton DestnatonID="8">Sea</Destnaton> <Destnaton DestnatonID="26">Airport</Destnaton> <Destnaton DestnatonID="97"> ain Railway Staton</Destnaton> </Destnatons></Pull_ListDestnatons_RS>

2.1.12. List distance units

2.1.12.1. UsageThis method returns distance unit types.

2.1.12.2. RequestXML Path Data Type Type DescriptioPull_ListDistanceUnits_RQ C Root elementPull_ListDistanceUnits_RQ/Authentcaton C, Authentcaton detailsPull_ListDistanceUnits_RQ/Authentcaton/UserName


Pull_ListDistanceUnits_RQ/Authentcaton/Password


2.1.12.2.1. Example<Pull_ListDistanceUnits_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListDistanceUnits_RQ>

2.1.12.3. ResponseXML Path Data Type Type DescriptioPull_ListDistanceUnits_RS C Root elementPull_ListDistanceUnits_RS/Status String


Pull_ListDistanceUnits_RS/Status@ID Integer See ListStatusesPull_ListDistanceUnits_RS/DistanceUnits C A collecton of distance

unitsPull_ListDistanceUnits_RS/DistanceUnits/DistanceUnit

String(50) A descripton of distance unit

Pull_ListDistanceUnits_RS/DistanceUnits/DistanceUnit@DistanceUnitID

Integer The code that uniquely identfes a single distance unit

2.1.12.3.1. Example<Pull_ListDistanceUnits_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <DistanceUnits>

RENTALSUNITED


<DistanceUnit DistanceUnitID="1">meters</DistanceUnit> <DistanceUnit DistanceUnitID="2">minutes</DistanceUnit> <DistanceUnit DistanceUnitID="3">km</DistanceUnit> </DistanceUnits></Pull_ListDistanceUnits_RS>

2.1.13. List composition rooms

2.1.13.1. UsageThis method returns the list of room types available in the property (its room compositon).

2.1.13.2. RequestXML Path Data Type Type DescriptioPull_ListCompositonRooms_RQ C Root elementPull_ListCompositonRooms_RQ/Authentcaton


Pull_ListCompositonRooms_RQ/Authentcaton/UserName


Pull_ListCompositonRooms_RQ/Authentcaton/Password


2.1.13.2.1. Example<Pull_ListCompositonRooms_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListCompositonRooms_RQ>

2.1.13.3. ResponseXML Path Data Type Type DescriptioPull_ListCompositonRooms_RS C Root elementPull_ListCompositonRooms_RS/Status String(100

) See ListStatuses

Pull_ListCompositonRooms_RS/Status@ID Integer See ListStatusesPull_ListCompositonRooms_RS/CompositonRooms

C, A collecton of types of rooms

Pull_ListCompositonRooms_RS/CompositonRooms/CompositonRoom

String(100)

A descripton of the room type

Pull_ListCompositonRooms_RS/CompositonRooms/CompositonRoomID

Integer The code that uniquely identfes a single room type

2.1.13.3.1. Example<Pull_ListCompositonRooms_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <CompositonRooms> <CompositonRoom CompositonRoomID="53">WC</CompositonRoom> <CompositonRoom CompositonRoomID="81">Bathroom</CompositonRoom> <CompositonRoom CompositonRoomID="94">Kitchen in the living / dining room</CompositonRoom> <CompositonRoom CompositonRoomID="101">Kitchen</CompositonRoom>

RENTALSUNITED


<CompositonRoom CompositonRoomID="249">Living Room</CompositonRoom> <CompositonRoom CompositonRoomID="257">Bedroom</CompositonRoom> <CompositonRoom CompositonRoomID="372">Livingroom</CompositonRoom> <CompositonRoom CompositonRoomID="517">Bedroom/Living room with kitchen corner</CompositonRoom> </CompositonRooms></Pull_ListCompositonRooms_RS>

2.1.14. List amenities

2.1.14.1. UsageThis method returns the list of amenites .

2.1.14.2. RequestXML Path Data Type Type DescriptioPull_ListAmenites_RQ C Root elementPull_ListAmenites_RQ/Authentcaton C, Authentcaton detailsPull_ListAmenites_RQ/Authentcaton/UserName


Pull_ListAmenites_RQ/Authentcaton/Password


2.1.14.2.1. Example<Pull_ListAmenites_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListAmenites_RQ>

2.1.14.3. ResponseXML Path Data Type Type DescriptioPull_ListAmenites_RS C Root elementPull_ListAmenites_RS/Status String(100

) See ListStatuses

Pull_ListAmenites_RS/Status@ID Integer See ListStatusesPull_ListAmenites_RS/Amenites C A collecton of amenitesPull_ListAmenites_RS/Amenity String(200

) A descripton of the

amenityPull_ListAmenites_RS/Amenity@AmenityID Integer The code that uniquely

identfes a single amenity

2.1.14.3.1. Example<Pull_ListAmenites_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Amenites> <Amenity AmenityID="2">Cookware & Kitchen Utensils</Amenity> <Amenity AmenityID="3">Crockery & Cutlery</Amenity> <Amenity AmenityID="4">Iron & Ironing Board</Amenity> <Amenity AmenityID="5">Drying Rack</Amenity> </Amenites></Pull_ListAmenites_RS>

RENTALSUNITED


2.1.15. List amenities available for room

2.1.15.1. UsageThis method returns the amenites available in a given room type.

2.1.15.2. RequestXML Path Data Type Type DescriptioPull_ListAmenitesAvailableForRooms_RQ C Root elementPull_ListAmenitesAvailableForRooms_RQ/Authentcaton


Pull_ListAmenitesAvailableForRooms_RQ/Authentcaton/UserName


Pull_ListAmenitesAvailableForRooms_RQ/Authentcaton/Password


2.1.15.2.1. Example<Pull_ListAmenitesAvailableForRooms_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListAmenitesAvailableForRooms_RQ>

2.1.15.3. ResponseXML Path Data Type Type DescriptioPull_ListAmenitesAvailableForRooms_RS C Root elementPull_ListAmenitesAvailableForRooms_RS/Status

String(100)

See ListStatuses

Pull_ListAmenitesAvailableForRooms_RS/Status@ID


Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms

C A collecton of amenites available for rooms

Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms/AmenitesAvailableForRoom

C A collecton of amenites available for a given room type

Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms/AmenitesAvailableForRoom@CompositonRoom

String(100)

A descripton of compositon room, see ListCompositonRooms

Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms/AmenitesAvailableForRoom@CompositonRoom

The code that uniquely identfes a single compositon room, see ListCompositonRooms

Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms/AmenitesAvailableForRoom/Amenity

String(200)

A descripton of the amenity, see ListAmenites

Pull_ListAmenitesAvailableForRooms_RS/AmenitesAvailableForRooms/AmenitesAvailableForRoom/Amenity@AmenityID

Integer The code that uniquely identfes a single amenity, see ListAmenites

RENTALSUNITED


2.1.15.3.1. Example<Pull_ListAmenitesAvailableForRooms_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <AmenitesAvailableForRooms> <AmenitesAvailableForRoom CompositonRoom="WC" CompositonRoomID="53"> <Amenity AmenityID="29">bidet</Amenity> <Amenity AmenityID="37">toilet</Amenity> <Amenity AmenityID="78">chest of drawers</Amenity> <Amenity AmenityID="245">washbasin</Amenity> </AmenitesAvailableForRoom> <AmenitesAvailableForRoom CompositonRoom="Bathroom" CompositonRoomID="81"> <Amenity AmenityID="4">Iron & Ironing Board</Amenity> <Amenity AmenityID="5">Drying Rack</Amenity> <Amenity AmenityID="6">Hair Dryer</Amenity> </AmenitesAvailableForRoom> <AmenitesAvailableForRoom CompositonRoom="Kitchen in the living / dining room" CompositonRoomID="94"> <Amenity AmenityID="2">Iron & Ironing Board</Amenity> <Amenity AmenityID="3">Crockery & Cutlery</Amenity> <Amenity AmenityID="11">Washing achine</Amenity> </AmenitesAvailableForRoom> <AmenitesAvailableForRoom CompositonRoom="Kitchen" CompositonRoomID="101"> <Amenity AmenityID="2">Cookware & Kitchen Utensils</Amenity> <Amenity AmenityID="3">Crockery & Cutlery</Amenity> <Amenity AmenityID="11">Washing achine</Amenity> <Amenity AmenityID="13">Dishwasher</Amenity> </AmenitesAvailableForRoom> </AmenitesAvailableForRooms></Pull_ListAmenitesAvailableForRooms_RS>

2.1.16. List image types

2.1.16.1. UsageThis method returns all image types.

2.1.16.2. RequestXML Path Data Type Type DescriptioPull_ListImageTypes_RQ C Root elementPull_ListImageTypes_RQ/Authentcaton C, Authentcaton detailsPull_ListImageTypes_RQ/Authentcaton/UserName


Pull_ListImageTypes_RQ/Authentcaton/Password


2.1.16.2.1. Example<Pull_ListImageTypes_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListImageTypes_RQ>

RENTALSUNITED


Pull_ListImageTypes_RS C Root elementPull_ListImageTypes_RS/Status String


Pull_ListImageTypes_RS/Status@ID Integer See ListStatusesPull_ListImageTypes_RS/ImageTypes C, A collecton of image typesPull_ListImageTypes_RS/ImageTypes/ImageType

String(50) A descripton of the image type

Pull_ListImageTypes_RS/ImageTypes/ImageType@ImageTypeID

Integer The code that uniquely identfes a single image type

2.1.16.3.1. Example<Pull_ListImageTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <ImageTypes> <ImageType ImageTypeID="1"> ain Image</ImageType> <ImageType ImageTypeID="2">Property Plan</ImageType> </ImageTypes></Pull_ListImageTypes_RS>

2.1.17. List payment methods

2.1.17.1. UsageThis method returns all payment methods.

2.1.17.2. RequestXML Path Data Type Type DescriptioPull_ListPayment ethods_RQ C Root elementPull_ListPayment ethods_RQ/Authentcaton


Pull_ListPayment ethods_RQ/Authentcaton/UserName


Pull_ListPayment ethods_RQ/Authentcaton/Password


2.1.17.2.1. Example<Pull_ListPayment ethods_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListPayment ethods_RQ>

2.1.17.3. ResponseXML Path Data Type Type DescriptioPull_ListPayment ethods_RS C Root elementPull_ListPayment ethods_RS/Status String(100

) See ListStatuses

Pull_ListPayment ethods_RS/Status@ID Integer See ListStatusesPull_ListPayment ethods_RS/Payment eth C, A collecton of payment

RENTALSUNITED


ods methodsPull_ListPayment ethods_RS/Payment ethods/Payment ethod

String(100)

A descripton of the payment method

Pull_ListPayment ethods_RS/Payment ethods/Payment ethod@Payment ethodID

Integer The code that uniquely identfes a single payment method

2.1.17.3.1. Example<Pull_ListPayment ethods_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Payment ethods> <Payment ethod Payment ethodID="1"> bank transfer </Payment ethod> <Payment ethod Payment ethodID="2"> Credit card </Payment ethod> <Payment ethod Payment ethodID="3"> Cash </Payment ethod> <Payment ethod Payment ethodID="4"> PayPal </Payment ethod> <Payment ethod Payment ethodID="5"> Other method </Payment ethod> </Payment ethods></Pull_ListPayment ethods_RS>

2.1.18. List reservation statuses

2.1.18.1. UsageThis method returns all reservaton statuses.

2.1.18.2. RequestXML Path Data Type Type DescriptioPull_ListReservatonStatuses_RQ C Root elementPull_ListReservatonStatuses_RQ/Authentcaton


Pull_ListReservatonStatuses_RQ/Authentcaton/UserName


Pull_ListReservatonStatuses_RQ/Authentcaton/Password


2.1.18.2.1. Example<Pull_ListReservatonStatuses_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListReservatonStatuses_RQ>

RENTALSUNITED


2.1.18.3. ResponseXML Path Data Type Type DescriptioPull_ListReservatonStatuses_RS C Root elementPull_ListReservatonStatuses_RS/Status String(100

) See ListStatuses

Pull_ListReservatonStatuses_RS/Status@ID Integer See ListStatusesPull_ListReservatonStatuses_RS/ReservatonStatuses

C, A collecton of reservaton statuses

Pull_ListReservatonStatuses_RS/ReservatonStatuses/ReservatonStatus

String(100)

A descripton of the reservaton status

Pull_ListReservatonStatuses_RS/ReservatonStatuses/ReservatonStatus@ReservatonStatusID

Integer The code that uniquely identfes a single reservaton status

2.1.18.3.1. Example<Pull_ListReservatonStatuses_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <ReservatonStatuses> <ReservatonStatus ReservatonStatusID="1"> Confrmed </ReservatonStatus> < ReservatonStatus ReservatonStatusID="2"> Cancelled </ReservatonStatus> < ReservatonStatus ReservatonStatusID="3"> odifed </ReservatonStatus> </ReservatonStatuses></Pull_ListReservatonStatuses_RS>

2.1.19. List deposit types

2.1.19.1. UsageThe method returns all deposit types.

2.1.19.2. RequestXML Path Data Type Type DescriptioPull_ListDepositTypes_RQ C Root elementPull_ListDepositTypes_RQ/Authentcaton C, Authentcaton detailsPull_ListDepositTypes_RQ/Authentcaton/UserName


Pull_ListDepositTypes_RQ/Authentcaton/Password


2.1.19.2.1. Example<Pull_ListDepositTypes_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListDepositTypes_RQ>

RENTALSUNITED


2.1.19.3. ResponseXML Path Data Type Type DescriptioPull_ListDepositTypes_RS C Root elementPull_ListDepositTypes_RS/Status String(100

) See ListStatuses

Pull_ListDepositTypes_RS/Status@ID Integer See ListStatusesPull_ListDepositTypes_RS/DepositTypes C, A collecton of deposit

typesPull_ListDepositTypes_RS/DepositTypes/DepositType

String(50) A descripton of the deposittype

Pull_ListDepositTypes_RS/DepositTypes/DepositType@DepositTypeID

Integer The code that uniquely identfes a single deposit type

2.1.19.3.1. Example<Pull_ListDepositTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <DepositTypes> <DepositType DepositTypeID="1">No deposit</DepositType> <DepositType DepositTypeID="2">Percentage of total price (without cleaning)</DepositType> <DepositType DepositTypeID="3">Percentage of total price</DepositType> <DepositType DepositTypeID="4">Fixed amount per day</DepositType> <DepositType DepositTypeID="5">Flat amount per stay</DepositType> </DepositTypes></Pull_ListDepositTypes_RS>

2.1.20. List languages

2.1.20.1. UsageThe method returns all available languages.

2.1.20.2. RequestXML Path Data Type Type DescriptioPull_ListLanguages_RQ C Root elementPull_ListLanguages_RQ/Authentcaton C, Authentcaton detailsPull_ListLanguages_RQ/Authentcaton/UserName


Pull_ListLanguages_RQ/Authentcaton/Password


2.1.20.2.1. Example<Pull_ListLanguages_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListLanguages_RQ>

2.1.20.3. ResponseXML Path Data Type Type DescriptioPull_ListLanguages_RS C Root element

RENTALSUNITED


Pull_ListLanguages_RS/Status String(100)

See ListStatuses

Pull_ListLanguages_RS/Status@ID Integer See ListStatusesPull_ListLanguages_RS/Languages C, A collecton of languagesPull_ListLanguages_RS/Languages/Language String(50) A descripton of languagePull_ListLanguages_RS/Languages/Language@LanguageID

Integer The code that uniquely identfes a single language

Pull_ListLanguages_RS/Languages/Language@LanguageCode

String(2) The ISO 639-1code that uniquely identfes a single language

2.1.20.3.1. Example<Pull_ListLanguages_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Languages> <Language LanguageID="1" LanguageCode="en">English</Language> <Language LanguageID="2" LanguageCode="de">German</Language> <Language LanguageID="3" LanguageCode="pl">Polish</Language> </Languages></Pull_ListLanguages_RS>

2.1.21. List property external statuses

2.1.21.1. UsageThe method returns all available statuses for a property in external systems.

2.1.21.2. RequestXML Path Data Type Type DescriptioPull_ListPropExtStatuses_RQ C Root elementPull_ListPropExtStatuses_RQ/Authentcaton C, Authentcaton detailsPull_ListPropExtStatuses_RQ/Authentcaton/UserName


Pull_ListPropExtStatuses_RQ/Authentcaton/Password


2.1.21.2.1. Example<Pull_ListPropExtStatuses_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListPropExtStatuses_RQ>

2.1.21.3. ResponseXML Path Data Type Type DescriptioPull_ListPropExtStatuses_RS C Root elementPull_ListPropExtStatuses_RS/Status String(100

) See ListStatuses

Pull_ListPropExtStatuses_RS/Status@ID Integer See ListStatusesPull_ListPropExtStatuses_RS/PropertyExternalStatuses

C, A collecton of statuses

RENTALSUNITED


Pull_ListPropExtStatuses_RS/PropertyExternalStatuses/Status

String(50) A descripton of status

Pull_ListPropExtStatuses_RS/PropertyExternalStatuses/Status@ID

Integer The code that uniquely identfes a single status

Status descripton:• online – property is online/live/bookable on the partner's website• offline – property is not online/not live/not bookable on the partner's website• missing data – property has missing apartment details required by the partner's website• requested publishing – owner has requested his property to be published on the partner's website• requested removal – owner has requested his property to be removed from the partner's website• disconnected – the property has been disconnected from the channel• requested update – an update to the property has been requested• requested deactvaton – the property has been requested as deactvated

2.1.21.3.1. Example<Pull_ListPropExtStatuses_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyExternalStatuses> <Status ID="1">Online</Status> <Status ID="2">Offline</Status> <Status ID="3"> issing data</Status> <Status ID="4">Requested publishing</Status> <Status ID="5">Requested removal</Status> <Status ID="6">Disconnected</Status> <Status ID="7”>Requested update</Status> <Status ID="8">Requested deactvaton</Status> </PropertyExternalStatuses></Pull_ListPropExtStatuses_RS>

2.1.22. List changeover types

2.1.22.1. UsageThis method returns all changeover types.

2.1.22.2. RequestXML Path Date Type Type Description

Pull_ListChangeoverTypes_RQ C Root element

Pull_ListChangeoverTypes_RQ/Authentcaton C, Authentcaton details

Pull_ListChangeoverTypes_RQ/Authentcaton/UserName


Pull_ListChangeoverTypes_RQ/Authentcaton/Password


2.1.22.2.1. Example<Pull_ListChangeoverTypes_RQ> <Authentcaton> <UserName>test</UserName> <Password>test</Password>

RENTALSUNITED


</Authentcaton></Pull_ListChangeoverTypes_RQ>

2.1.22.3. ResponseXML Path Date Type Type Description

Pull_ListChangeoverTypes_RS C Root element

Pull_ListChangeoverTypes_RS/Status String(100)

C, Status descripton

Pull_ListChangeoverTypes_RS/Status@ID Integer Status ID

Pull_ListChangeoverTypes_RS/ChangeoverTypes A collecton of changeover types

Pull_ListChangeoverTypes_RS/ChangeoverTypes/ChangeoverType

String(100)

Changeover type descripton

Pull_ListChangeoverTypes_RS/ChangeoverTypes/ChangeoverType@ID

Integer Changeover type ID

2.1.22.3.1. Example<Pull_ListChangeoverTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <ChangeoverTypes> <ChangeoverType ChangeoverTypeID="1">CheckIn</ChangeoverType> <ChangeoverType ChangeoverTypeID="2">CheckOut</ChangeoverType> <ChangeoverType ChangeoverTypeID="3">None</ChangeoverType> <ChangeoverType ChangeoverTypeID="4">Both</ChangeoverType> </ChangeoverTypes></Pull_ListChangeoverTypes_RS>

2.1.23. List additional fee kinds

2.1.23.1. UsageThis method returns all additonal fee kinds.


Pull_ListAdditonalFeeKinds_RQ C Root element

Pull_ListAdditonalFeeKinds_RQ/Authentcaton C, Authentcaton details

Pull_ListAdditonalFeeKinds_RQ/Authentcaton/UserName


Pull_ListAdditonalFeeKinds_RQ/Authentcaton/Password


2.1.23.2.1. Example<Pull_ListAdditonalFeeKinds_RQ> <Authentcaton> <UserName>test</UserName> <Password>test</Password> </Authentcaton></Pull_ListAdditonalFeeKinds_RQ>

RENTALSUNITED


2.1.23.3. ResponseXML Path Data Type Type DescriptioPull_ListAdditonalFeeKinds_RS C Root elementPull_ListAdditonalFeeKinds_RS/Status String(100

) Status descripton

Pull_ListAdditonalFeeKinds_RS/Status@ID Integer Status IDPull_ListAdditonalFeeKinds_RS/AdditonalFeeKinds

C A collecton of additonal fee kinds

Pull_ListAdditonalFeeKinds_RS/AdditonalFeeKinds/AdditonalFeeKindInfo

String(100)

Kind descripton

Pull_ListAdditonalFeeKinds_RS/AdditonalFeeKinds/AdditonalFeeKindInfo@ID

Integer Kind ID

2.1.23.3.1. Example<Pull_ListAdditionalFeeKinds_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <AdditionalFeeKinds> <AdditionalFeeKindInfo ID="1">Tax - a kind representing generic tax value</AdditionalFeeKindInfo> </AdditionalFeeKinds></Pull_ListAdditionalFeeKinds_RS>

2.1.24. List additional fee discriminators

2.1.24.1. UsageThis method returns all additonal fee discriminators.


Pull_ListAdditonalFeeDiscriminators_RQ C Root element

Pull_ListAdditonalFeeDiscriminators_RQ/Authentcaton


Pull_ListAdditonalFeeDiscriminators_RQ/Authentcaton/UserName


Pull_ListAdditonalFeeDiscriminators_RQ/Authentcaton/Password


2.1.24.2.1. Example<Pull_ListAdditonalFeeDiscriminators_RQ> <Authentcaton> <UserName>test</UserName> <Password>test</Password> </Authentcaton></Pull_ListAdditonalFeeDiscriminators_RQ>

2.1.24.3. ResponseXML Path Data Type Type DescriptioPull_ListAdditonalFeeDiscriminators_RS C Root elementPull_ListAdditonalFeeDiscriminators_RS/Stat String(100 Status descripton

RENTALSUNITED


us )Pull_ListAdditonalFeeDiscriminators_RS/Status@ID

Integer Status ID

Pull_ListAdditonalFeeDiscriminators_RS/AdditonalFeeDiscriminators

C A collecton of additonal fee discriminators

Pull_ListAdditonalFeeDiscriminators_RS/AdditonalFeeDiscriminators/AdditonalFeeDiscriminatorInfo

String(200)

Discriminator descripton

Pull_ListAdditonalFeeDiscriminators_RS/AdditonalFeeDiscriminators/AdditonalFeeDiscriminatorInfo@ID

Integer Discriminator ID

2.1.24.3.1. Example<Pull_ListAdditionalFeeDiscriminators_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <AdditionalFeeDiscriminators> <AdditionalFeeDiscriminatorInfo ID="1">FlatPerStay - a fixed value will be added once per whole stay. Value=10.05 means 10.05 EUR/USD or other currency will be added as additional fee.</AdditionalFeeDiscriminatorInfo> <AdditionalFeeDiscriminatorInfo ID="2">FixedPerDay - a fixed value will be added for each day of stay. Value=10.05 means 10.05 EUR/USD or other currency will be added as additional fee.</AdditionalFeeDiscriminatorInfo> <AdditionalFeeDiscriminatorInfo ID="3">IndependentPercentage - a percentage of total value will be added independently at the end of calculations. Value=0.0123 means 1.23% additional fee will be added.</AdditionalFeeDiscriminatorInfo> <AdditionalFeeDiscriminatorInfo ID="4">CumulativePercentage - a percentage of total value which will be added immediately and will take part in further calculation. Value=0.0123 means 1.23% additional fee will be added.</AdditionalFeeDiscriminatorInfo> </AdditionalFeeDiscriminators></Pull_ListAdditionalFeeDiscriminators_RS>

2.1.25. List additional fee types

2.1.25.1. UsageThis method returns all additonal fee types. If you cannot fnd a proper type, use 0=unknown and contact Rentals United.


Pull_ListAdditonalFeeTypes_RQ C Root element

Pull_ListAdditonalFeeTypes_RQ/Authentcaton C, Authentcaton details

Pull_ListAdditonalFeeTypes_RQ/Authentcaton/UserName


Pull_ListAdditonalFeeTypes_RQ/Authentcaton/Password


2.1.25.2.1. Example<Pull_ListAdditonalFeeTypes_RQ> <Authentcaton> <UserName>test</UserName> <Password>test</Password> </Authentcaton>

RENTALSUNITED


</Pull_ListAdditonalFeeTypes_RQ>

2.1.25.3. ResponseXML Path Data Type Type DescriptioPull_ListAdditonalFeeTypes_RS C Root elementPull_ListAdditonalFeeTypes_RS/Status String(100

) Status descripton

Pull_ListAdditonalFeeTypes_RS/Status@ID Integer Status IDPull_ListAdditonalFeeTypes_RS/AdditonalFeeTypes

C A collecton of additonal fee discriminators

Pull_ListAdditonalFeeTypes_RS/AdditonalFeeTypes/AdditonalFeeTypeInfo

String(200)


Pull_ListAdditonalFeeTypes_RS/AdditonalFeeTypes/AdditonalFeeTypeInfo@ID


2.1.25.3.1. Example<Pull_ListAdditonalFeeTypes_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <AdditionalFeeTypes> <AdditionalFeeTypeInfo ID="1">Local tax</AdditionalFeeTypeInfo> < AdditionalFeeTypeInfo ID="2">VAT</ AdditionalFeeTypeInfo> < AdditionalFeeTypeInfo ID="3">Tourist tax</AdditionalFeeTypeInfo> < AdditionalFeeTypeInfo ID="6">Towels fee</AdditionalFeeTypeInfo> < AdditionalFeeTypeInfo ID="7">Electricity fee</AdditionalFeeTypeInfo> </AdditionalFeeTypes></Pull_ListAdditonalFeeTypes_RS>

2.1.26. List created users

2.1.26.1. UsageThis method returns informatons about users created by authentcated user via RU api


Pull_List yUsers_RQ C Root element

Pull_List yUsers_RQ/Authentcaton C, Authentcaton details

Pull_List yUsers_RQ/Authentcaton/UserName String(50) Provided by RU

Pull_List yUsers_RQ/Authentcaton/Password String(50) Provided by RU

2.1.26.2.1. Example<Pull_List yUsers_RQ> <Authentcaton> <UserName>test</UserName> <Password>test</Password> </Authentcaton><Pull_List yUsers_RQ>

RENTALSUNITED


2.1.26.3. ResponseXML Path Data Type Type DescriptioPull_List yUsers_RS C Root elementPull_List yUsers_RS/Status String(100

) Status descripton

Pull_List yUsers_RS/Status@ID Integer Status IDPull_List yUsers_RS/AdditonalFeeTypes C A collecton of additonal

fee discriminatorsPull_List yUsers_RS/AdditonalFeeTypes/AdditonalFeeTypeInfo

String(200)


Pull_List yUsers_RS /AdditonalFeeTypes/Add itonalFeeTypeInfo@ID


Pull_ListAllOwners_RS/Owners/Owner C, O The details of the ownerPull_ListAllOwners_RS/Owners/Owner@OwnerID

Integer Property's unique ID owner

Pull_ListAllOwners_RS/Owners/Owner/FirstName

String(20) Owner's frst name

Pull_ListAllOwners_RS/Owners/Owner/SurName

String(30) Owner's surname

Pull_ListAllOwners_RS/Owners/Owner/Email String(100)

Owner's email address

Pull_ListAllOwners_RS/Owners/Owner/Phone String (20)

Owner's phone number (with the country code)

Pull_ListAllOwners_RS/Owners/Owner/UserAccountId

Integer O Id that should be used in Push_PutProperty

Pull_ListAllOwners_RS/Owners/Owner/ConfguratonString

String (20)

O Values used to parametrize API Calls to P S

2.1.26.3.1. Example<Pull_List yUsers_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Owners> <Owner OwnerID="1"> <FirstName>John</FirstName> <SurName>Smith</SurName> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <Username>[email protected]</Username> <UserAccountID>123</UserAccountID> <ConfguratonString/> </Owner> </Owners></Pull_List yUsers_RS>

2.1.27. List cancelation types

2.1.27.1. Usage

This method returns information what type of cancelations can be set. Those Ids can be then passed in reservation cancellation function. All of this is optional.


mailto:Pull_ListMyUsers_RS/AdditionalFeeTypes/AdditionalFeeTypeInfo@ID

RENTALSUNITED


2.1.27.2. Request

XML Path Data Type Type DescriptioPull_CancellatonTypes_RQ C Root elementPull_CancellatonTypes_RQ/Authentcaton C, Authentcaton detailsPull_CancellatonTypes_RQ/Authentcaton/UserName


Pull_CancellatonTypes_RQ/Authentcaton/Password


2.1.27.3. Example

<Pull_CancellatonTypes_RQ>

<Authentcaton> <UserName>Login</UserName> <Password>Password</Password> </Authentcaton></Pull_CancellatonTypes_RQ>

2.1.27.4. Response

XML Path Data Type Type DescriptioPull_CancellatonTypes_RS Integer C Root elementPull_CancellatonTypes_RS/Status String(100

) See ListStatuses

Pull_CancellatonTypes_RS/Status@ID Integer See ListStatuses

Pull_CancellatonTypes_RS/CancellatonTypes C, A collecton of cancellaton types

Pull_CancellatonTypes_RS/CancellatonTypes/CancellatonType

C Cancellaton type descripton

Pull_CancellatonTypes_RS/CancellatonTypes/PCancellatonType/@ID

Integer Cancellaton type ID

2.1.27.5. Response

<Pull_CancellatonTypes_RS>

<Status ID="0">Success</Status> <ResponseID>6d8215eb612145058e9c8808cf185986</ResponseID> <CancellatonTypes> <CancellatonType Id="1">Owner</CancellatonType> <CancellatonType Id="2">Guest</CancellatonType> </CancellatonTypes></Pull_CancellatonTypes_RS>

2.1.28. List quote modes.

2.1.28.1. Usage

RENTALSUNITED


This method returns a list of possible quote modes that can be used in put confirmed reservations method. There are three possible quote modes:

• DoNotIgnore (ID=0) which means that the quote will not be ignored (this is default).• IgnorePMS (ID=1) which means that only the PMS will be ignored.• IgnorePMSAndRU (ID=2) which means that both PMS and RU quote will be ignored.

2.1.28.2. Request

XML Path Data Type Type DescriptioPull_Quote odes_RQ C Root elementPull_Quote odes_RQ/Authentcaton C, Authentcaton detailsPull_Quote odes_RQ/Authentcaton/UserName


Pull_Quote odes_RQ/Authentcaton/Password


2.1.28.3. Example

<Pull_Quote odes_RQ> <Authentcaton> <UserName>Login</UserName> <Password>Password</Password> </Authentcaton></Pull_Quote odes_RQ>

2.1.28.4. Response

XML Path Data Type Type DescriptioPull_Quote odes_RS Integer C Root elementPull_Quote odes_RS/Status String(100

) See ListStatuses

Pull_Quote odes_RS/Status@ID Integer See ListStatuses

Pull_Quote odes_RS/Quote odes C, A collecton of cancellaton types

Pull_Quote odes_RS/Quote odes/CancellatonType

C Quote mode descripton

Pull_Quote odes_RS/Quote odes/Quote odes/@ID

Integer Quote mode ID

2.1.28.5. Example

<Pull_Quote odes_RS> <Status ID="0">Success</Status> <ResponseID>b7eeca5f666143b7b1396d048d3c3f68</ResponseID> <Quote odes> <Quote ode Id="0">DoNotIgnore</Quote ode> <Quote ode Id="1">IgnorePMS</Quote ode> <Quote ode Id="2">IgnorePMSAndRU</Quote ode> </Quote odes></Pull_Quote odes_RS>

RENTALSUNITED


2.2. Static property data

2.2.1. List properties

2.2.1.1. UsageThis method returns the list of propertes currently actve in RU. The method should be invoked periodically to keep your applicatonns list of propertes in sync with RU's list of actve propertes.Propertes that are no longer available on the list should be removed from your applicatonns list of actve propertes, because those propertes are no longer actve and may not have new reservatons created nor existng reservatons modifed.

2.2.1.2. RequestXML Path Data Type Type DescriptioPull_ListProp_RQ C Root elementPull_ListProp_RQ/Authentcaton C, Authentcaton detailsPull_ListProp_RQ/Authentcaton/UserName String(50) Provided by RUPull_ListProp_RQ/Authentcaton/Password String(50) Provided by RUPull_ListProp_RQ/LocatonID Integer See ListLocatonsPull_ListProp_RQ/IncludeNLA Boolean O If False/0 will flter out no

longer available propertes. Default is True/1.

2.2.1.2.1. Example<Pull_ListProp_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LocatonID>3509</LocatonID> <IncludeNLA>false</IncludeNLA></Pull_ListProp_RQ>

2.2.1.3. ResponseXML Path Data Type Type DescriptioPull_ListProp_RS Integer C Root elementPull_ListProp_RS/Status String(100

) See ListStatuses

Pull_ListProp_RS/Status@ID Integer See ListStatuses

Pull_ListProp_RS/Propertes C, A collecton of propertes matching the locaton

Pull_ListProp_RS/Propertes/Property C Single property

Pull_ListProp_RS/Propertes/Property/ID Integer Property's unique ID

Pull_ListProp_RS/Propertes/ID@BuildingID Integer O Unique ID of the building that houses the property (-1means no building)

Pull_ListProp_RS/ID@BuildingName String(50) O Building name

Pull_ListProp_RS/Propertes/Property/Name String(150 Property name

RENTALSUNITED


)Pull_ListProp_RS/Propertes/Property/OwnerID


Pull_ListProp_RS/Propertes/Property/DetailedLocatonID

Integer The most detailed locatonSee GetLocatonDetails

Pull_ListProp_RS/Propertes/Property/DetailedLocatonID@TypeID

Integer See ListLocatonTypes

Pull_ListProp_RS/Propertes/Property/Last od

String The date of the last modifcaton of the property's statc data(format YYYY- -DD HH- -SS)

Pull_ListProp_RS/Propertes/Property/Last od@NLA

Boolean O True/1 means that the property is no longer available, should be removed from the Agent's system, NLA propertes are automatcally removed from the X L feed 1 week afer they have been deactvated

Pull_ListProp_RS/Propertes/Property/I AP Boolean Special value for internal use

Pull_ListProp_RS/Propertes/Property/DateCreated

String(10) Property's creaton date (YYYY- -DD format)

2.2.1.3.1. Example<Pull_ListProp_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes> <Property> <ID BuildingID="1" BuildingName="TestBuilding">1</ID> <Name>Test Property</Name> <OwnerID>14983</OwnerID> <DetailedLocatonID TypeID="4">5309</DetailedLocatonID> <Last od>2012-02-24 10:00:00</Last od> </Property> <Property> <PropertyID>2</PropertyID> <PropertyName>Test Property 2</PropertyName> <OwnerID>2</OwnerID> <DetailedLocatonID TypeID="1">1</DetailedLocatonID> <Last od NLA="true">2012-02-24 11:00:00</Last od> false <DateCreated>2012-01-01</DateCreated> </Property> </Propertes></Pull_ListProp_RS>

2.2.2. List owner's properties

2.2.2.1. UsageThis method returns a list of propertes that belong to the specifed owner.

RENTALSUNITED


2.2.2.2. RequestXML Path Data Type Type DescriptioPull_ListOwnerProp_RQ C Root elementPull_ListOwnerProp_RQ/Authentcaton C, Authentcaton detailsPull_ListOwnerProp_RQ/Authentcaton/UserName


Pull_ListOwnerProp_RQ/Authentcaton/Password


Pull_ListOwnerProp_RQ/OwnerID Integer See ListAllOwnersPull_ListOwnerProp_RQ/IncludeNLA Boolean O If False/0, will flter out no

longer available propertes. Default is True/1

2.2.2.2.1. Example<Pull_ListOwnerProp_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <OwnerID>1</OwnerID> <IncludeNLA>false</IncludeNLA></Pull_ListOwnerProp_RQ>

2.2.2.3. ResponseXML Path Data Type Type DescriptioPull_ListOwnerProp_RS Integer C Root elementPull_ListOwnerProp_RS/Status String(100

) See ListStatuses

Pull_ListOwnerProp_RS/Status@ID Integer See ListStatuses

Pull_ListOwnerProp_RS/Propertes C, A collecton of propertes matching the locaton

Pull_ListOwnerProp_RS/Propertes/Property C Single property

Pull_ListOwnerProp_RS/Propertes/Property/PUID

String(50)

Property's unique ID in the uploader system

Pull_ListOwnerProp_RS/Propertes/Property/PUID@BuildingID

Integer Unique ID of the building that houses the property

Pull_ListOwnerProp_RS/Propertes/Property/ID

Integer Property's unique ID

Pull_ListOwnerProp_RS/Propertes/ID@BuildingID

Integer O Unique ID of the building that houses the property(-1 means no building)

Pull_ListOwnerProp_RS/ID@BuildingName String(50) O Building name

Pull_ListOwnerProp_RS/Propertes/Property/Name

String(150)

Property name

Pull_ListOwnerProp_RS/Propertes/Property/OwnerID

Integer The code that uniquely identfes the property ownerSee GetOwnerDetails

RENTALSUNITED


Pull_ListOwnerProp_RS/Propertes/Property/DetailedLocatonID


Pull_ListOwnerProp_RS/Propertes/Property/DetailedLocatonID@TypeID


Pull_ListOwnerProp_RS/Propertes/Property/Last od


Pull_ListOwnerProp_RS/Propertes/Property/Last od@NLA


Pull_ListOwnerProp_RS/Propertes/Property/I AP

Boolean Special value for internal use

Pull_ListOwnerProp_RS/Propertes/Property/DateCreated


2.2.2.3.1. Example<Pull_ListOwnerProp_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes> <Property> <PUID BuildingID="1">Apt1</PUID> <ID BuildingID="1" BuildingName="TestBuilding">1</ID> <Name>Test Property</Name> <OwnerID>1</OwnerID> <DetailedLocatonID TypeID="1">1</DetailedLocatonID> <Last od>2012-02-24 10:00:00</Last od> </Property> <Property> <PropertyID>2</PropertyID> <PropertyName>Test Property 2</PropertyName> <OwnerID>2</OwnerID> <DetailedLocatonID TypeID="1">1</DetailedLocatonID> <Last od NLA="true">2012-02-24 11:00:00</Last od> false <DateCreated>2012-01-01</DateCreated> </Property> </Propertes></Pull_ListOwnerProp_RS>

2.2.3. List properties by creation date

2.2.3.1. UsageThis method returns a list of all propertes created between the specifed dates.

RENTALSUNITED


2.2.3.2. RequestXML Path Data Type Type DescriptioPull_ListPropByCreatonDate_RQ C Root elementPull_ListPropByCreatonDate_RQ/Authentcaton


Pull_ListPropByCreatonDate_RQ/Authentcaton/UserName


Pull_ListPropByCreatonDate_RQ/Authentcaton/Password


Pull_ListPropByCreatonDate_RQ/CreatonFrom

String(10) inimum property creaton date (YYYY- -DD format)

Pull_ListPropByCreatonDate_RQ/CreatonTo String(10) aximum property creatondate (YYYY- -DD format)

Pull_ListPropByCreatonDate_RQ/IncludeNLA Boolean O If False/0, it will flter out nolonger available propertes. Default is True/1

2.2.3.2.1. Example<Pull_ListPropByCreatonDate_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <CreatonFrom>2013-08-17</CreatonFrom> <CreatonTo>2013-08-27</CreatonTo> <IncludeNLA>false</IncludeNLA></Pull_ListPropByCreatonDate_RQ>

2.2.3.3. ResponseXML Path Data Type Type DescriptioPull_ListPropByCreatonDate_RS Integer C Root elementPull_ListPropByCreatonDate_RS/Status String(100

) See ListStatuses

Pull_ListPropByCreatonDate_RS/Status@ID Integer See ListStatuses

Pull_ListPropByCreatonDate_RS/Propertes C, A collecton of propertes matching the locaton

Pull_ListPropByCreatonDate_RS/Propertes/Property

C Single property

Pull_ListPropByCreatonDate_RS/Propertes/Property/ID


Pull_ListPropByCreatonDate_RS/Propertes/ID@BuildingID

Integer O Unique ID of the building that houses the property(-1 means no building)

Pull_ListPropByCreatonDate_RS/ID@BuildingName

String(50) O Building name

Pull_ListPropByCreatonDate_RS/Propertes/Property/Name

String(150)

Property name

Pull_ListPropByCreatonDate_RS/Propertes/Property/OwnerID

Integer Property's unique ID ownerSee GetOwnerDetails

Pull_ListPropByCreatonDate_RS/Propertes/P Integer The most detailed locaton

RENTALSUNITED


roperty/DetailedLocatonID See GetLocatonDetailsPull_ListPropByCreatonDate_RS/Propertes/Property/DetailedLocatonID@TypeID


Pull_ListPropByCreatonDate_RS/Propertes/Property/Last od


Pull_ListPropByCreatonDate_RS/Propertes/Property/Last od@NLA


Pull_ListPropByCreatonDate_RS/Propertes/Property/I AP

Boolean Special value for internal use

Pull_ListPropByCreatonDate_RS/Propertes/Property/DateCreated


2.2.3.3.1. Example<Pull_ListPropByCreatonDate_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes> <Property> <ID BuildingID="1" BuildingName="TestBuilding">1</ID> <Name>Test Property</Name> <OwnerID>1</OwnerID> <DetailedLocatonID TypeID="4">3509</DetailedLocatonID> <Last od>2012-02-24 10:00:00</Last od> </Property> <Property> <PropertyID>2</PropertyID> <PropertyName>Test Property 2</PropertyName> <OwnerID>2</OwnerID> <DetailedLocatonID TypeID="1">1</DetailedLocatonID> <Last od NLA="true">2012-02-24 11:00:00</Last od> false <DateCreated>2012-01-01</DateCreated> </Property> </Propertes></Pull_ListPropByCreatonDate_RS>

2.2.4. List specific property

2.2.4.1. UsageThis method returns the property's statc informaton. Use this method to keep the RU statc informaton propertes up-to-date.

RENTALSUNITED


Pull_ListSpecProp_RQ C Root elementPull_ListSpecProp_RQ/Authentcaton C, Authentcaton detailsPull_ListSpecProp_RQ/Authentcaton/UserName


Pull_ListSpecProp_RQ/Authentcaton/Password


Pull_ListSpecProp_RQ/PropertyID Integer C Property's unique ID

2.2.4.2.1. Example<Pull_ListSpecProp_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID></Pull_ListSpecProp_RQ>

2.2.4.3. ResponseXML Path Data Type Type DescriptioPull_ListSpecProp_RS Integer C Root elementPull_ListSpecProp_RS/Status String(100

) See ListStatuses

Pull_ListSpecProp_RS/Status@ID Integer See ListStatuses

Pull_ListSpecProp_RS/Property C, Single property

Pull_ListSpecProp_RS/Property/ID Integer Property's unique ID

Pull_ListSpecProp_RS/Property/ID@BuildingID

Integer O Unique ID of the building that houses the property

Pull_ListSpecProp_RS/Property/ID@BuildingName

String(50) O Building name

Pull_ListSpecProp_RS/Property/Name String(150)

Property name

Pull_ListSpecProp_RS/Property/OwnerID Integer Property's unique ID ownerSee GetOwnerDetails

Pull_ListSpecProp_RS/Property/Property/DetailedLocatonID


Pull_ListSpecProp_RS/Property/Property/DetailedLocatonID@TypeID


Pull_ListSpecProp_RS/Property/Property/Last od


Pull_ListSpecProp_RS/Property/Last od@NLA

Boolean O True/1 means that the property is no longer available, should be removed from the Agent's system, NLA propertes are

RENTALSUNITED


automatcally removed from the X L feed 1 week afer they have been deactvated

Pull_ListSpecProp_RS/Property/DateCreated String The date ofcreaton of the property's statc data(format YYYY- -DD)

Pull_ListSpecProp_RS/Property/I U Boolean Internal use

Pull_ListSpecProp_RS/Property/I AP Boolean Internal use

Pull_ListSpecProp_RS/Property/IsActve Boolean Indicates whether the property is actve

Pull_ListSpecProp_RS/Property/IsArchived Boolean Indicates whether the property is archived

Pull_ListSpecProp_RS/Property/CleaningPrice Decimal (19,2)

Property cleaning price, always added to the fnal price of the booking

Pull_ListSpecProp_RS/Property/Space Integer Living space in square meters

Pull_ListSpecProp_RS/Property/StandardGuests

Integer Number of guests included in the base price

Pull_ListSpecProp_RS/Property/CanSleep ax Integer aximum number of guests

Pull_ListSpecProp_RS/Property/PropertyTypeID

Integer See ListPropTypes method

Pull_ListSpecProp_RS/Property/ObjectTypeID Integer See ListOTAPropTypes method

Pull_ListSpecProp_RS/Property/Floor Integer Apartment foorPull_ListSpecProp_RS/Property/Street String(100

) Property street (street

name, building/fat number)

Pull_ListSpecProp_RS/Property/ZipCode String(15)

Property zip code

Pull_ListSpecProp_RS/Property/Coordinates C Property's geographical coordinates

Pull_ListSpecProp_RS/Property/Coordinates/Lattude

String(50) Geographic lattude

Pull_ListSpecProp_RS/Property/Coordinates/Longitude

String(50) Geographic longitude

Pull_ListSpecProp_RS/Property/Distances C, O A collecton of distances to city atractons/points of interest

Pull_ListSpecProp_RS/Property/Distances/Distance

C, O Details of distance

Pull_ListSpecProp_RS/Property/Distances/DestnatonID

Integer See ListDestnatons

Pull_ListSpecProp_RS/Property/Distances/DistanceUnitID

Integer See ListDistanceUnits

Pull_ListSpecProp_RS/Property/Distances/Dis Decimal Value of distance in

RENTALSUNITED


tanceValue (5,2) distance unitPull_ListSpecProp_RS/Property/CompositonRooms

C,O A collecton of rooms

Pull_ListSpecProp_RS/Property/CompositonRooms/CompositonRoomID

Integer See ListCompositonRooms

Pull_ListSpecProp_RS/Property/CompositonRoomID@Count

Integer The amount of each room type in the property

Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites

C, O A collecton of rooms with amenites, this element contains informaton about the amenites available in a given room type, some general amenites (e.g. parking or wireless internet connecton) will be defned in the Pull_ListSpecProp_RS/Property/Amenites element

Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites/CompositonRoomAmenites

C, A single room

Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites/CompositonRoomAmenites@CompositonRoomID


Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenites

C,O A collecton of amenites available in a given room type

Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenity

Integer See ListAmenitesAvailableForRooms

Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenity@Count

Integer The amount of each amenity

Pull_ListSpecProp_RS/Property/Amenites C, O A collecton of apartment amenites

Pull_ListSpecProp_RS/Property/Amenites/Amenity

Integer See ListAmenites

Pull_ListSpecProp_RS/Property/Amenites/AmenityID@Count

Integer The amount of each amenity

Pull_ListSpecProp_RS/Property/Images C, O A collecton of property images

Pull_ListSpecProp_RS/Property/Images/Image

String(200)

Image url

Pull_ListSpecProp_RS/Property/Images/Image@ImageTypeID

Integer Image typeSee ListImageTypes

Pull_ListSpecProp_RS/Property/ArrivalInstructons

C, O Property arrival instructons

Pull_ListSpecProp_RS/Property/ArrivalInstructons/Landlord

String(20) Name of the property's landlord

Pull_ListSpecProp_RS/Property/ArrivalInstructons/Email

String(30)

Landlord's email address

RENTALSUNITED


Pull_ListSpecProp_RS/Property/ArrivalInstructons/Phone

String(20)

Landlord's phone number (with the country code)

Pull_ListSpecProp_RS/Property/ArrivalInstructons/DaysBeforeArrival

Integer The amount of days before arriving in which the guest should contact the landlord

Pull_ListSpecProp_RS/Property/ArrivalInstructons/HowToArrive

C, Instructons how to arrive

Pull_ListSpecProp_RS/Property/ArrivalInstructons/HowToArrive/Text

String O Text that describes how to arrive to the property. Valuereturned as CDATA

Pull_ListSpecProp_RS/Property/ArrivalInstructons/HowToArrive/Text@LanguageID

Integer Code that identfes the language of the descripton

Pull_ListSpecProp_RS/Property/ArrivalInstructons/PickupService

C, Pickup service informaton

Pull_ListSpecProp_RS/Property/ArrivalInstructons/PickupService/Text

String O Text that describes the pickup service. Value returned as CDATA

Pull_ListSpecProp_RS/Property/ArrivalInstructons/PickupService/Text@LanguageID


Pull_ListSpecProp_RS/Property/CheckInOut C, Check in, check out details

Pull_ListSpecProp_RS/Property/CheckInOut/CheckInFrom

String(5)

Accepted check in tme – from(HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/CheckInTo

String(5) Accepted check in tme – to(HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/CheckOutUntl

String(5) The latest check out tme.(HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/Place

String(30) The locaton where the check in takes place

Pull_ListSpecProp_RS/Property/CheckInOut/LateArrivalFees

C, O A collecton of fees for late arrivals by arrival tme (separable ranges)

Pull_ListSpecProp_RS/Property/CheckInOut/LateArrivalFees/LateArrivalFee

Decimal (19,2)

Fee for a late arrival

Pull_ListSpecProp_RS/Property/CheckInOut/LateArrivalFees/LateArrivalFee@From

String(5) Start hour of the late arrival range(HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/LateArrivalFees/LateArrivalFee@To

String(5) End hour of the late arrival range (HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/EarlyDepartureFees

C, O A collecton of fees for earlydepartures by arrival tmes (separable ranges)

Pull_ListSpecProp_RS/Property/CheckInOut/EarlyDepartureFees/EarlyDepartureFee

Decimal (19,2)

Fee for an early departure

RENTALSUNITED


Pull_ListSpecProp_RS/Property/CheckInOut/EarlyDepartureFees/EarlyDepartureFee@From

String(5) Start hour of an early depature range(HH: format, 24h format)

Pull_ListSpecProp_RS/Property/CheckInOut/EarlyDepartureFees/EarlyDepartureFee@To

String(5) End hour of an early departure range (HH: format, 24h format)

Pull_ListSpecProp_RS/Property/Payment ethods

C, A collecton of acceptable payment methods

Pull_ListSpecProp_RS/Property/Payment ethods/Payment ethod

String(500)

Payment method details, i.e. Bank account. Value returned as CDATA

Pull_ListSpecProp_RS/Property/Payment ethods/Payment ethod@Payment ethodID

Integer Payment methodSee ListPayment ethods

Pull_ListSpecProp_RS/Property/Deposit Decimal (19,2)

Deposit amount depending on deposit type

Pull_ListSpecProp_RS/Property/Deposit@DepositTypeID

Integer Deposit typeSee ListDepositTypes

Pull_ListSpecProp_RS/Property/CancellatonPolicies

C, A collecton of cancellaton policies

Pull_ListSpecProp_RS/Property/CancellatonPolicies/CancellatonPolicy

Decimal (19,2)

Percentage of total price, atributes ValidFrom, ValidTo represents the number of days to arrival between which the policy isvalid

Pull_ListSpecProp_RS/Property/CancellatonPolicies/CancellatonPolicy@ValidFrom

Integer Start of the range when the cancellaton policy is valid

Pull_ListSpecProp_RS/Property/CancellatonPolicies/CancellatonPolicy@ValidTo

Integer End of the range when the cancellaton policy is valid

Pull_ListSpecProp_RS/Property/CancellatonPoliciesText

C, O A collecton of cancellaton policies as text

Pull_ListSpecProp_RS/Property/CancellatonPoliciesText/CancellatonPolicyText

C, Property cancellatonPolicyText

Pull_ListSpecProp_RS/Property/CancellatonPoliciesText/CancellatonPolicyText@LanguageID

Integer Code that identfes the language of the cancellatonpolicy text

Pull_ListSpecProp_RS/Property/CancellatonPoliciesText/CancellatonPolicyText/Text

String(300)

Text that describes the cancellaton policy

Pull_ListSpecProp_RS/Property/Descriptons C, A collecton of descriptons

Pull_ListSpecProp_RS/Property/Descriptons/Descripton

C, Property descripton

Pull_ListSpecProp_RS/Property/Descriptons/Descripton@LanguageID

Integer Code that identfes the language of the descriptonsee Pull_ListLanguages

Pull_ListSpecProp_RS/Property/Descriptons/Descripton/Text

String(3000)

Descripton in the selected language. Value returned in CDATA

Pull_ListSpecProp_RS/Property/Descriptons/ String(300 The url of the image that

RENTALSUNITED


Descripton/Image ) contains the property descripton („descripton as an image”)

Pull_ListSpecProp_RS/Property/SecurityDeposit

Decimal (8,2)

Refundable security depositamount depending on deposit type

Pull_ListSpecProp_RS/Property/SecurityDeposit@DepositTypeID


Pull_ListSpecProp_RS/Property/I AP Boolean Special value for internal use

Pull_ListSpecProp_RS/Property/AdditonalFees

C, O, X A collecton of additonal feesSee notes for explanaton

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee/Value

Decimal (10,4)

The value of the additonal fee.

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@KindID

Integer Additonal fee kindSee ListAdditonalFeeKindsDEPRECATED and lef only for backwards compatbility

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@FeeTaxType

Integer Type of the tax/fee. See ListAdditonalFeeTypes

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@DiscriminatorID

Integer How the fee should be calculated (e.g. per night, per person, etc.)See ListAdditonalFeeDiscriminators

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@CollectTime

Integer O When the fee should be collected (1 - upon booking2- upon arrival). If not specifed, default value is set to:1- upon booking

Collect tme is currently supported by Expedia only. All other sales channels treat all fees as to be paid upon booking.

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@Optonal

Boolean Is the fee obligatory or optonal. E.g. taxes are usually not optonal, fees for some extras are.

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@Name

String (100)

O Additonal note (presentatonal only)

Pull_ListSpecProp_RS/Property/AdditonalFees/AdditonalFee@Order

Integer Additonal fee orderThe order is important in case when the fees/taxes are cumulatve.

RENTALSUNITED


Pull_ListSpecProp_RS/Property/DateCreated String(10) Property's creaton date(YYYY- -DD format)

Pull_ListSpecProp_RS/Property/LicenseNumber

String(50)

O Propertyns license numberObsolete, please use Pull_ListSpecProp_RS/Property/LicenceInfo/LicenceNumber

Pull_ListSpecProp_RS/Property/LicenceInfo O Informaton about various legislaton issues, registraton and tourist licence; might be required for some sales channels

Pull_ListSpecProp_RS/Property/LicenceInfo/LicenceNumber

string(50) O Licence number issued by appropriate local authorites

Pull_ListSpecProp_RS/Property/LicenceInfo/IssueDate

Date O Date the licence was issued

Pull_ListSpecProp_RS/Property/LicenceInfo/ExpiratonDate

Date O Date the licence is valid to

Pull_ListSpecProp_RS/Property/LicenceInfo/IsExempt

bool O Is the property not obliged to have any licence under the local law.

Pull_ListSpecProp_RS/Property/LicenceInfo/ExemptonReason

string O Reason the property does not need the license. One ofthe below:AustraliaTasmaniaHomeSharing,AustraliaTasmaniaLandUse,AustraliaTasmaniaTraditonalHospitality,CanadaVancouverLicensedHotelOrBb ,CanadaVancouverEventSpace,CanadaVancouverLocatonExempt,JapanHotelsAndInnsAct,JapanEconomicZoningAct,JapanEvent inpakuStay,PortugalListngIsNotAFullBuilding,PortugalListngHasARegisteredUrbanLeaseContract, SpainAndalusiaListngTypeNotIncluded,SpainAndalusiaNotATouristAccomodaton,SpainCataloniaListngNotFullBuilding,SpainCataloniaListngIsShar

RENTALSUNITED


edRoom,SpainCataloniaOtherExemptonReason,USABostonHotel otel,USABostonBedBreakfastLodging,USABostonInsttutonalBusiness,USABostonHospitals,USASanta onicaLicensedHotelOrBb

Pull_ListSpecProp_RS/Property/LicenceInfo/IsVATRegistered

bool O Is the rental registered for Value Added Tax. For now needed for French propertes pushed to booking.com.

Pull_ListSpecProp_RS/Property/LicenceInfo/Is anagedByPrivatePerson

bool O Is the rental managed by a private person or a company. For now needed for French propertes pushed to booking.com.

Pull_ListSpecProp_RS/Property/LicenceInfo/Is anagedByOwner

bool O Is the rental managed by its owner – informaton required by Catalonian and Portugese law

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo

O Data required because of the new law in France efectve from January 2019. Skip it for propertes located outside France.

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo/IsRegisteredAtTradeCommercialRegister

bool O Is registered as a professional at the trade commercial register (Registre du Commerce et des Sociétés)

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo/DeclaresRevenuesAsProfessionalForDirectTaxPurposes

bool O Does the owner declare revenues as professional fordirect tax purposes (see artcle 155 IV du CGI)

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo/TypeOfResidence

int O Type of residence accordingto the French law. Possible values: 1-31 – Primary2 – Secondary3 - Other

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo/PropertyTypeForTaxPurposes

string O Type of property in terms ofFrench law to determine proper City Tax Category.

RENTALSUNITED


Needed in some regions of France.

Possible values:FurnishedTourism, TouristHotel, OutdoorAccommodatons,HolidayVillage, TouristResidence,Bnb, CarsiteParkingLot, arinas, Palaces

Pull_ListSpecProp_RS/Property/LicenceInfo/FrenchLicenceInfo/CityTaxCategory

int O [Obsolete]

You only need to specify it ifall three out of DeclaresRevenuesAsProfessionalForDirectTaxPurposes, IsRegisteredAtTradeCommercialRegister and IsVATRegistered are “false”. Possible values: 11-1911 - palaces12 - 5 star tourist hotels, 5 star tourist residences, 5 star furnished tourism13 - 4 star tourist hotels, 4 star tourist residences, 4 star furnished tourist accommodaton14 - 3 star tourist hotels, 3 star tourist residences, 3 star furnished tourist accommodaton15 - 2-star tourist hotels, 2-star tourist residences, 2-star furnished holiday homes, 4 and 5-star holiday villages16 - 1-star tourist hotels, 1-star tourist residences, 1-star furnished holiday homes, 1,2 and 3-star holiday villages, bed and breakfasts, RV parks and tourist parking lots for each 24 hours17 - Campgrounds and caravan parks classifed in 3,4 and 5 stars18 - Campsites and caravan

RENTALSUNITED


parks classifed in 1 and 2 stars, marinas19 - Accommodatons awaitng classifcaton or without classifcaton

Pull_ListSpecProp_RS/Property/LicenceInfo/BrazilianLicenceInfo

C, O The registraton data required by Brazilian authorites

Pull_ListSpecProp_RS/Property/LicenceInfo/BrazilianLicenceInfo/CityHallInfoId

String O The 8-digit ID for the city hall which issued the CNPJ or CPF number.

Pull_ListSpecProp_RS/Property/PreparatonTimeBeforeArrival

Integer O Apartments Preparaton Time Before Arrival

Pull_ListSpecProp_RS/Property/NumberOfStars

Integer O Star ratng of the property (1-5)

Pull_ListSpecProp_RS/Property/LicenceInfo/TasmanianLicenceInfo/TypeOfResidence

string O Type of residence accordingto the Australian law. One of below:- Primary- NonPrimary

Please oite: Pull_ListSpecPrip_RS/Priperty/CimpisitioRiims aod Pull_ListSpecPrip_RS/Priperty/CimpisitioRiimsAmeoites elemeots caooit iccur simultaoeiusly.

2.2.4.3.1. Example (amenities not assigned to a specific room)<Pull_ListSpecProp_RS> <Status ID="1">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Property> <ID BuildingID="1" BuildingName="Building 1">1</ID> <Name>Apartment 1</Name> <OwnerID>197291</OwnerID> <DetailedLocatonID TypeID="4">3509</DetailedLocatonID> <Last od>2012-02-29 10:00:00</Last od> <DateCreated>2012-02-28</DateCreated> false false <IsActve>true<IsActve> <IsArchived>false</IsArchived> <CleaningPrice>10.00</CleaningPrice> <Space>45</Space> <StandardGuests>3</StandardGuests> <CanSleep ax>5</CanSleep ax> <ApartmentTypeID>1</ApartmentTypeID> <Floor>1</Floor> <Street>Street 1</Street> <ZipCode> 00-001</ZipCode> <Coordinates> <Longitude>40.21334234</Longitude> <Lattude>42.123123</Lattude> </Coordinates> <Distances> <Distance> <DestnatonID>1</DestnatonID>

RENTALSUNITED


<DistanceUnitID>1</DistanceUnitID> <DistanceValue>10</DistanceValue> </Distance> </Distances> <CompositonRooms> <CompositonRoomID Count="1"> 1 </CompositonRoomID> <CompositonRoomID Count="1">2 </CompositonRoomID> </CompositonRooms> <Amenites> <Amenity Count="1">1</Amenity> <Amenity Count="1">2</Amenity> </Amenites> <Images> <Image ImageTypeID="1">htp://www.domain.com/1.jpg</Image> </Images> <ArrivalInstructons> <Landlord>John Smith</Landlord> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <DaysBeforeArrival>2</DaysBeforeArrival> <HowToArrive> <Text LanguageID="1"><![CDATA[Informaton about how to arrive in English]]</Text> <Text LanguageID="2"><![CDATA[Informaton about how to arrive in German]]</Text> </HowToArrive> <PickupService> <Text LanguageID="1"><![CDATA[Informaton about pickup service in English]]</Text> </PickupService> </ArrivalInstructons> <CheckInOut> <CheckInFrom>10:00</CheckInFrom> <CheckInTo>13:00</CheckInTo> <CheckOutUntl>09:00</CheckOutUntl> <Place>apartment</Place> <LateArrivalFees> <LateArrivalFee From="13:00" To="20:00">10.00</LateArrivalFee> <LateArrivalFee From="20:00" To="01:00">30.00</LateArrivalFee> </LateArrivalFees> <EarlyDepartureFees> <EarlyDepartureFee From="20:00" To="01:00">10.00</EarlyDepartureFee> <EarlyDepartureFee From="01:00" To="10:00">30.00</EarlyDepartureFee> </EarlyDepartureFees> </CheckInOut> <Payment ethods> <Payment ethod ID="1"><![CDATA[Account number: 000000000000000]]</ ethod> < Payment ethod ID="2"><![CDATA[Visa/ asterCard]]</ ethod> </Payment ethods> <Deposit DepositTypeID="3">15.00</Deposit> <CancellatonPolicies> <CancellatonPolicy ValidFrom="0" ValidTo="3">100</CancellatonPolicy> <CancellatonPolicy ValidFrom="4" ValidTo="10">150</CancellatonPolicy> </CancellatonPolicies> <Descriptons> <Descripton LanguageID="1"> <Text><![CDATA[Descripton in English.]]</Text> </Descripton> <Descripton LanguageID="2"> <Image>htp://YourServer/GermanDescripton.jpg</Image> </Descripton> <Descripton LanguageID="3"> <Text><![CDATA[Descripton in Polish]</Text> <Image>htp://YourServer/PolishDescripton.jpg</Image>

RENTALSUNITED


</Descripton> </Descriptons> <DateCreated>2012-01-01</DateCreated> <SecurityDeposit DepositTypeID="5">85.00</SecurityDeposit> <AdditionalFees> <AdditionalFee Order="3" DiscriminatorID="2" KindID="1" Optional="false" Refundable="false" FeeTaxType="1"> <Value>10.0000</Value> </AdditionalFee> <AdditionalFee Order="4" DiscriminatorID="3" KindID="2" Name="Smalls dogs, cats,etc." Optional="true" Refundable="false" FeeTaxType="29"> <Value>0.0700</Value>

 </AdditionalFee> <AdditionalFee Order="5" DiscriminatorID="3" KindID="2" Name="Big dogs" Optional="true" Refundable="false" FeeTaxType="29"> <Value>0.2500</Value>  </AdditionalFee> </AdditionalFees> <LicenceInfo> <LicenceNumber>Licence_Number</LicenceNumber> </LicenceInfo> </Property></Pull_ListSpecProp_RS>

2.2.4.3.2. Example (amenities assigned to a specific room)<Pull_ListSpecProp_RS> <Status ID="1">Success</Status> <Property> <ID BuildingID="1" BuildingName="Building 1">1</ID> <Name>Apartment 1</Name> <OwnerID>18792</OwnerID> <DetailedLocatonID TypeID="4">3509</DetailedLocatonID> <Last od>2012-02-29 10:00:00</Last od> false <IsOnlineAvailable>true</IsOnlineAvailable> <CleaningPrice>10.00</CleaningPrice> <Space>45</Space> <StandardGuests>3</StandardGuests> <CanSleep ax>5</CanSleep ax> <ApartmentTypeID>1</ApartmentTypeID> <Floor>1</Floor> <Street>Street 1</Street> <ZipCode> 00-001</ZipCode> <Coordinates> <Longitude>40.21334234</Longitude> <Lattude>42.123123</Lattude> </Coordinates> <Distances> <Distance> <DestnatonID>1</DestnatonID> <DistanceUnitID>1</DistanceUnitID> <DistanceValue>10</DistanceValue> </Distance> </Distances> <CompositonRoomsAmenites> <CompositonRoomAmenites CompositonRoomID="1"> <Amenites> <Amenity Count="1">1</Amenity> </Amenites>

RENTALSUNITED


</CompositonRoomAmenites> <CompositonRoomAmenites CompositonRoomID="2"> <Amenites> <Amenity Count="1">1</Amenity> </Amenites> </CompositonRoomAmenites> </CompositonRoomsAmenites> <Amenites> <Amenity Count="1">2</Amenity> </Amenites> <Images> <Image ImageTypeID="1">htp://www.domain.com/1.jpg</Image> </Images> <ArrivalInstructons> <Landlord>John Smith</Landlord> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <DaysBeforeArrival>2</DaysBeforeArrival> <HowToArrive> <Text LanguageID="1"><![CDATA[Informaton about how to arrive in English]]</Text> <Text LanguageID="2"><![CDATA[Informaton about how to arrive in German]]</Text> </HowToArrive> <PickupService> <Text LanguageID="1"><![CDATA[Informaton about pickup service in English]]</Text> </PickupService> </ArrivalInstructons> <CheckInOut> <CheckInFrom>10:00</CheckInFrom> <CheckInTo>13:00</CheckInTo> <CheckOutUntl>09:00</CheckOutUntl> <Place>apartment</Place> <LateArrivalFees> <LateArrivalFee From="13:00" To="20:00">10.00</LateArrivalFee> <LateArrivalFee From="20:00" To="01:00">30.00</LateArrivalFee> </LateArrivalFees> <EarlyDepartureFees> <EarlyDepartureFee From="20:00" To="01:00">10.00</EarlyDepartureFee> <EarlyDepartureFee From="01:00" To="10:00">30.00</EarlyDepartureFee> </EarlyDepartureFees> </CheckInOut> <Payment ethods> <Payment ethod ID="1">Account number: 000000000000000</ ethod> < Payment ethod ID="2">Visa/ asterCard</ ethod> </Payment ethods> <Deposit DepositTypeID="3">15.00</Deposit> <CancellatonPolicies> <CancellatonPolicy ValidFrom="0" ValidTo="3">100</CancellatonPolicy> <CancellatonPolicy ValidFrom="4" ValidTo="10">150</CancellatonPolicy> </CancellatonPolicies> <DateCreated>2012-01-01</DateCreated> <SecurityDeposit DepositTypeID="5">85.00</SecurityDeposit> <AdditionalFees> <AdditionalFee Order="3" DiscriminatorID="2" KindID="1" Optional="false" Refundable="false" FeeTaxType="1"> <Value>10.0000</Value> </AdditionalFee> <AdditionalFee Order="4" DiscriminatorID="3" KindID="2" Name="Smalls dogs, cats,etc." Optional="true" Refundable="false" FeeTaxType="29"> <Value>0.0700</Value>

 </AdditionalFee> <AdditionalFee Order="5" DiscriminatorID="3" KindID="2" Name="Big dogs"

RENTALSUNITED

http://www.RentalsUnited.comOptional="true" Refundable="false" FeeTaxType="29"> <Value>0.2500</Value>  </AdditionalFee> </AdditionalFees> <LicenceInfo> <LicenceNumber>Licence_Number</LicenceNumber> </LicenceInfo> </Property></Pull_ListSpecProp_RS>

2.2.5. List buildings

2.2.5.1. UsageThis method returns all buildings added by the agent (based on username).

2.2.5.2. RequestXML Path Data Type Type DescriptioPull_ListBuildings_RQ C Root elementPull_ListBuildings_RQ/Authentcaton C, Authentcaton detailsPull_ListBuildings_RQ/Authentcaton/UserName


Pull_ListBuildings_RQ/Authentcaton/Password


2.2.5.2.1. Example<Pull_ListBuildings_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListBuildings_RQ>

2.2.5.3. ResponseXML Path Data Type Type DescriptioPull_ListBuildings_RS C Root elementPull_ListBuildings_RS/Status String(100

) See ListStatuses

Pull_ListBuildings_RS/Status@ID Integer See ListStatusesPull_ListBuildings_RS/Buildings C A collecton of buildingsPull_ListBuildings_RS/Buildings/Building O A single buildingPull_ListBuildings_RS/Buildings/Building@BuildingID

Integer Building's unique ID

Pull_ListBuildings_RS/Buildings/Building@BuildingName

String(50) Name of the building

Pull_ListBuildings_RS/Buildings/Building/Propertes/PropertyID

Integer O Property's unique ID

2.2.5.3.1. Example<Pull_ListBuildings_RS> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Buildings> <Building BuildingID="1" BuildingName="Building 1"> <PropertyID>1</PropertyID> <PropertyID>2</PropertyID>

RENTALSUNITED


</Building> <Building BuildingID="2" BuildingName="Building2"/> </Buildings></Pull_ListBuildings_RS>

2.2.6. List all owners

2.2.6.1. UsageThis method returns detailed informaton about all property owners defned in the RU system.

2.2.6.2. RequestXML Path Data Type Type DescriptioPull_ListAllOwners_RQ C Root elementPull_ListAllOwners_RQ/Authentcaton C, Authentcaton detailsPull_ListAllOwners_RQ/Authentcaton/UserName


Pull_ListAllOwners_RQ/Authentcaton/Password


2.2.6.2.1. Example<Pull_ListAllOwners_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_ListAllOwners_RQ>

2.2.6.3. ResponseXML Path Data Type Type DescriptioPull_ListAllOwners_RS C Root elementPull_ListAllOwners_RS/Status String(100

) See ListStatuses

Pull_ListAllOwners_RS/Status@ID Integer See ListStatusesPull_ListAllOwners_RS/Owners C, O A list of ownersPull_ListAllOwners_RS/Owners/Owner C, O The details of the ownerPull_ListAllOwners_RS/Owners/Owner@OwnerID


Pull_ListAllOwners_RS/Owners/Owner/FirstName

String(20) Owner's frst name

Pull_ListAllOwners_RS/Owners/Owner/SurName

String(30) Owner's surname

Pull_ListAllOwners_RS/Owners/Owner/Email String(100)


Pull_ListAllOwners_RS/Owners/Owner/Phone String (20)


Pull_ListAllOwners_RS/Owners/Owner/User C, O Username detailsPull_ListAllOwners_RS/Owners/Owner/User/UserName

String(100)

Owner username

2.2.6.3.1. Example<Pull_ListAllOwners_RS> <Status ID="0">Success</Status>

RENTALSUNITED


<ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID><Owners> <Owner OwnerID="1"> <FirstName>John</FirstName> <SurName>Smith</SurName> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <User> <UserName>[email protected]</UserName> </User> </Owner> <Owner OwnerID="2"> <FirstName>John2</FirstName> <SurName>Smith2</SurName> <Email>[email protected]</Email> <Phone>+48 22 200 00 00</Phone> <User> <UserName>[email protected]</UserName> </User> </Owner></Owners></Pull_ListAllOwners_RS>

2.2.7. Get owner details

2.2.7.1. UsageThis method returns detailed informaton about the specifed property owner.

2.2.7.2. RequestXML Path Data Type Type DescriptioPull_GetOwnerDetails_RQ C Root elementPull_GetOwnerDetails_RQ/Authentcaton C, Authentcaton detailsPull_GetOwnerDetails_RQ/Authentcaton/UserName


Pull_GetOwnerDetails_RQ/Authentcaton/Password


Pull_GetOwnerDetails_RQ/OwnerID Integer Property's unique ID owner

2.2.7.2.1. Example<Pull_GetOwnerDetails_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <OwnerID>1</OwnerID></Pull_GetOwnerDetails_RQ>

2.2.7.3. ResponseXML Path Data Type Type DescriptioPull_GetOwnerDetails_RS C Root elementPull_GetOwnerDetails_RS/Status String(100

) See ListStatuses

Pull_GetOwnerDetails_RS/Status@ID Integer See ListStatusesPull_GetOwnerDetails_RS/Owner C, O The details of the ownerPull_GetOwnerDetails_RS/Owner@OwnerID Integer Property's unique ID owner

RENTALSUNITED


Pull_GetOwnerDetails_RS/Owner/FirstName String(20) Owner's frst namePull_GetOwnerDetails_RS/Owner/SurName String(30) Owner's surnamePull_GetOwnerDetails_RS/Owner/CompanyName

String (100)

Owner's company name.

Pull_GetOwnerDetails_RS/Owner/ScreenName

String (100)

O Owner's screen name

Pull_GetOwnerDetails_RS/Owner/Email String(100)


Pull_GetOwnerDetails_RS/Owner/Phone String (20)


Pull_GetOwnerDetails_RS/Owner/User C, O User detailsPull_GetOwnerDetails_RS/Owner/UserName String(100

) Owner username

2.2.7.3.1. Example<Pull_GetOwnerDetails_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Owner OwnerID="1"> <FirstName>John</FirstName> <SurName>Smith</SurName> <ScreenName>John S.</ScreenName> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <User> <UserName>[email protected]</UserName> </User> </Owner></Pull_GetOwnerDetails_RS>

2.2.8. List owner agents

2.2.8.1. Usage

This method returns informaton similarly to GetOwnerDetails, but additonally also returns informaton about all the owners' agents created by the user. Use this to pull informaton about available Sales Channels.

2.2.8.2. RequestXML Path Data Type Type DescriptioPull_GetAgents_RQ C Root elementPull_GetAgents_RQ /Authentcaton C, Authentcaton detailsPull_GetAgents_RQ /Authentcaton/UserName


Pull_GetAgents_RQ /Authentcaton/Password String(50) Provided by RU

2.2.8.2.1. Example<Pull_GetAgents_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_GetAgents_RQ>

RENTALSUNITED


2.2.8.3. ResponseXML Path Data Type Type DescriptioPull_GetAgents_RS C Root elementPull_ GetAgents _RS/Status String(100) See ListStatusesPull_ GetAgents _RS/Status@ID Integer See ListStatusesPull_ GetAgents _RS/Owner C, O A details of the ownerPull_ GetAgents _RS/Owner@OwnerID Integer Property's unique ID ownerPull_ GetAgents _RS/Owner/FirstName String(20) Owner's frst namePull_ GetAgents _RS/Owner/SurName String(30) Owner's surnamePull_ GetAgents _RS/Owner/Email String(100) Owner's email addressPull_ GetAgents _RS/Owner/Phone String (20) Owner's phone number

(with country code)Pull_GetAgents_RS/Owner/User C, O User detailsPull_GetAgents_RS/Owner/UserName String (100) UserName of the ownerPull_ GetAgents_RS/Agents C, O Collecton of agentsPull_GetAgents_RS/Agents/Agent/AgentID Integer Agent's unique IDPull_GetAgents_RS/Agents/Agent/UserName String

(50) The agent's username

Pull_GetAgents_RS/Agents/Agent/CompanyName

String (100) Name of the agent's company. Not all agents willbe companies

Pull_GetAgents_RS/Agents/Agent/FirstName String(20)

The agent's name. ay be the name of the contact person

Pull_GetAgents_RS/Agents/Agent/SurName String(30)

The agent's surname. ay be the surname of the contact person

Pull_GetAgents_RS/Agents/Agent/Email String(100)

The agent's email address

Pull_GetAgents_RS/Agents/Agent/Telephone String(20)

The agent's phone number

2.2.8.3.1. Example<Pull_GetAgents_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Owner OwnerID="1"> <FirstName>John</FirstName> <SurName>Smith</SurName> <Email> [email protected] </Email> <Phone>+48 22 000 00 00</Phone> <User> <UserName>[email protected]</UserName> </User> </Owner> <Agents> <Agent> <AgentID>2</AgentID> <UserName>[email protected]</UserName> <CompanyName>John Agency</CompanyName> <FirstName>John2</FirstName> <SurName>Smith2</SurName> <Email>[email protected]</Email> <Telephone>+48 22 200 00 00</Telephone>

RENTALSUNITED


</Agent> </Agents></Pull_GetAgents_RS>

2.2.9. List property external listing

2.2.9.1. UsageThis method returns informaton whether your property has already been downloaded by the agent. Includes status informaton, url for the property listng and additonal descripton (when some data is missing and the property cannot be listed in the agent's system).

2.2.9.2. RequestXML Path Data Type Type DescriptioPull_GetPropertyExternalListng_RQ C Root elementPull_GetPropertyExternalListng_RQ/Authentcaton


Pull_GetPropertyExternalListng_RQ/Authentcaton/UserName


Pull_GetPropertyExternalListng_RQ/Authentcaton/Password


Pull_GetPropertyExternalListng_RQ/Propertes

C A collecton of propertes

Pull_GetPropertyExternalListng_RQ/Propertes/PropertyID


2.2.9.2.1. Example<Pull_GetPropertyExternalListng_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Propertes> <PropertyID>0</PropertyID> <PropertyID>1</PropertyID> </Propertes></Pull_GetPropertyExternalListng_RQ>

2.2.9.3. ResponseXML Path Data Type Type DescriptioPull_GetPropertyExternalListng_RS C Root elementPull_GetPropertyExternalListng_RS/Status String(100

) See ListStatuses

Pull_GetPropertyExternalListng_RS/Status@ID


Pull_GetPropertyExternalListng_RS/Propertes


Pull_GetPropertyExternalListng_RS/Propertes/Property

O A single property

Pull_GetPropertyExternalListng_RS/Propertes/Property@ID


Pull_GetPropertyExternalListng_RS/Propertes/Property/ExternalListng

C A collecton of property listngs

RENTALSUNITED


Pull_GetPropertyExternalListng_RS/Propertes/Property/ExternalListng/Url

String(300)

Url to an external service

Pull_GetPropertyExternalListng_RS/Propertes/Property/ExternalListng/Status

Integer See ListPropExtStatuses

Pull_GetPropertyExternalListng_RS/Propertes/Property/ExternalListng/Descripton

String(500)

Additonal informaton fromthe agent, afer they have downloaded the property

Pull_GetPropertyExternalListng_RS/Notfs C,O A collecton of informaton about getng process errors

Pull_GetPropertyExternalListng_RS/Notf String(100)

A detailed informaton about the problem

Pull_GetPropertyExternalListng_RS/Notf@StatusID


2.2.9.3.1. Example<Pull_GetPropertyExternalListng_RS> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes> <Property ID="0"> <ExternalListng> <Url>htp://someAgency.com/apartment0</Url> <Status>2</Status> <Descripton>Property cannot be listed, living space is missing</Descripton> </ExternalService> <ExternalService> <Url>htp://someAgency.com/apartment1</Url> <Status>1</Status> <Descripton>We need more photos</Descripton> </ExternalListng> </Property> <Property ID="1"> <ExternalListng> <Url>htp://someAgency.com/apartment2</Url> <Status>1</Status> <Descripton>Some descripton</Descripton> </ExternalListng> </Property> </Propertes> <Notfs /></Pull_GetPropertyExternalListng_RS>

2.2.10. Allowed Properties Count

2.2.10.1. UsageThis method returns informaton how many propertes user has access to and how many

2.2.10.2. RequestXML Path Data Type Type DescriptioPull_PropCount_RQ C Root elementPull_PropCount_RQ/Authentcaton C, Authentcaton detailsPull_PropCount_RQ/Authentcaton/UserName


Pull_PropCount_RQ/Authentcaton/Password String(50) Provided by RU

RENTALSUNITED


2.2.10.2.1. Example<Pull_PropCount_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton></Pull_PropCount_RQ>

2.2.10.3. ResponseXML Path Data Type Type DescriptioPull_PropCount_RS C Root elementPull_PropCount_RS/Status String(100

) See ListStatuses

Pull_PropCount_RS/Status@ID Integer See ListStatusesPull_PropCount_RS/ResponseID String Response unique IDPull_PropCount_RS/Propertes CPull_PropCount_RS/Propertes@Count Integer Number of all non NLA

propertesPull_PropCount_RS/Propertes@Actve Integer Number of all actve

propertes

2.2.10.3.1. Example<Pull_PropCount_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes Count="10" Actve="2" /></Pull_GetPropertyExternalListng_RS>

2.3. Property ReviewsThis secton describes the methods that allow to retrieve informaton about proeprty reviews.

2.3.1. List reviews for property

2.3.1.1. UsageThis method returns all reviews for the selected property.

2.3.1.2. Request

XML Path Data Type Type DescriptioPull_ListPropertyReviews_RQ C Root elementPull_ListPropertyReviews_RQ/Authentcaton C, Authentcaton detailsPull_ListPropertyReviews_RQ/Authentcaton/UserName


Pull_ListPropertyReviews_RQ/Authentcaton/Password


Pull_ListPropertyReviews_RQ/PropertyID Integer The code that uniquely identfes a property

2.3.1.2.1. Example<Pull_ListPropertyReviews_RQ> <Authentcaton> <UserName>Test</UserName>

RENTALSUNITED


<Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID></Pull_ListPropertyReviews_RQ>

2.3.1.3. Response

XML Path Data Type Type DescriptioPull_ListPropertyReviews_RS C Root elementPull_ListPropertyReviews_RS/Status String See ListStatusesPull_ListPropertyReviews_RS/Status@ID Integer See ListStatusesPull_ListPropertyReviews_RS/Reviews C, A collecton of reviewsPull_ListPropertyReviews_RS/Reviews@PropertyID

Integer The code that uniquely identfes a property.

Pull_ListPropertyReviews_RS/Reviews/Review Informaton about reviewPull_ListPropertyReviews_RS/Reviews/Review@ID

Integer The code that uniquely identfes a review

Pull_ListPropertyReviews_RS/Reviews/Review/FirstName

String(100) First name of the user that made the review

Pull_ListPropertyReviews_RS/Reviews/Review/LastName

String(100) Last name of the user that made the review

Pull_ListPropertyReviews_RS/Reviews/Review/DisplayName

String(100) Display name of the user that made the review

Pull_ListPropertyReviews_RS/Reviews/Review/Email

String(100) Email of the user that madethe review

Pull_ListPropertyReviews_RS/Reviews/Review/Ratng

Integer Ratng of the apartment made by user. Values returned are from range 0-5

Pull_ListPropertyReviews_RS/Reviews/Review/ArrivalDate

String(10) Date on which user arrived (YYYY- -DD format)

Pull_ListPropertyReviews_RS/Reviews/Review/Submited

String(10) Date on which the review was submited (YYYY- -DD format)

Pull_ListPropertyReviews_RS/Reviews/Review/Texts

C, Collecton of review translatons

Pull_ListPropertyReviews_RS/Reviews/Review/Texts/Text

String Review text

Pull_ListPropertyReviews_RS/Reviews/Review/Texts/Text@LanguageID

Integer Code that identfy the language of reviewPull_ListLanguages

2.3.1.3.1. Example<Pull_ListPropertyReviews_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reviews PropertyID="123"> <Review ID="10001"> <FirstName>John</FirstName> <LastName>Smith</LastName> <DisplayName>John S</DisplayName> <Ratng>5</Ratng> <ArrivalDate>2015-04-02</ArrivalDate> <Submited>2015-05-01</Submited>

mailto:Pull_ListPropertyReviews_RS/Status@ID

RENTALSUNITED


<Texts> <Text LanguageID="1">Very nice fat</Text> <Text LanguageID="3">Bardzo ładne mieszkanie</Text> </Texts> </Review> </Reviews></Pull_ListPropertyReviews_RS>

2.4. Availability and pricesThis secton describes the methods that allow to retrieve informaton about availability calendar, min stays, prices, discounts.

2.4.1. List property blocks

2.4.1.1. UsageThis method returns the dates during which the queried property is not available. It is called a block because blocks do not represent reservatons. Reservatons that are directly next to each other will be merged into one block.

Each date between Block/DateFrom and Block/DateTo (inclusive) is unavailable for booking.

This method does not trim blocks, so in a response you can receive e.g. a block with DateFrom earlier than the request's DateFrom.

2.4.1.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyBlocks_RQ C Root elementPull_ListPropertyBlocks_RQ/Authentcaton C, Authentcaton detailsPull_ListPropertyBlocks_RQ/Authentcaton/UserName


Pull_ListPropertyBlocks_RQ/Authentcaton/Password


Pull_ListPropertyBlocks_RQ/PropertyID Integer Property's unique ID. All relevant blocks (periods when it is unavailable for rentng) for that property will be returned

Pull_ListPropertyBlocks_RQ/DateFrom String(10) Start of the range (YYYY- -DD format)

Pull_ListPropertyBlocks_RQ/DateTo String(10) End of the range (blocks startng on this date will notbe returned)(YYYY- -DD format)

2.4.1.2.1. Example<Pull_ListPropertyBlocks_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo>

RENTALSUNITED


</Pull_ListPropertyBlocks_RQ>

2.4.1.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyBlocks_RS C Root elementPull_ListPropertyBlocks_RS/Status String See ListStatusesPull_ListPropertyBlocks_RS/Status@ID Integer See ListStatusesPull_ListPropertyBlocks_RS/ PropertyBlock C, A collecton of property

blocksPull_ListPropertyBlocks_RS/ PropertyBlock@PropertyID

C, Property's unique ID

Pull_ListPropertyBlocks_RS/ PropertyBlock/Block

C, O Single block

Pull_ListPropertyBlocks_RS/ PropertyBlock/Block/DateFrom

String(10) Start of the block(YYYY- -DD format)

Pull_ListPropertyBlocks_RS/PropertyBlock/Block/DateTo

String End of the block(YYYY- -DD format)

2.4.1.3.1. Example<Pull_ListPropertyBlocks_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyBlock PropertyID="1"> <Block> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-09</DateTo> </Block> <Block> <DateFrom>2012-03-20</DateFrom> <DateTo>2012-03-30</DateTo> </Block> </PropertyBlock></Pull_ListPropertyBlocks_RS>

2.4.2. List properties blocks

2.4.2.1. UsageThis method returns the dates during which all propertes in the queried locaton are not available.It is called a block because blocks do not represent reservatons. Reservatons that are directly nextto each other will be merged into one block.

Each date between Block/DateFrom and Block/DateTo (inclusive) is unavailable for booking.

This method does not trim blocks, so in a response you can receive e.g. a block with DateFrom earlier than the request's DateFrom.

2.4.2.2. RequestXML Path Data Type Type DescriptioPull_ListPropertesBlocks_RQ C Root elementPull_ListPropertesBlocks_RQ/Authentcaton C, Authentcaton detailsPull_ListPropertesBlocks_RQ/Authentcaton/UserName

RENTALSUNITED


Pull_ListPropertesBlocks_RQ/Authentcaton/Password


Pull_ListPropertesBlocks_RQ/LocatonID Integer Property's unique ID. All relevant blocks (periods when it is unavailable for rentng) for that property will be returned

Pull_ListPropertesBlocks_RQ/DateFrom String(10) Start of the range(YYYY- -DD format)

Pull_ListPropertesBlocks_RQ/DateTo String(10) End of the range (blocks startng on this date will notbe returned)(YYYY- -DD format)

Pull_ListPropertesBlocks_RQ/IncludeNLA Boolean O If False/0, it will flter out no longer available propertes. Default is True/1.

2.4.2.2.1. Example<Pull_ListPropertesBlocks_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LocatonID>500</LocatonID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo> <IncludeNLA>false</IncludeNLA></Pull_ListPropertesBlocks_RQ>

2.4.2.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertesBlocks_RS C Root elementPull_ListPropertesBlocks_RS/Status String(100

) See ListStatuses

Pull_ListPropertesBlocks_RS/Status@ID Integer See ListStatusesPull_ListPropertesBlocks_RS/Propertes C A collecton of propertesPull_ListPropertesBlocks_RS/Propertes/PropertyBlock

C, O Single property

Pull_ListPropertesBlocks_RS/Propertes/PropertyBlock@PropertyID


Pull_ListPropertesBlocks_RS/Propertes/PropertyBlock/Block

C, Single block

Pull_ListPropertesBlocks_RS/Propertes/PropertyBlock/Block/DateFrom

String(10) Start of the block(YYYY- -DD format)

Pull_ListPropertesBlocks_RS/Propertes/PropertyBlock/Block/DateTo

String(10) End of the block(YYYY- -DD format)

2.4.2.3.1. Example<Pull_ListPropertesBlocks_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID>

RENTALSUNITED


<Propertes> <PropertyBlock PropertyID="1"> <Block> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-09</DateTo> </Block> <Block> <DateFrom>2012-03-20</DateFrom> <DateTo>2012-03-30</DateTo> </Block> </PropertyBlock> < PropertyBlock PropertyID="2"> <Block> <DateFrom>2012-03-05</DateFrom> <DateTo>2012-03-08</DateTo> </Block> <Block> <DateFrom>2012-03-12</DateFrom> <DateTo>2012-03-18</DateTo> </Block> </PropertyBlock> </Propertes></Pull_ListPropertesBlocks_RS>

2.4.3. List property availability calendar

2.4.3.1. UsageThis method returns the availability and the min stay data in a day-by-day manner.

2.4.3.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyAvailabilityCalendar_RQ C Root elementPull_ListPropertyAvailabilityCalendar_RQ/Authentcaton


Pull_ListPropertyAvailabilityCalendar_RQ/Authentcaton/UserName


Pull_ListPropertyAvailabilityCalendar_RQ/Authentcaton/Password


Pull_ListPropertyAvailabilityCalendar_RQ/PropertyID


Pull_ListPropertyAvailabilityCalendar_RQ/DateFrom

String(10) Start of the range(YYYY- -DD format)

Pull_ListPropertyAvailabilityCalendar_RQ/DateTo

String(10) End of the range (the last date to be included in the response)(YYYY- -DD format)

2.4.3.2.1. Example<Pull_ListPropertyAvailabilityCalendar_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom>

RENTALSUNITED


<DateTo>2014-01-09</DateTo></Pull_ListPropertyAvailabilityCalendar_RQ>

2.4.3.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyAvailabilityCalendar_RS C Root elementPull_ListPropertyAvailabilityCalendar_RS/Status

String(100)

See ListStatuses

Pull_ListPropertyAvailabilityCalendar_RS/Status@ID


Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar


Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar@PropertyID


Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar/CalDay

C Represents a single day

Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar/CalDay@Date

String(10) Date(YYYY- -DD format)

Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar/CalDay/IsBlocked

Boolean Returns whether the property is unavailable for that day. If True/1, the property is not available.

Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar/CalDay/ inStay

Integer O inimum length of stay for that day

Pull_ListPropertyAvailabilityCalendar_RS/PropertyCalendar/CalDay/Changeover

Integer Changeover for that day

2.4.3.3.1. Example<Pull_ListPropertyAvailabilityCalendar_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyCalendar PropertyID="1"> <CalDay Date="2012-03-01"> <IsBlocked>true</IsBlocked> < inStay>2</ inStay> <Changeover>1</Changeover> </CalDay> <CalDay Date="2012-03-02"> <IsBlocked>false</IsBlocked> < inStay>3</ inStay> <Changeover>1</Changeover> </CalDay> <CalDay Date="2012-03-04"> <IsBlocked>false</IsBlocked> <Changeover>4</Changeover> </CalDay> <CalDay Date="2012-03-05"> <IsBlocked>false</IsBlocked> <Changeover>4</Changeover> </CalDay> <CalDay Date="2012-04-01"> <IsBlocked>false</IsBlocked> <Changeover>3</Changeover> </CalDay>

RENTALSUNITED


</PropertyCalendar></Pull_ListPropertyAvailabilityCalendar_RS>

2.4.4. List property min stay

2.4.4.1. UsageThis method returns the minimum stays value for the queried property.

If the property has a minimum stay policy, it means that a booking for which the guest's stay tme is below the property provider's requirements, represented below:

ArrivalDate < Pull_ListProperty inStay_RS/Property inStay/ inStay@DateTo

and

DepartureDate > Pull_ListProperty inStay_RS/Property inStay/ inStay@DateFrom

the stay then has to be at least as long as the property provider's required minimum stay, represented by the value: Pull_ListProperty inStay_RS/Property inStay/ inStay.

2.4.4.2. RequestXML Path Data Type Type DescriptioPull_ListProperty inStay_RQ C Root elementPull_ListProperty inStay_RQ/Authentcaton C, Authentcaton detailsPull_ListProperty inStay_RQ/Authentcaton/UserName


Pull_ListProperty inStay_RQ/Authentcaton/Password


Pull_ListProperty inStay_RQ/PropertyID Integer Property's unique IDPull_ListProperty inStay_RQ/DateFrom String(10) Start of the range

(YYYY- -DD format)Pull_ListProperty inStay_RQ/DateTo String(10) End of the range

(YYYY- -DD format)

2.4.4.2.1. Example<Pull_ListProperty inStay_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo></Pull_ListProperty inStay_RQ>

2.4.4.3. ResponseXML Path Data Type Type DescriptioPull_ListProperty inStay_RS C Root elementPull_ListProperty inStay_RS/Status String(100

) See ListStatuses

Pull_ListProperty inStay_RS/Status@ID Integer See ListStatusesPull_ListProperty inStay_RS/Property inStay

RENTALSUNITED


Pull_ListProperty inStay_RS/Property inStay@PropertyID


Pull_ListProperty inStay_RS/Property inStay/ inStay

Integer O Any stay between the selected dates has to be at least X nights long

Pull_ListProperty inStay_RS/Property inStay/ inStay@DateFrom


Pull_ListProperty inStay_RS/Property inStay/ inStay@DateTo

String(10) End of the range(YYYY- -DD format)

2.4.4.3.1. Example<Pull_ListProperty inStay_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Property inStay PropertyID="1"> < inStay DateFrom="2012-03-04" DateTo="2012-03-20">2</ inStay> < inStay DateFrom="2012-03-22" DateTo="2012-03-28">3</ inStay> </Property inStay></Pull_ListProperty inStay_RS>

2.4.5. List property base price

2.4.5.1. UsageThis method returns the base/default prices for the queried property.

2.4.5.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyBasePrice_RQ C Root elementPull_ListPropertyBasePrice_RQ/Authentcaton


Pull_ListPropertyBasePrice_RQ/Authentcaton/UserName


Pull_ListPropertyBasePrice_RQ/Authentcaton/Password


Pull_ListPropertyBasePrice_RQ/PropertyID Integer Property's unique ID

2.4.5.2.1. Example<Pull_ListPropertyBasePrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID></Pull_ListPropertyBasePrice_RQ>

2.4.5.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyBasePrice_RS C Root elementPull_ListPropertyBasePrice_RS/PropertyBasePrices

C Informaton about the property's base prices

Pull_ListPropertyBasePrice_RS/PropertyBaseP Integer Property's unique ID

RENTALSUNITED


rices@PropertyIDPull_ListPropertyBasePrice_RS/PropertyBasePrices/BasePrice

Base price

Pull_ListPropertyBasePrice_RS/PropertyBasePrices/BasePrice@DayOfWeek

Integer 0 – onday1 – Tuesday2 – Wednesday3 – Thursday4 – Friday5 – Saturday6 – Sunday

Pull_ListPropertyBasePrice_RS/PropertyBasePrices/BasePrice@Price

Decimal Price for the standard number of guests defned for that property

Pull_ListPropertyBasePrice_RS/PropertyBasePrices/BasePrice@Extra

Decimal Extra fee for each guest above the standard numberof guests

2.4.5.3.1. Example<Pull_ListPropertyBasePrice_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyBasePrices PropertyID="1"> <BasePrice DayOfWeek="2" Price="120" Extra="15"/> <BasePrice DayOfWeek="3" Price="120" Extra="20"/> <BasePrice DayOfWeek="4" Price="120" Extra="20"/> <BasePrice DayOfWeek="5" Price="200" Extra="20"/> <BasePrice DayOfWeek="6" Price="200" Extra="20"/> </PropertyBasePrices></Pull_ListPropertyBasePrice_RS>

2.4.6. List property prices

2.4.6.1. UsageThis method returns the property's base prices (without discounts, without extra guests fees, without cleaning fees). These prices are only for a general overview. These prices are not fnal. You can cache these prices and use them in the search results page. It will speed up your site. Use other methods to get the fnal prices.

2.4.6.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyPrices_RQ C Root elementPull_ListPropertyPrices_RQ/Authentcaton C, Authentcaton detailsPull_ListPropertyPrices_RQ/Authentcaton/UserName


Pull_ListPropertyPrices_RQ/Authentcaton/Password


Pull_ListPropertyPrices_RQ/PropertyID Integer Property's unique ID. All prices for the property will be returned for the specifed range of dates

Pull_ListPropertyPrices_RQ/DateFrom String(10) Start of the range(YYYY- -DD format)

RENTALSUNITED


Pull_ListPropertyPrices_RQ/DateTo String(10) End of the range(YYYY- -DD format)

2.4.6.2.1. Example<Pull_ListPropertyPrices_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo></Pull_ListPropertyPrices_RQ>

2.4.6.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyPrices_RS C Root elementPull_ListPropertyPrices_RS/Status String(100

) See ListStatuses

Pull_ListPropertyPrices_RS/Status@ID Integer See ListStatusesPull_ListPropertyPrices_RS/Prices C, A collecton of the prices

for the propertyPull_ListPropertyPrices_RS/ Prices@PropertyID


Pull_ListPropertyPrices_RS/Prices/Season C, O Informaton about the pricefor the specifed dates and number of guests

Pull_ListPropertyPrices_RS/Prices/Season@DateFrom

String(10) Start of the range when theprice is valid(YYYY- -DD format)

Pull_ListPropertyPrices_RS/Prices/Season@DateTo

String(10) End of the range when the price value is valid (YYYY- -DD format)

Pull_ListPropertyPrices_RS/Prices/Season/Price

Decimal (19,2)

Price for the standard number of guests defned for that property

Pull_ListPropertyPrices_RS/Prices/Season/Extra

Decimal (19,2)

O Extra fee for each guest above the standard numberof guests

Pull_ListPropertyPrices_RS/Prices/Season/LOSS

C,O A collecton of nightly price setngs depending on the length of stay

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS

C,O Single nightly price

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS@Nights

Integer Number of nights for which the price applies

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS/Price

Decimal (19,2)

Nightly price value for the specifed length of stay

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS/LOSPS

C,O A collecton of nightly price setngs depending on the number of guests

RENTALSUNITED


Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS/LOSPS/LOSP

C, Single nightly price depending on the number of guests

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS/LOSPS/LOSP@NrOfGuests

Integer Number of guests

Pull_ListPropertyPrices_RS/Prices/Season/LOSS/LOS/LOSPS/LOSP/Price

Decimal (19,2)

Nightly price

Pull_ListPropertyPrices_RS/Prices/Season/EGPS

C,O A collecton of extra guests price setngs depending onthe number of extra guests

Pull_ListPropertyPrices_RS/Prices/Season/EGPS/EGP

C,O Single extra guest price

Pull_ListPropertyPrices_RS/Prices/Season/EGPS/EGP@ExtraGuests

Integer Number of extra guests for which the price applies

Pull_ListPropertyPrices_RS/Prices/Season/EGPS/EGP/Price

Decimal (19,2)

Single extra guest price value for the specifed number of extra guests

2.4.6.3.1. Example<Pull_ListPropertyPrices_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Prices PropertyID="1"> <Season DateFrom="2012-03-01" DateTo="2012-03-08"> <Price>100.00</Price> <Extra>10.00</Extra> </Season> <Season DateFrom="2012-03-09" DateTo="2012-04-01"> <Price>120.00</Price> <Extra>10.00</Extra> <LOSS> <LOS Nights="1"> <Price>700.00</Price> </LOS> <LOS Nights="2"> <Price>702.00</Price> <LOSPS> <LOSP NrOfGuests="5"> <Price>750.00</Price> </LOSP> <LOSP NrOfGuests="6"> <Price>800.00</Price> </LOSP> </LOSPS> </LOS> </LOSS> <EGPS> <EGP ExtraGuests="1"> <Price>70.00</Price> </EGP> <EGP ExtraGuests="2"> <Price>72.00</Price> </EGP> </EGPS> </Season> </Prices></Pull_ListPropertyPrices_RS>

RENTALSUNITED


2.4.7. Get property price

2.4.7.1. UsageThis method returns the property price for the specifed dates. The returned price is fnal, includingdiscounts and additonal fees (like the cleaning fee).

2.4.7.2. RequestXML Path Data Type Type DescriptioPull_GetPropertyPrice_RQ C Root elementPull_GetPropertyPrice_RQ/Authentcaton C, Authentcaton detailsPull_GetPropertyPrice_RQ/Authentcaton/UserName


Pull_GetPropertyPrice_RQ/Authentcaton/Password


Pull_GetPropertyPrice_RQ/PropertyID Integer Property's unique IDPull_GetPropertyPrice_RQ/DateFrom String(10) Arrival date

(YYYY- -DD format)Pull_GetPropertyPrice_RQ/DateTo String(10) Departure date

(YYYY- -DD format)Pull_GetPropertyPrice_RQ/NOP Integer O Number of guests. If it's

provided the response will include the price details for the specifed number of guests only

2.4.7.2.1. Example<Pull_GetPropertyPrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo></Pull_GetPropertyPrice_RQ>

2.4.7.3. ResponseXML Path Data Type Type DescriptioPull_GetPropertyPrice_RS C Root elementPull_GetPropertyPrice_RS/Status String(100

) See ListStatuses

Pull_GetPropertyPrice_RS/Status@ID Integer See ListStatusesPull_GetPropertyPrice_RS/PropertyPrices C, O A collecton of the fnal

property prices depending on the number of guests

Pull_GetPropertyPrice_RS/PropertyPrices@PropertyID


Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice

Decimal (19,2)

Final property price depending on the number of guests

RENTALSUNITED


Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice@NOP

Integer Number of guests for whichthe price is valid

Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice@Cleaning

Decimal (19,2)

Cleaning fee (included in PropertyPrice)

Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice@ExtraPersonPrice

Decimal (19,2)

Extra guest fee (included in PropertyPrice)

Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice@Deposit

Decimal (19,2)

The required deposit

Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice@SecurityDeposit

Decimal (19,2)

Refundable security depositpaid by the client directly tothe property owner upon arrival

2.4.7.3.1. Example<Pull_GetPropertyPrice_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyPrices PropertyID="1"> <PropertyPrice NOP="3" Cleaning="10.00" ExtraPersonPrice="0.00" Deposit="15.00" SecurityDeposit="15.00"> 100.00 </PropertyPrice> <PropertyPrice NOP="4" Cleaning="10.00" ExtraPersonPrice="30.00" Deposit="16.50" SecurityDeposit="16.50"> 110.00 </PropertyPrice> <PropertyPrice NOP="5" Cleaning="10.00" ExtraPersonPrice="80.00" Deposit="18.00" SecurityDeposit="18.00"> 120.00 </PropertyPrice> </PropertyPrices></Pull_GetPropertyPrice_RS>

2.4.8. Get property avb price

2.4.8.1. UsageThis method returns the availability and price of the queried property for the specifed stay. The returned price is fnal, including discounts and additonal fees (like the cleaning fee). The result set is empty when the property is not available for booking or when the prices are not set.

2.4.8.2. RequestXML Path Data Type Type DescriptioPull_GetPropertyAvbPrice_RQ C Root elementPull_GetPropertyAvbPrice_RQ/Authentcaton C, Authentcaton detailsPull_GetPropertyAvbPrice_RQ/Authentcaton/UserName


Pull_GetPropertyAvbPrice_RQ/Authentcaton/Password


Pull_GetPropertyAvbPrice_RQ/PropertyID Integer Property's unique IDPull_GetPropertyAvbPrice_RQ/DateFrom String(10) Arrival date

(YYYY- -DD format)Pull_GetPropertyAvbPrice_RQ/DateTo String(10) Departure date

(YYYY- -DD format)Pull_GetPropertyAvbPrice_RQ/NOP Integer O Number of guests. If it's

provided the response will include the price details for

RENTALSUNITED


the specifed number of guests only

2.4.8.2.1. Example<Pull_GetPropertyAvbPrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo></Pull_GetPropertyAvbPrice_RQ>

2.4.8.3. ResponseXML Path Data Type Type DescriptioPull_GetPropertyAvbPrice_RS C Root elementPull_GetPropertyAvbPrice_RS/Status String(100

) See ListStatuses

Pull_GetPropertyAvbPrice_RS/Status@ID Integer See ListStatusesPull_GetPropertyAvbPrice_RS/PropertyPrices C, O A collecton of the fnal

property prices depending on the number of guests

Pull_GetPropertyAvbPrice_RS/PropertyPrices@PropertyID


Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice

Decimal (19,2)


Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice@NOP

Integer Number of guest for which the price is valid

Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice@Cleaning

Decimal (19,2)


Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice@ExtraPersonPrice

Decimal (19,2)

Extra person fee (included in PropertyPrice)

Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice@Deposit

Decimal (19,2)


Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice@SecurityDeposit

Decimal (19,2)


2.4.8.3.1. Example 1 (property is available in the specified dates)<Pull_GetPropertyAvbPrice_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PropertyPrices PropertyID="1"> <PropertyPrice NOP="3" Cleaning="10.00" ExtraPersonPrice="0.00" Deposit="15.00" SecurityDeposit="15.00"> 100.00 </PropertyPrice> <PropertyPrice NOP="4" Cleaning="10.00" ExtraPersonPrice="15.00" Deposit="16.50" SecurityDeposit="16.50"> 110.00 </PropertyPrice> <PropertyPrice NOP="5" Cleaning="10.00" ExtraPersonPrice="40.00" Deposit="18.00" SecurityDeposit="18.00"> 120.00

RENTALSUNITED


</PropertyPrice> </PropertyPrices></Pull_GetPropertyAvbPrice_RS>

2.4.8.3.2. Example 2 (property is not available in the specified dates)<Pull_GetPropertyAvbPrice_RS> <Status ID="1">Property is not available for the specifed dates</Status></Pull_GetPropertyAvbPrice_RS>

2.4.9. Get properties avb price

2.4.9.1. UsageThis method returns propertes available in the specifed dates and their prices. The returned prices are fnal, including discounts and additonal fees (like the cleaning fee). Propertes with n price setngs for the specifed dates will not be included in the result set.

2.4.9.2. RequestXML Path Data Type Type DescriptioPull_GetPropertesAvbPrice_RQ C Root element

Pull_GetPropertesAvbPrice_RQ/Authentcaton


Pull_GetPropertesAvbPrice_RQ/Authentcaton/UserName


Pull_GetPropertesAvbPrice_RQ/Authentcaton/Password


Pull_GetPropertesAvbPrice_RQ/LocatonID Integer The locaton's unique IDPull_GetPropertesAvbPrice_RQ/DateFrom String(10) Arrival date

(YYYY- -DD format)Pull_GetPropertesAvbPrice_RQ/DateTo String(10) Departure date

(YYYY- -DD format)Pull_GetPropertesAvbPrice_RQ/IncludeNLA Boolean O If False/0, it will flter out

no longer available propertes. Default is True/1.

2.4.9.2.1. Example<Pull_GetPropertesAvbPrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LocatonID>500</LocatonID> <DateFrom>2014-01-04</DateFrom> <DateTo>2014-01-09</DateTo> <IncludeNLA>false</IncludeNLA></Pull_GetPropertesAvbPrice_RQ>

2.4.9.3. ResponseXML Path Data Type Type DescriptioPull_GetPropertesAvbPrice_RS C Root element

RENTALSUNITED


Pull_GetPropertesAvbPrice_RS/Status String(100)

See ListStatuses

Pull_GetPropertesAvbPrice_RS/Status@ID Integer See ListStatusesPull_GetPropertesAvbPrice_RS/Propertes C, O A collecton of property

pricesPull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices

C, O A collecton of the fnal property prices depending on the number of guests

Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices@PropertyID


Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice

Decimal (19,2)


Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice@NOP

Integer Number of guest for which the price is valid

Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice@Cleaning

Decimal (19,2)


Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice@ExtraPersonPrice

Decimal (19,2)

Extra person fee (included in PropertyPrice)

Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice@Deposit

Decimal (19,2)


Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice@SecurityDeposit

Decimal (19,2)


2.4.9.3.1. Example 1 (some properties are available in the specified dates)<Pull_GetPropertesAvbPrice_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Propertes> <PropertyPrices PropertyID="1"> <PropertyPrice NOP="3" Cleaning="10.00" ExtraPersonPrice="0.00" Deposit="15.00" SecurityDeposit="15.00"> 100.00 </PropertyPrice> <PropertyPrice NOP="4" Cleaning="10.00" ExtraPersonPrice="0.00" Deposit="16.50" SecurityDeposit="16.50"> 110.00 </PropertyPrice> <PropertyPrice NOP="5" Cleaning="10.00" ExtraPersonPrice="0.00" Deposit="18.00" SecurityDeposit="18.00"> 120.00 </PropertyPrice> </PropertyPrices> <PropertyPrices PropertyID="2"> <PropertyPrice NOP="3" Cleaning="0.00" ExtraPersonPrice="0.00" Deposit="15.00" SecurityDeposit="15.00"> 100.00 </PropertyPrice> <PropertyPrice NOP="4" Cleaning="10.00" ExtraPersonPrice="12.00" Deposit="16.50" SecurityDeposit="16.50"> 110.00 </PropertyPrice> <PropertyPrice NOP="5" Cleaning="10.00" ExtraPersonPrice="12.00" Deposit="18.00" SecurityDeposit="18.00"> 120.00 </PropertyPrice> </PropertyPrices> </Propertes></Pull_GetPropertesAvbPrice_RS>

RENTALSUNITED


2.4.9.3.2. Example 2 (nothing available)<Pull_GetPropertesAvbPrice_RS> <Status ID="2">Nothing available for the specifed dates</Status></Pull_GetPropertesAvbPrice_RS>

2.4.10. List property discounts

2.4.10.1. UsageThis method returns discounts that are applied for stays of partcular lengths or made near the arrival (last minute).

Long stay discount means that in the specifed dates all reservatons at least X and no more than Y nights long have a discount of Z%.

Last minute discount means that reservatons for the specifed dates made at least X and no more than Y days before arrival have a discount of Z%.

2.4.10.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyDiscounts_RQ C Root elementPull_ListPropertyDiscounts_RQ/Authentcaton


Pull_ListPropertyDiscounts_RQ/Authentcaton/UserName


Pull_ListPropertyDiscounts_RQ/Authentcaton/Password


Pull_ListPropertyDiscounts_RQ/PropertyID Integer Property's unique ID

2.4.10.2.1. Example<Pull_ListPropertyDiscounts_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID></Pull_ListPropertyDiscounts_RQ>

2.4.10.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyDiscounts_RS C Root elementPull_ListPropertyDiscounts_RS/Status String(100

) See ListStatuses

Pull_ListPropertyDiscounts_RS/Status@ID Integer See ListStatusesPull_ListPropertyDiscounts_RS/Discounts C, O A collecton of long stay

discountsPull_ListPropertyDiscounts_RS/Discounts@PropertyID

C, Property's unique ID

Pull_ListPropertyDiscounts_RS/Discounts/LongStays

C, O Long stay discounts value, percentage of the fnal price

Pull_ListPropertyDiscounts_RS/Discounts/Lon Integer , O Discount details

RENTALSUNITED


gStays/LongStayPull_ListPropertyDiscounts_RS/Discounts/LongStays/LongStay@DateFrom

String Start of the range(YYYY- -DD format)

Pull_ListPropertyDiscounts_RS/Discounts/LongStays/LongStay@DateTo

String End of the range(YYYY- -DD format)

Pull_ListPropertyDiscounts_RS/Discounts/LongStays/LongStay@Bigger

Integer inimum length of stay in order to get the discount

Pull_ListPropertyDiscounts_RS//Discounts/LongStays/LongStay@Smaller

Integer aximum length of stay in order to get the discount

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes

C, O Last minute discounts

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes/Last inute

Integer C, O Last minute discount, percentage of fnal price

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes/Last inute@DateFrom

String Start of the range(YYYY- -DD format)

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes/Last inute@DateTo

String End of the range(YYYY- -DD format)

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes/Last inute@DaysToArrivalFrom

Integer inimum number of days away from the arrival date when the discount is valid

Pull_ListPropertyDiscounts_RS/Discounts/Last inutes/Last inute@DaysToArrivalTo

Integer aximum number of days away the arrival date when the discount is valid

2.4.10.3.1. Example<Pull_ListPropertyDiscounts_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Discounts PropertyID="1"> <LongStays> <LongStay DateFrom="2012-03-01" DateTo="2012-06-01" Bigger="2" Smaller="20"> 10 </LongStay> <LongStay DateFrom="2012-06-02" DateTo="2012-09-01" Bigger="2" Smaller="20"> 20 </LongStay> </LongStays> <Last inutes> <Last inute DateFrom="2012-03-01" DateTo="2012-06-01" DaysToArrivalFrom="2" DaysToArrivalTo="5"> 10 </Last inute> <Last inute DateFrom="2012-06-02" DateTo="2012-08-01" DaysToArrivalFrom="0" DaysToArrivalTo="1"> 10 </Last inute> </Last inutes> </Discounts></Pull_ListPropertyDiscounts_RS>

2.4.11. List reservations

2.4.11.1. UsageThis method returns a list of reservatons (for your propertes) sorted by last modifcaton date. Callthis method periodically to obtain created, cancelled reservatons and transfer them to your

RENTALSUNITED


system. Use the same intervals between calls as you use for the search for optmal performance (e.g. call every 20 minutes to and search the last 20 minutes as well). Do not use more than 30 minutes for your search unless you have had a failure and need to check any reservatons that may have been entered during your downtme. Under no circumstances should your date range be greater than a week.

2.4.11.2. RequestXML Path Data Type Type DescriptioPull_ListReservatons_RQ C Root elementPull_ListReservatons_RQ/Authentcaton C, Authentcaton detailsPull_ListReservatons_RQ/Authentcaton/UserName


Pull_ListReservatons_RQ/Authentcaton/Password


Pull_ListReservatons_RQ/DateFrom String(19) Start of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_ListReservatons_RQ/DateTo String(19) End of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_ListReservatons_RQ/LocatonID Integer The locaton's unique IDsee ListLocatons

2.4.11.2.1. Example (returns a list of reservations modified between 2013-08-17 14:00:00 and 2013-08-17 14:19:59)<Pull_ListReservatons_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <DateFrom>2013-08-17 14:00:00</DateFrom> <DateTo>2013-08-17 14:20:00</DateTo> <LocatonID>0</LocatonID></Pull_ListReservatons_RQ>

2.4.11.3. ResponseXML Path Data Type Type DescriptioPull_ListReservatons_RS C Root elementPull_ListReservatons_RS/Status String(100

) See ListStatuses

Pull_ListReservatons_RS/Status@ID Integer See ListStatusesPull_ListReservatons_RS/Reservatons C A list of reservatonsPull_ListReservatons_RS/Reservatons/Reservaton

C Single reservaton

Pull_ListReservatons_RS/Reservatons/Reservaton/ReservatonID

Integer Reservaton's unique ID

Pull_ListReservatons_RS/Reservatons/Reservaton/StatusID

Integer The code that identfes a reservaton status, see ListReservatonStatuses

RENTALSUNITED


Pull_ListReservatons_RS/Reservatons/Reservaton/Last od

String The last modifcaton date (creaton or cancellaton) ofthe reservaton(format YYYY- -DD HH- -SS)

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos

C, Informaton about the stay associated with the reservaton

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo

Informaton about the stay

Pull_ListReservatons_RS/Reservatons/Reservaton/ StayInfos/StayInfo/PropertyID


Pull_ListReservatons_RS/Reservatons/Reservaton/ StayInfos/StayInfo/XmlApartmentID

String Propertyns External System ID if provided

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/DateFrom

String(10) Arrival date(YYYY- -DD format)

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/DateTo

String(10) Departure date(YYYY- -DD format)

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/NumberOfGuests


Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs

C, Informaton about reservaton costs

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/RUPrice

Decimal (19,2)

The price returned by one of the RU methods for the property in the selected dates

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/ClientPrice

Decimal (19,2)

Final price for the customer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/AlreadyPaid

Decimal(19,2)

The amount already paid bythe customer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ResapaID

Integer Unique apartment reservaton identfer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/Comments

String(500)

O Additonal comments aboutthe stay

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping

C,O Informaton about reservaton mapping with external systems

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/ReservatonID

String(50)

External system global reservaton identfer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/StayID

String(50)

O External system reservatonidentfer assigned to the property

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/HotelID

String(50)

O External system Apartment identfer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/RoomID

String(50)

O External system Room Identfer

Pull_ListReservatons_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/RateID

String(50)

O External system Rate identfer

Pull_ListReservatons_RS/Reservatons/Reserv C, Informaton about the

RENTALSUNITED


aton/CustomerInfo customerPull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Name

String(20) Customer's name

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/SurName

String(30) Customer's surname

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Email

String(100)

Customer's email address

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Phone

String(30) O Customer's phone number with the country code

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/SkypeID

String(50) O Customer's Skype ID

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Address

String(50) O Customer's address

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/ZipCode

String(15) O Customer's zip code

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/CountryID

Integer O Country's unique ID, see ListLocatons (flter LocatonTypeID=2)

Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Passport

String(30) O Customerns Passport Number

Pull_ListReservatons_RS/Reservatons/Reservaton/Creator

String(50) Creator of the reservaton

Pull_ListReservatons_RS/Reservatons/Reservaton/Comments

String(4000)

O Additonal comments

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard

C, O Credit Card informaton

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/CCNumber

String(19) Credit Card number

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/CVC

String(4)

O Credit Card security code

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/NameOnCard

String(400)

Credit Card holder name

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/Expiraton

String(7) Credit Card expiraton date( /YYYY format)

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/BillingAddress

String(400)

O Billing address

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/CardType

String(30) Credit Card provider. Possible values:VISA, ASTERCARD, A EX, DISCOVER, DINERS, CARTE_BLANCHE, JCB, ENROUTE, JAL, AESTRO_UK, DELTA, SOLO, VISA_ELECTRON, DANKORT, LASER, CARTE_BLEU, CARTA_SI, AESTRO_INTERNATIO

Pull_ListReservatons_RS/Reservatons /Reservaton/CreditCard/Comments

String(400)

O Additonal comments for this Credit Card

Pull_ListReservatons_RS/Reservatons/P SR String(100 O Reservaton P S Id

RENTALSUNITED


eservatonId )Pull_ListReservatons_RS/Reservatons/Reservaton/CancelTypeID

Integer O Cancellaton type. SeeList cancellaton types

Pull_ListReservatons_RS/Reservatons/Reservaton/IsArchived

Bool Indicates whether reservaton is archived

2.4.11.3.1. Example<Pull_ListReservatons_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reservatons> <Reservaton> <ReservatonID>123</ReservatonID> <Status>1</Status> <Last od>2012-03-01 10:10:02</Last od> <StayInfos> <StayInfo> <PropertyID>1</PropertyID> <XmlApartmentID>Ext. ID. 1</XmlApartmentID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs> <ResapaID>1</ResapaID> <Mapping> <ReservationID>123</ReservationID> <StayID>123</StayID> <HotelID>123</HotelID> <RoomID>123</RoomID> <RateID>123</RateID> </Mapping> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>42</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> </Reservaton> <Reservaton> <ReservatonID>124</ReservatonID> <StatusID>2</StatusID> <Last od>2012-03-01 20:10:02</Last od> <StayInfo> <PropertyID>2</PropertyID> <XmlApartmentID>Ext. ID. 2</XmlApartmentID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs>

RENTALSUNITED


<RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> <ResapaID>2</ResapaID> </StayInfo> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>33</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> <Comments>test</Comments> 39huy <CancelTypeID>1</CancelTypeID> <Archived>false</Archived> </Reservaton> </Reservatons></Pull_ListReservatons_RS>

2.4.12. List own reservations

2.4.12.1. UsageThis method returns a list of reservatons (created by you) by last modifcaton date. You can call this method to fnd out how many reservaton you created in the specifed period.

2.4.12.2. RequestXML Path Data Type Type DescriptioPull_GetOwnReservatons_RQ C Root elementPull_GetOwnReservatons_RQ/Authentcaton C, Authentcaton detailsPull_GetOwnReservatons_RQ/Authentcaton/UserName


Pull_GetOwnReservatons_RQ/Authentcaton/Password


Pull_GetOwnReservatons_RQ/DateFrom String(19) Start of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_GetOwnReservatons_RQ/DateTo String(19) End of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_GetOwnReservatons_RQ/LocatonID Integer The locaton's unique IDsee ListLocatons

2.4.12.2.1. Example (returns a list of reservations created/cancelled between 2013-08-17 00:00:00 and 2013-08-27 23:59:59)<Pull_GetOwnReservatons_RQ>

RENTALSUNITED


<Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <DateFrom>2013-08-17 15:40:00</DateFrom> <DateTo>2013-08-17 15:59:59</DateTo> <LocatonID>0</LocatonID></Pull_GetOwnReservatons_RQ>

2.4.12.3. ResponseXML Path Data Type Type DescriptioPull_GetOwnReservatons_RS C Root elementPull_GetOwnReservatons_RS/Status String(100

) See ListStatuses

Pull_GetOwnReservatons_RS/Status@ID Integer See ListStatusesPull_GetOwnReservatons_RS/Reservatons C A list of reservatonsPull_GetOwnReservatons_RS/Reservatons/Reservaton

C Single reservaton

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/ReservatonID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StatusID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/Last od


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo

C, Informaton about the stay

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/PropertyID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/XmlApartmentID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/DateFrom


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/DateTo


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/NumberOfGuests


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/Costs

C, Informaton about the reservaton costs

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/Costs/RUPrice

Decimal (19,2)


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/Costs/ClientPrice

Decimal (19,2)


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/StayInfo/Costs/AlreadyPaid

Decimal(19,2)


Pull_GetOwnReservatons_RS/Reservatons/R String(500 O Additonal comments about

RENTALSUNITED


eservaton/StayInfo/Comments ) this stayPull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo

C, Informaton about the customer

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/Name


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/SurName


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/Email

String(100)


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/Phone

String(30) O Customer's phone number with country code

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/SkypeID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/Address


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/ZipCode


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/CountryID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CustomerInfo/Passport


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/Creator

String(50) Creator of this reservaton

Pull_GetOwnReservatons_RS/Reservatons/Reservaton/Comments

String(4000)


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/CancelTypeID


Pull_GetOwnReservatons_RS/Reservatons/Reservaton/IsArchived


2.4.12.3.1. Example<Pull_GetOwnReservatons_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reservatons> <Reservaton> <ReservatonID>123</ReservatonID> <Status>1</Status> <Last od>2012-03-01 10:10:02</Last od> <StayInfo> <PropertyID>1</PropertyID> <XmlApartmentID>Ext. ID. 1</XmlApartmentID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs> </StayInfo> <CustomerInfo> <Name>Test</Name>

RENTALSUNITED


<SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> </Reservaton> <Reservaton> <ReservatonID>124</ReservatonID> <Status>2</Status> <Last od>2012-03-01 20:10:02</Last od> <StayInfo> <PropertyID>2</PropertyID> <XmlApartmentID>Ext. ID. 2</XmlApartmentID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>33</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> <Comments>test</Comments> <CancelTypeID>1</CancelTypeID> <Archived>false</Archived> </Reservaton> </Reservatons></Pull_GetOwnReservatons_RS>

2.4.13. Get reservation by ID

2.4.13.1. UsageThis method returns one reservaton by specifed identfer.

2.4.13.2. RequestXML Path Data Type Type DescriptioPull_GetReservatonByID_RQ C Root elementPull_GetReservatonByID_RQ/Authentcaton C, Authentcaton detailsPull_GetReservatonByID_RQ/Authentcaton/UserName


Pull_GetReservatonByID_RQ/Authentcaton/ String(50) Provided by RU

RENTALSUNITED


PasswordPull_GetReservatonByID_RQ/ReservatonID Integer Reservaton's unique ID

2.4.13.2.1. Example<Pull_GetReservatonByID_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <ReservatonID>14634678</ReservatonID></Pull_GetReservatonByID_RQ>

2.4.13.3. ResponseXML Path Data Type Type DescriptioPull_GetReservatonByID_RS C Root elementPull_GetReservatonByID_RS/Status String(100

) See ListStatuses

Pull_GetReservatonByID_RS/Status@ID Integer See ListStatusesPull_GetReservatonByID_RS/Reservaton C Single reservatonPull_GetReservatonByID_RS/Reservaton/ReservatonID


Pull_GetReservatonByID_RS/Reservaton/StatusID


Pull_GetReservatonByID_RS/Reservaton/Last od


Pull_GetReservatonByID_RS/Reservaton/StayInfos


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo


Pull_GetReservatonByID_RS/Reservaton/ StayInfos/StayInfo/PropertyID


Pull_GetReservatonByID_RS/Reservaton/ StayInfos/StayInfo/XmlApartmentID


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/DateFrom


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/DateTo


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/NumberOfGuests


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/Costs


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/Costs/RUPrice

Decimal (19,2)


Pull_GetReservatonByID_RS/Reservaton/Sta Decimal Final price for the customer

RENTALSUNITED


yInfos/StayInfo/Costs/ClientPrice (19,2)Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/Costs/AlreadyPaid

Decimal(19,2)


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ResapaID


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/Comments

String(500)


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping/ReservatonID

String(50)


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping/StayID

String(50)

O External system reservaton identfer assigned to the property

Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping/HotelID

String(50)


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping/RoomID

String(50)


Pull_GetReservatonByID_RS/Reservaton/StayInfos/StayInfo/ apping/RateID

String(50)


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/Name


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/SurName


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/Email

String(100)


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/Phone


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/SkypeID


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/Address


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/ZipCode


Pull_GetReservatonByID_RS/Reservaton/CustomerInfo/CountryID


Pull_ListReservatons_RS/Reservatons/Reservaton/CustomerInfo/Passport


Pull_GetReservatonByID_RS/Reservaton/Creator


Pull_GetReservatonByID_RS/Reservaton/Comments

String(4000)


Pull_GetReservatonByID_RS/Reservaton/CreditCard


Pull_GetReservatonByID_RS/Reservaton/CreditCard/CCNumber


RENTALSUNITED


Pull_GetReservatonByID_RS/Reservaton/CreditCard/CVC

String(4)


Pull_GetReservatonByID_RS/Reservaton/CreditCard/NameOnCard

String(400)


Pull_GetReservatonByID_RS/Reservaton/CreditCard/Expiraton


Pull_GetReservatonByID_RS/Reservaton/CreditCard/BillingAddress

String(400)

O Billing address

Pull_GetReservatonByID_RS/Reservaton/CreditCard/CardType


Pull_GetReservatonByID_RS/Reservaton/CreditCard/Comments

String(400)


Pull_GetReservatonByID_RS/Reservaton/CancelTypeID


Pull_GetReservatonByID_RS/Reservaton/IsArchived


2.4.13.3.1. Example<Pull_GetReservatonByID_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reservaton> <ReservatonID>123</ReservatonID> <Status>1</Status> <Last od>2012-03-01 10:10:02</Last od> <StayInfos> <StayInfo> <PropertyID>1</PropertyID> <XmlApartmentID>Ext. ID. 1</XmlApartmentID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs> <ResapaID>1</ResapaID> < apping> <ReservatonID>123</ReservatonID> <StayID>123</StayID> <HotelID>123</HotelID> <RoomID>123</RoomID> <RateID>123</RateID> </ apping> </StayInfo> </StayInfos>

RENTALSUNITED


<CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>42</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> <CancelTypeID>1</CancelTypeID> <Archived>false</Archived> </Reservaton></Pull_GetReservatonByID_RS>

2.4.14. List property change log

2.4.14.1. UsageThis method returns informaton about property data changes.

2.4.14.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyChangeLog_RQ C Root elementPull_ListPropertyChangeLog_RQ/Authentcaton


Pull_ListPropertyChangeLog_RQ/Authentcaton/UserName


Pull_ListPropertyChangeLog_RQ/Authentcaton/Password


Pull_ListPropertyChangeLog_RQ/PropertyID Integer Property's unique ID

2.4.14.2.1. Example<Pull_ListPropertyChangeLog_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID></Pull_ListPropertyChangeLog_RQ>

2.4.14.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyChangeLog_RS C Root elementPull_ListPropertyChangeLog_RS/Status String(100

) See ListStatuses

Pull_ListPropertyChangeLog_RS/Status@ID Integer See ListStatusesPull_ListPropertyChangeLog_RS/ChangeLog C, O Element is empty when an

error occurresPull_ListPropertyChangeLog_RS/ChangeLog@PropertyID


Pull_ListPropertyChangeLog_RS/ChangeLog@NLA

Boolean Indicates whether the property is archived

RENTALSUNITED


Pull_ListPropertyChangeLog_RS/ChangeLog@IsActve

Boolean Indicates whether the property is actve

Pull_ListPropertyChangeLog_RS/ChangeLog/StatcData

String Last modifcaton of the property's data (living space, address, coordinates, amenites, compositon, etc.)(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertyChangeLog_RS/ChangeLog/Pricing

String Last modifcaton of the property's price (base price,seasonal price, discounts)(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertyChangeLog_RS/ChangeLog/Availability

String Last modifcaton of the property's availability(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertyChangeLog_RS/ChangeLog/Image

String Last modifcaton of the property's images(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertyChangeLog_RS/ChangeLog/Descripton

String Last modifcaton of the property's descripton(YYYY- -DD HH: :SS format – 24h format)

2.4.14.3.1. Example<Pull_ListPropertyChangeLog_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <ChangeLog PropertyID="1" NLA="false" IsActve="true"> <StatcData>2013-05-07 12:10:00</StatcData> <Pricing>2013-05-07 22:13:20</Pricing> <Availability>2013-04-07 02:20:00</Availability> <Image>2013-02-22 14:40:00</Image> <Descripton>2013-03-01 10:02:20</Descripton> </ChangeLog></Pull_ListPropertyChangeLog_RS>

2.4.15. List properties change log

2.4.15.1. UsageThis method returns informaton about the property's data changes.

2.4.15.2. RequestXML Path Data Type Type DescriptioPull_ListPropertesChangeLog_RQ C Root elementPull_ListPropertesChangeLog_RQ/Authentcaton


Pull_ListPropertesChangeLog_RQ/Authentca String(50) Provided by RU

RENTALSUNITED


ton/UserNamePull_ListPropertesChangeLog_RQ/Authentcaton/Password


Pull_ListPropertesChangeLog_RQ/PropertyIDs

C, O Omit this element if you want to receive data for all propertes

Pull_ListPropertesChangeLog_RQ/PropertyIDs/PropertyID


2.4.15.2.1. Example<Pull_ListPropertesChangeLog_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyIDs> <PropertyID>1</PropertyID> <PropertyID>2</PropertyID> </PropertyIDs></Pull_ListPropertesChangeLog_RQ>

2.4.15.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertesChangeLog_RS C Root elementPull_ListPropertesChangeLog_RS/Status String(100

) See ListStatuses

Pull_ListPropertesChangeLog_RS/Status@ID Integer See ListStatusesPull_ListPropertesChangeLog_RS/ChangeLogs C, O Element is empty when an

error occurresPull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog

C Contains informaton about a single property's changelog

Pull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog@PropertyID


Pull_ListPropertyChangeLog_RS/ChangeLogs/ChangeLog@NLA

Boolean Indicates whether the property is archived

Pull_ListPropertyChangeLog_RS/ChangeLogs/ChangeLog@IsActve

Boolean Indicates whether the property is actve

Pull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog/StatcData

String Last modifcaton of the property's data (living space, address, coordinates, amenites, compositon, etc.)(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog/Pricing

String Last modifcaton of the property's price (base price,seasonal price, discounts)(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertesChangeLog_RS/ChangeLogs String Last modifcaton of the

RENTALSUNITED


/ChangeLog/Availability property's availability(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog/Image

String Last modifcaton of the property's images(YYYY- -DD HH: :SS format – 24h format)

Pull_ListPropertesChangeLog_RS/ChangeLogs/ChangeLog/Descripton

String Last modifcaton of the property's descripton(YYYY- -DD HH: :SS format – 24h format)

2.4.15.3.1. Example<Pull_ListPropertesChangeLog_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <ChangeLogs> <ChangeLog PropertyID="1" NLA="true" IsActve="false" > <StatcData>2013-02-14 09:28:13</StatcData> <Pricing>2013-02-27 07:15:29</Pricing> <Availability>2013-03-21 14:10:55</Availability> <Image>2013-03-12 09:09:23</Image> <Descripton>2012-04-27 00:00:00</Descripton> </ChangeLog> <ChangeLog PropertyID="2" NLA="false" IsActve="false"> <StatcData>2013-12-23 19:07:32</StatcData> <Pricing>2013-12-24 06:36:19</Pricing> <Availability>2014-01-09 20:18:08</Availability> <Image>2013-10-28 16:12:56</Image> <Descripton>2013-04-29 08:20:51</Descripton> </ChangeLog> </ChangeLogs></Pull_ListPropertesChangeLog_RS>

2.4.16. List property price changes

2.4.16.1. UsageThis method returns informaton about the property's price changes since the specifed date. Each returned date means that the price (base price or a discount) for that date has been changed. Past dates are not returned.

2.4.16.2. RequestXML Path Data Type Type DescriptioPull_ListPropertyPriceChanges_RQ C Root elementPull_ListPropertyPriceChanges_RQ/Authentcaton


Pull_ListPropertyPriceChanges_RQ/Authentcaton/UserName


Pull_ListPropertyPriceChanges_RQ/Authentcaton/Password


Pull_ListPropertyPriceChanges_RQ/PropertyID


Pull_ListPropertyPriceChanges_RQ/Since String Date since which the

RENTALSUNITED


changes are to be returned (YYYY- -DD HH: :SS format – 24h format)

2.4.16.2.1. Example<Pull_ListPropertyPriceChanges_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <Since>2013-10-16 12:00:00</Since></Pull_ListPropertyPriceChanges_RQ>

2.4.16.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyPriceChanges_RS C Root elementPull_ListPropertyPriceChanges_RS/Status String(100

) See ListStatuses

Pull_ListPropertyPriceChanges_RS/Status@ID Integer See ListStatusesPull_ListPropertyPriceChanges_RS/PriceChanges

C Element is empty when when there are no changes to show

Pull_ListPropertyChangeLog_RS/PriceChanges/Day

String A single day when a change occurred(YYYY- -DD HH: :SS format)

2.4.16.3.1. Example<Pull_ListPropertyPriceChanges_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <PriceChanges> <Day>2013-05-22</Day> <Day>2013-06-02</Day> <Day>2013-06-03</Day> <Day>2013-06-04</Day> </ChangeLog></Pull_ListPropertyPriceChanges_RS>

2.4.17. List property availability changes

2.4.17.1. UsageThis method returns informaton about property availability changes. Each returned date means that the availability was changed since the date specifed in the <Since> parameter. Past dates are not returned.

2.4.17.2. Request was changed since the specified dateXML Path Data Type Type DescriptioPull_ListPropertyAvbChanges_RQ C Root elementPull_ListPropertyAvbChanges_RQ/Authentca C, Authentcaton details

RENTALSUNITED


tonPull_ListPropertyAvbChanges_RQ/Authentcaton/UserName


Pull_ListPropertyAvbChanges_RQ/Authentcaton/Password


Pull_ListPropertyAvbChanges_RQ/PropertyID Integer Property's unique IDPull_ListPropertyAvbChanges_RQ/Since String Date since which the

changes are to be returned (YYYY- -DD HH: :SS format – 24h format)

2.4.17.2.1. Example<Pull_ListPropertyAvbChanges_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <Since>2013-10-16 12:00:00</Since></Pull_ListPropertyAvbChanges_RQ>

2.4.17.3. ResponseXML Path Data Type Type DescriptioPull_ListPropertyAvbChanges_RS C Root elementPull_ListPropertyAvbChanges_RS/Status String(100

) See ListStatuses

Pull_ListPropertyAvbChanges_RS/Status@ID Integer See ListStatusesPull_ListPropertyAvbChanges_RS/PriceChanges

C Element is empty when when there are no changes to show

Pull_ListPropertyAvbChanges_RS/PriceChanges/Day

String A single day when a change occurred(YYYY- -DD HH: :SS format)

2.4.17.3.1. Example<Pull_ListPropertyAvbChanges_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <AvbChanges> <Day>2013-05-22</Day> <Day>2013-06-02</Day> <Day>2013-06-03</Day> <Day>2013-06-04</Day> </AvbChangeLog></Pull_ListPropertyAvbChanges_RS>

2.4.18. Get Leads

2.4.18.1. UsageThis method returns all reservatons with status requests.

RENTALSUNITED


Pull_GetLeads_RQ C Root elementPull_GetLeads_RQ/Authentication C. Authentcaton detailsPull_GetLeads_RQ/Authentication/UserName String

(50) Provided by RU

Pull_GetLeads_RQ/Authentication/Password String(50)

Provided by RU

Pull_GetLeads_RQ/DateFrom String(10)

Start of the range(YYYY- -DD format)

Pull_GetLeads_RQ/DateTo String(10)

End of the range(YYYY- -DD format)

Pull_GetLeads_RQ/LocationID Integer See ListLocatons

2.4.18.2.1. Example<Pull_GetLeads_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <DateFrom>2013-08-17 13:25:00</DateFrom> <DateTo>2013-08-17 13:45:00</DateTo> <LocationID>5309</LocationID></Pull_GetLeads_RQ>

2.4.18.3. ResponseXML Path Data Type Type Descriptio Pull_GetLeads_RS C Root elementPull_GetLeads_RS/Status String


Pull_GetLeads_RS/Status/@ID Integer See ListStatusesPull_GetLeads_RS/Leads C. List of leadsPull_GetLeads_RS/Leads/Lead C,O Individual leadPull_GetLeads_RS/Leads/Lead/ReservatonID Integer Reservaton's unique IDPull_GetLeads_RS/Leads/Lead/ExternalLeadID Integer O Lead's unique identfer

from the external system that created it

Pull_GetLeads_RS/Leads/Lead/PropertyID Integer O Property's unique IDPull_GetLeads_RS/Leads/Lead/XmlApartmentID

String O Propertyns unique External ID

Pull_GetLeads_RS/Leads/Lead/DateFrom String(10)

O Beginning of lead(YYYY- -DD format)

Pull_GetLeads_RS/Leads/Lead/DateTo String(10)

O End of lead(YYYY- -DD format)

Pull_GetLeads_RS/Leads/Lead/NumberOfGuests

Integer O Number of people for lead

Pull_GetLeads_RS/Leads/Lead/CustomerInfo C. Informaton about the customer

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/Name

String(20)

O Customer's name

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/SurName

String(30)

O Customer's surname

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/ String O Customer's email address

RENTALSUNITED


Email (100)Pull_GetLeads_RS/Leads/Lead/CustomerInfo/Phone

String(20)

O Customer's phone number with the country code

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/SkypeId

String(50)

O Customer's Skype identfed

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/Address

String(50)

O Customer's address

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/ZipCode

String(15)

O Customer's zip code

Pull_GetLeads_RS/Leads/Lead/CustomerInfo/CountryID


Pull_GetLeads_RS/Leads/Lead/CustomerInfo/LanguageID

Integer O Code that identfes the language of the descriptonsee Pull_ListLanguages

Pull_GetLeads_RS/Leads/Lead/Comments String(4000)

O Additonal informaton

Pull_GetLeads_RS/Leads/Lead/Creator String(20)

Informaton about the user who created the lead

Pull_GetLeads_RS/Leads/Lead/DateEntered String(19)

Informaton when the lead was created(YYYY- -DD HH: :SS format)

Pull_GetLeads_RS/Leads/Lead/IsArchived Bool Indicates whether this lead is archived or not

2.4.18.3.1. Example <Pull_GetLeads_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Leads> <Lead> <ReservationID>123456</ReservationID> <ExternalLeadID>123_asd_213</ExternalLeadID> <PropertyID>1</PropertyID> <XmlApartmentID>1</XmlApartmentID> <DateFrom>2015-03-01</DateFrom> <DateTo>2015-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> </CustomerInfo> <Comments>How much is it?</Comments> <Creator>[email protected]</Creator> <DateFrom>2015-02-01</DateFrom> <IsArchived>false</IsArchived> </Lead> </Leads></Pull_GetLeads_RS>

RENTALSUNITED


2.4.19. Get Changeover Days

2.4.19.1. UsageThis method returns the changeover policy for the property.If a property has a changeover policy it means that:• bookings can only start (date from) at dates that have their changeover type set to CheckIn (ID=1) or that don't have a changeover type set at all, which is then represented as a default type Both (ID=4),

• bookings can only end (date to) at dates that have changeover type set to CheckOut (ID=2) or that don't have a changeover type set at all, which is then represented as a default type Both (ID=4),

• no bookings can start or end on dates that have their changeover type set to None (ID=3).

The return value is a sequence of IDs from 1 to 4 for the individual days in the specified range. The order is the same as in the range – from StartDate to EndDate.

2.4.19.2. RequestXML Path Date Type Type Descriptio

Pull_GetChangeoverDays_RQ C Root element

Pull_GetChangeoverDays_RQ/Authentcaton C, Authentcaton details

Pull_GetChangeoverDays_RQ/Authentcaton/UserName


Pull_GetChangeoverDays_RQ/Authentcaton/Password


Pull_GetChangeoverDays_RQ/PropertyID Integer Property's unique ID

Pull_GetChangeoverDays_RQ/StartDate String(10) Start date of the range (YYYY- -DD format)

Pull_GetChangeoverDays_RQ/EndDate String(10) End date of the range (YYYY- -DD format)

2.4.19.2.1. Example<Pull_GetChangeoverDays_RQ> <Authentication> <UserName>test</UserName> <Password>test</Password> </Authentication> <PropertyID>1</PropertyID> <StartDate>2014-10-10</StartDate> <EndDate>2014-10-20</EndDate></Pull_GetChangeoverDays_RQ>

2.4.19.3. ResponseXML Path Date Type Type Descriptio

Pull_GetChangeoverDays_RS C Root element

Pull_GetChangeoverDays_RS/Status String(100)


Pull_GetChangeoverDays_RS/Status@ID Integer Status ID

Pull_GetChangeoverDays_RS/Changeover String A sequence of strings representng the changeover

RENTALSUNITED


policy in the specifed dates

2.4.19.3.1. Example<Pull_GetChangeoverDays_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Changeover>11122233344</Changeover></Pull_GetChangeoverDays_RS>

2.4.20. List Reservations Missing PMS Mapping

2.4.20.1. UsageThis method returns all reservations without PMS mapping on apartments that were downloaded from PMS.

2.4.20.2. RequestXML Path Date Type Type Descriptio

Pull_ListReservatons issingP S apping_RQ C Root element

Pull_ListReservatons issingP S apping_RQ/Authentcaton


Pull_ListReservatons issingP S apping_RQ/Authentcaton/UserName


Pull_ListReservatons issingP S apping_RQ/Authentcaton/Password


Pull_ListReservatons issingP S apping_RQ/DateFrom

String(10) Date when the frst reservaton was entered (YYYY- -DD format)

2.4.20.2.1. Example<Pull_ListReservationsMissingPMSMapping_RQ> <Authentication> <UserName>test</UserName> <Password>test</Password> </Authentication> <DateFrom>2014-10-10</DateFrom></Pull_GetChangeoverDays_RQ>

2.4.20.3. ResponseXML Path Date Type Type Descriptio

Pull_ListReservatons issingP S apping_RS C Root element

Pull_ListReservatons issingP S apping_RS/Status

String(100)


Pull_ListReservatons issingP S apping_RS/Status@ID

Integer Status ID

Pull_ListReservatons issingP S apping_RS/Reservatons

C, List of reservatons missing P S mapping

Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping

C, O Reservaton details

Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/RUReservatonId

Integer O Rentals United reservaton ID

RENTALSUNITED


Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/ExternalReservatonID

String(50)

O Sales Channel reservaton ID

Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/RUPropertyId

Integer O Rentals United property ID

Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/P SPropertyId

String(50)

O Apartment ID in P S

Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/DateFrom


Pull_ListReservatons issingP S apping_RS/Reservatons/Reservaton issingP S Apping/DateTo


2.4.20.3.1. Example<Pull_ListReservationsMissingPMSMapping_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reservations> <ReservationMissingPMSMapping> <RUReservationId>1</RUReservationId> <ExternalReservationId>Test2</ExternalReservationId> <RUPropertyId>3</RUPropertyId> <PMSPropertyId>Test4</PMSPropertyId> <DateFrom>2014-10-10</DateFrom> <DateTo>2014-10-20</DateTo> </ReservationMissingPMSMaping> <ReservationMissingPMSMapping> <RUReservationId>5</RUReservationId> <ExternalReservationId>Test6</ExternalReservationId> <RUPropertyId>7</RUPropertyId> <PMSPropertyId>Test8</PMSPropertyId> <DateFrom>2014-10-21</DateFrom> <DateTo>2014-10-24</DateTo> </ReservationMissingPMSMaping> </Reservations></Pull_ListReservationsMissingPMSMapping_RS>

2.4.21. List reservations for owner

2.4.21.1. UsageThis method is very similar to method 2.4.11 List reservatons. However, this one is dedicated for Revenue anagement System to allow obtain list of reservatons for specifed owner username. Call this method periodically to obtain created, cancelled reservatons and transfer them to your system. Use the same intervals between calls as you use for the search for optmal performance (e.g. call every 20 minutes to and search the last 20 minutes as well). Do not use more than 30 minutes for your search unless you have had a failure and need to check any reservatons that may have been entered during your downtme. Under no circumstances should your date range be greater than a week.

2.4.21.2. RequestXML Path Data Type Type DescriptioPull_ListReservatonsOwnerUser_RQ C Root element

RENTALSUNITED


Pull_ListReservatonsOwnerUser_RQ/Authentcaton


Pull_ListReservatonsOwnerUser_RQ/Authentcaton/UserName


Pull_ListReservatonsOwnerUser_RQ/Authentcaton/Password


Pull_ListReservatonsOwnerUser_RQ/DateFrom

String(19) Start of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_ListReservatonsOwnerUser_RQ/DateTo String(19) End of the range of modifcaton(YYYY- -DD HH: :SS format)

Pull_ListReservatonsOwnerUser_RQ/LocatonID

Integer The locaton's unique IDsee ListLocatons

Pull_ListReservatonsOwnerUser_RQ/Username

String (50) Ownerns username

2.4.21.2.1. Example (returns a list of reservations modified between 2013-08-17 14:00:00 and 2013-08-17 14:19:59)<Pull_ListReservatonsOwnerUser_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <DateFrom>2013-08-17 14:00:00</DateFrom> <DateTo>2013-08-17 14:20:00</DateTo> <LocatonID>0</LocatonID> <Username>[email protected]</Username></Pull_ListReservatonsOwnerUser_RQ>

2.4.21.3. ResponseXML Path Data Type Type DescriptioPull_ListReservatonsOwnerUser_RS C Root elementPull_ListReservatonsOwnerUser_RS/Status String(100

) See ListStatuses

Pull_ListReservatonsOwnerUser_RS/Status@ID


Pull_ListReservatonsOwnerUser_RS/Reservatons

C A list of reservatons

Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton

C Single reservaton

Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/ReservatonID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StatusID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/Last od

String The last modifcaton date (creaton or cancellaton) ofthe reservaton

RENTALSUNITED


(format YYYY- -DD HH- -SS)

Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/ StayInfos/StayInfo/PropertyID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/ StayInfos/StayInfo/XmlApartmentID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/DateFrom


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/DateTo


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/NumberOfGuests


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/RUPrice

Decimal (19,2)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/ClientPrice

Decimal (19,2)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/Costs/AlreadyPaid

Decimal(19,2)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ResapaID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/Comments

String(500)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/ReservatonID

String(50)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/StayID

String(50)

O External system reservatonidentfer assigned to the property

Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ appin

String(50)


RENTALSUNITED


g/HotelIDPull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/RoomID

String(50)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/StayInfos/StayInfo/ apping/RateID

String(50)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/Name


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/SurName


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/Email

String(100)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/Phone


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/SkypeID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/Address


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/ZipCode


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/CountryID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CustomerInfo/Passport


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/Creator


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/Comments

String(4000)


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/CCNumber


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/CVC

String(4)


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/NameOnCard

String(400)


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/Expiraton


Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/BillingAddress

String(400)

O Billing address

Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/CardType

String(30) Credit Card provider. Possible values:VISA, ASTERCARD, A EX, DISCOVER, DINERS, CARTE_BLANCHE, JCB, ENROUTE, JAL,

RENTALSUNITED


AESTRO_UK, DELTA, SOLO, VISA_ELECTRON, DANKORT, LASER, CARTE_BLEU, CARTA_SI, AESTRO_INTERNATIO

Pull_ListReservatonsOwnerUser_RS/Reservatons /Reservaton/CreditCard/Comments

String(400)


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/CancelTypeID


Pull_ListReservatonsOwnerUser_RS/Reservatons/Reservaton/IsArchived


2.4.21.3.1. Example<Pull_ListReservatonsOwnerUser_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <Reservatons> <Reservaton> <ReservatonID>123</ReservatonID> <Status>1</Status> <Last od>2012-03-01 10:10:02</Last od> <StayInfos> <StayInfo> <PropertyID>1</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs> <ResapaID>1</ResapaID> <Mapping> <ReservationID>123</ReservationID> <StayID>123</StayID> <HotelID>123</HotelID> <RoomID>123</RoomID> <RateID>123</RateID> </Mapping> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>42</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> </Reservaton> <Reservaton> <ReservatonID>124</ReservatonID> <StatusID>2</StatusID> <Last od>2012-03-01 20:10:02</Last od> <StayInfo>

RENTALSUNITED


<PropertyID>2</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> <ResapaID>2</ResapaID> </StayInfo> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>33</CountryID> </CustomerInfo> <Creator>[email protected]</Creator> <Comments>test</Comments> <CancelTypeID>1</CancelTypeID> <Archived>false</Archived> </Reservaton> </Reservatons></Pull_ListReservatonsOwnerUser_RS>

3. Push methods

3.1. Static property data

3.1.1. Put building

3.1.1.1. UsageThis method inserts a single building into the RU system.

3.1.1.2. RequestXML Path Data Type Type DescriptioPush_PutBuilding_RQ C Root elementPush_PutBuilding_RQ/Authentcaton C, Authentcaton detailsPush_PutBuilding_RQ/Authentcaton/UserName


Push_PutBuilding_RQ/Authentcaton/Password


Push_PutBuilding_RQ/BuildingName String(20) Name of the building

3.1.1.2.1. Example<Push_PutBuilding_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <BuildingName>Building 1</BuildingName>

RENTALSUNITED


</Push_PutBuilding_RQ>

3.1.1.3. ResponseXML Path Data Type Type DescriptioPush_PutBuilding_RS C Root elementPush_PutBuilding_RS/Status String(100

) See ListStatuses

Push_PutBuilding_RS/Status@ID Integer See ListStatusesPush_PutBuilding_RS/BuildingID Integer O Building's unique ID

3.1.1.3.1. Example<Push_PutBuilding_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <BuildingID> 1</BuildingID></Push_PutBuilding_RS>

3.1.2. Put owner

3.1.2.1. UsageThis method inserts detailed informaton about a property owner.

3.1.2.2. RequestXML Path Data Type Type DescriptioPush_PutOwner_RQ C Root elementPush_PutOwner_RQ/Authentcaton C, Authentcaton detailsPush_PutOwner_RQ/Authentcaton/UserName


Push_PutOwner_RQ/Authentcaton/Password


Push_PutOwner_RQ/Owner C Owner's detailsPush_PutOwner_RQ/Owner@OwnerID Integer O ID of the owner. This is only

required when updatng theowner's informaton. Can only be changed by the Agent who created the owner.

Push_PutOwner_RQ/Owner/FirstName String(20) Owner's frst namePush_PutOwner_RQ/Owner/SurName String(30) Owner's surnamePush_PutOwner_RQ/Owner/Email String(100

) Owner's email address

Push_PutOwner_RQ/Owner/Phone String(20) Owner's phone number with the country code

3.1.2.2.1. Example<Push_PutOwner_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Owner> <FirstName>John</FirstName>

RENTALSUNITED


<SurName>Smith</SurName> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> </Owner></Push_PutOwner_RQ>

3.1.2.3. ResponseXML Path Data Type Type DescriptioPush_PutOwner_RS C Root elementPush_PutOwner_RS/Status String(100

) See ListStatuses

Push_PutOwner_RS/Status@ID Integer See ListStatusesPush_PutOwner_RS/OwnerID Integer Property's unique ID owner

3.1.2.3.1. Example<Push_PutOwner_RS> <Status ID="0">Success</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID> <OwnerID>1 </OwnerID></Push_PutOwner_RS>

3.1.3. Put property

3.1.3.1. UsageYou can use this method to either upload a new property to Rentals United (if you omit Push_PutProperty_RQ/Property/ID) or update an existng property (in such cases set Push_PutProperty_RQ/Property/ID to the value received in the response for Push_PutProperty_RS/ID when the property was originally inserted).

Please note: Elements and attributes marked as X can be omitted in an update mode. Omitted elements, attributes do not result any changes of data in RentalsUnited. If you need to remove some data just define an element, attribute with an empty value.

3.1.3.2. RequestXML Path Data Type Type DescriptioPush_PutProperty_RQ Integer C Root elementPush_PutProperty_RQ/Authentcaton C, Authentcaton detailsPush_PutProperty_RQ/Authentcaton/UserName


Push_PutProperty_RQ/Authentcaton/Password


Push_PutProperty_RQ/Property C Single property

Push_PutProperty_RQ/Property/ID Integer O Property's unique ID, use this element if you want to update an already uploadedproperty

Push_PutProperty_RQ/Property/PUID String(50) O Property's unique ID in the uploader system

Push_PutProperty_RQ/Property/PUID@BuildingID

Integer O Unique ID of the building that houses the property, defne -1 when you do not

RENTALSUNITED


need to assign the property to a building

Push_PutProperty_RQ/Property/Name String(150)

, X Property name. Use CDATA if the name contains specialcharacters

Push_PutProperty_RQ/Property/OwnerID Integer The property owner's IDSee PutOwner

Push_PutProperty_RQ/Propertes/Property/DetailedLocatonID

Integer ,X The most detailed locatonSee ListLocatonsDetailedLocatonID should be provided with at least city precision

Push_PutProperty_RQ/Property/IsActve Boolean Use this element if you want to actvate (True/1) or deactvate (False/0) the property in the RU system.IsActve and IsArchived cannot be simultaneously set to true

Push_PutProperty_RQ/Property/IsArchived Boolean Use this element if you want to archive (True/1) or restore (False/0) the property in RU system.IsActve and IsArchived cannot be simultaneously set to true

Push_PutProperty_RQ/Property/CleaningPrice

Decimal (19,2)

, X Property cleaning price, always added to the fnal price of the booking

Push_PutProperty_RQ/Property/Space Integer , X Living space in square meters

Push_PutProperty_RQ/Property/StandardGuests

Integer , X Number of guest included in the base price

Push_PutProperty_RQ/Property/CanSleep ax

Integer , X aximum number of guests

Push_PutProperty_RQ/Property/PropertyTypeID

Integer , X See ListPropTypes method

Push_PutProperty_RQ/Property/ObjectTypeID

Integer , X See ListOTAPropTypes method

Push_PutProperty_RQ/Property/Floor Integer , X Apartment foorPush_PutProperty_RQ/Property/Street String(100

) , X Property's street detais

(street name, building/fat number)

Push_PutProperty_RQ/Property/ZipCode String(15) , X Property's zip codePush_PutProperty_RQ/Property/Coordinates C, X Property's geographical

coordinatesPush_PutProperty_RQ/Property/Coordinates/Lattude

String(50) Geographic lattude

Push_PutProperty_RQ/Property/Coordinates/Longitude

String(50) Geographic longitude

RENTALSUNITED


Push_PutProperty_RQ/Property/Distances C, O, X A collecton of distances to main city atractons/points of interest

Push_PutProperty_RQ/Property/Distances/Distance

C Distance details

Push_PutProperty_RQ/Property/Distances/DestnatonID

Integer See ListDestnatons

Push_PutProperty_RQ/Property/Distances/DistanceUnitID

Integer See ListDistanceUnits

Push_PutProperty_RQ/Property/Distances/DistanceValue

Decimal (5,2)

Value of distance in distance units

Push_PutProperty_RQ/Property/CompositonRooms

C, O, X A collecton of rooms

Push_PutProperty_RQ/Property/CompositonRooms/CompositonRoomID


Push_PutProperty_RQ/Property/CompositonRoomID@Count

Integer The amount of each room type in the property

Push_PutProperty_RQ/Property/CompositonRoomsAmenites

C, O, X A collecton of rooms with amenites, the amenites will be assigned to the specifed room. Any generalamenites (e.g. parking or wireless internet connecton) should be defned in Push_PutProperty_RQ/Property/Amenites element

Push_PutProperty_RQ/Property/CompositonRoomsAmenites/CompositonRoomAmenites

C, A single room

Push_PutProperty_RQ/Property/CompositonRoomsAmenites/CompositonRoomAmenites@CompositonRoomID


Push_PutProperty_RQ/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenites

C,O A collecton of amenites available in the specifed room

Push_PutProperty_RQ/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenity

Integer See ListAmenitesAvailableForRooms

Push_PutProperty_RQ/Property/CompositonRoomsAmenites/CompositonRoomAmenites/Amenity@Count

Integer Number of each amenity

Push_PutProperty_RQ/Property/Amenites C, O, X A collecton of apartment amenites

Push_PutProperty_RQ/Property/Amenites/Amenity

Integer See ListAmenites

Push_PutProperty_RQ/Property/Amenites/AmenityID@Count

Integer Amount of each amenity

Push_PutProperty_RQ/Property/Images C, O, X A collecton of property images

RENTALSUNITED


Push_PutProperty_RQ/Property/Images/Image

String Image url. inimum image resoluton for sales channels is 1024 by 683 pixels

Push_PutProperty_RQ/Property/Images/Image@ImageTypeID

Integer Image typeSee ListImageTypes

Push_PutProperty_RQ/Property/ArrivalInstructons

C, , X Property arrival instructons

Push_PutProperty_RQ/Property/ArrivalInstructons/Landlord

String(20) , X Name of the property's landlord

Push_PutProperty_RQ/Property/ArrivalInstructons/Email

String(30) , X Landlord's email address

Push_PutProperty_RQ/Property/ArrivalInstructons/Phone

String(20) , X Landlord's phone number (with the country code)

Push_PutProperty_RQ/Property/ArrivalInstructons/DaysBeforeArrival

Integer , X The amount of days before arriving in which the guest should contact the landlord

Push_PutProperty_RQ/Property/ArrivalInstructons/HowToArrive

C, , X Instructons how to arrive

Push_PutProperty_RQ/Property/ArrivalInstructons/HowToArrive/Text

String O Text that describe how to arrive to the property. Use CDATA if text contains special characters.

Push_PutProperty_RQ/Property/ArrivalInstructons/HowToArrive/Text@LanguageID


Push_PutProperty_RQ/Property/ArrivalInstructons/PickupService

C, , X

Push_PutProperty_RQ/Property/ArrivalInstructons/PickupService/Text

String O Text that describes the pickup service. Value returned as CDATA

Push_PutProperty_RQ/Property/ArrivalInstructons/PickupService/Text@LanguageID


Push_PutProperty_RQ/Property/CheckInOut C, , X Check in, check out details

Push_PutProperty_RQ/Property/CheckInOut/CheckInFrom

String(5) , X Accepted check in tme – from(HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/CheckInTo

String(5) , X Accepted check in tme – to(HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/CheckOutUntl

String(5) , X The latest check out tme(HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/Place

String(30) , X The locaton where the check in takes place

Push_PutProperty_RQ/Property/CheckInOut/LateArrivalFees

C, O, X A collecton of fees for late arrivals by arrival tme (separable ranges)

RENTALSUNITED


Push_PutProperty_RQ/Property/CheckInOut/LateArrivalFees/Fee

Decimal (19,2)

Fee for a late arrival

Push_PutProperty_RQ/Property/CheckInOut/LateArrivalFees/Fee@From

String(5) Start hour of a range(HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/LateArrivalFees/Fee@To

String(5) End hour of a range (HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/EarlyDepartureFees

C, O, X A collecton of fees for earlydepartures by arrival tmes (separable ranges)

Push_PutProperty_RQ/Property/CheckInOut/EarlyDepartureFees/Fee

Decimal (19,2)

Fee for an early departure

Push_PutProperty_RQ/Property/CheckInOut/EarlyDepartureFees/Fee@From

String(5) Start hour of a range(HH: format, 24h format)

Push_PutProperty_RQ/Property/CheckInOut/EarlyDepartureFees/Fee@To

String(5) End hour of a range (HH: format, 24h format)

Push_PutProperty_RQ/Property/Payment ethods

C, A collecton of acceptable payment methods

Push_PutProperty_RQ/Property/Payment ethods/Payment ethod

String(500)

, X Payment method details, i.e. Bank account. Use CDATA if the text contains special characters.

Push_PutProperty_RQ/Property/Payment ethods/Payment ethod@Payment ethodID

Integer Payment methodSee ListPayment ethods

Push_PutProperty_RQ/Property/Deposit Decimal (19,2)

Deposit amount depending on the deposit type

Push_PutProperty_RQ/Property/Deposit@DepositTypeID


Push_PutProperty_RQ/Property/CancellatonPolicies

C, , X A collecton of cancellaton policies

Push_PutProperty_RQ/Property/CancellatonPolicies/CancellatonPolicy

Decimal (19,2)

Percentage of total price. The ValidFrom, ValidTo atributes represent the number of days lef to the guests' arrival between which the policy is valid

Push_PutProperty_RQ/Property/CancellatonPolicies/CancellatonPolicy@ValidFrom

Integer Start of the range when the policy is valid

Push_PutProperty_RQ/Property/CancellatonPolicies/CancellatonPolicy@ValidTo

Integer End of the range when the policy is valid

Push_PutProperty_RQ/Property/CancellatonPoliciesText

C, O, X A collecton of cancellaton policies as text

Push_PutProperty_RQ/Property/CancellatonPoliciesText/CancellatonPolicyText

C, Property cancellatonPolicyText

Push_PutProperty_RQ/Property/CancellatonPoliciesText/CancellatonPolicyText@LanguageID

Integer Code that identfes the language of the cancellatonpolicy text

RENTALSUNITED


Push_PutProperty_RQ/Property/CancellatonPoliciesText/CancellatonPolicyText/Text

String(300)

Text that describes the cancellaton policy

Push_PutProperty_RQ/Property/Descriptons C, , X A collecton of descriptons

Push_PutProperty_RQ/Property/Descriptons/Descripton

C, Property descripton

Push_PutProperty_RQ/Property/Descriptons/Descripton@LanguageID


Push_PutProperty_RQ/Property/Descriptons/Descripton/Text

String(3000)

Text that describes the property. The HT L code inthis feld must be inside the <![CDATA[]]> tag; it will be transformed into the formated text.

Push_PutProperty_RQ/Property/Descriptons/Descripton/Image

String(300)

Image that describes the property

Push_PutProperty_RQ/Property/SecurityDeposit

Decimal (8,2)

O, X Refundable security depositamount depending on the deposit type

Push_PutProperty_RQ/Property/SecurityDeposit@DepositTypeID


Push_PutProperty_RQ/Property/AdditonalFees

C, O, X A collecton of additonal feesSee notes for explanaton

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee/Value

Decimal (10,4)

The value of the additonal fee. If discrimioatir if perceotage type is passed, value must be divided by 100. Si a 15% shiuld be passed as 0.15

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@KindID

Integer Additonal fee kindSee ListAdditonalFeeKindsDEPRECATED and lef only for backwards compatbility,you can omit it if you provide @FeeTaxType

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@FeeTaxType

Integer Type of the tax/fee. See ListAdditonalFeeTypes

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@DiscriminatorID

Integer How the fee should be calculated (e.g. per night, per person, etc.)See ListAdditonalFeeDiscriminators

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@CollectTime

Integer O When the fee should be collected (1 - upon booking2- upon arrival). If not specifed, default value is set to:

RENTALSUNITED


1- upon booking

Collect tme is currently supported by Expedia only. All other sales channels treat all fees as to be paid upon booking. Is the fee obligatory or optonal. E.g. taxes are usually not optonal, fees for some extras are.

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@Optonal

Boolean O You may mark fee as obligatory (default) or optonal. E.g. taxes are usually not optonal, fees for some extras are.

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@Name

String (100)

O Additonal note (presentatonal only), do not put important details about fee calculaton here.

Push_PutProperty_RQ/Property/AdditonalFees/AdditonalFee@Order

Integer Additonal fee orderThe order is important in case when the fees/taxes are cumulatve.

Push_PutProperty_RQ/Property/LicenceInfo C, O, X Informaton about various legislaton issues, registraton and tourist licence; might be required for some locatons & sales channels

Push_PutProperty_RQ/Property/LicenceInfo/LicenceNumber

string(50) O Licence number issued by appropriate local authorites

Push_PutProperty_RQ/Property/LicenceInfo/IssueDate

Date O Date the licence was issued

Push_PutProperty_RQ/Property/LicenceInfo/ExpiratonDate

Date O Date the licence is valid to

Push_PutProperty_RQ/Property/LicenceInfo/IsExempt

bool O Is the property not obliged to have any licence under the local law. Pass “true” to let us know you did not skipLicenceNumber feld, but you really donnt have it.

Push_PutProperty_RQ/Property/LicenceInfo/ExemptonReason

string O Reason the property does not need the license. Use if itns any of the reasons below:AustraliaTasmaniaHomeSharing,AustraliaTasmaniaLandUse,

RENTALSUNITED


AustraliaTasmaniaTraditonalHospitality,CanadaVancouverLicensedHotelOrBb ,CanadaVancouverEventSpace,CanadaVancouverLocatonExempt,JapanHotelsAndInnsAct,JapanEconomicZoningAct,JapanEvent inpakuStay,PortugalListngIsNotAFullBuilding,PortugalListngHasARegisteredUrbanLeaseContract,SpainAndalusiaListngTypeNotIncluded,SpainAndalusiaNotATouristAccomodaton,SpainCataloniaListngNotFullBuilding,SpainCataloniaListngIsSharedRoom,SpainCataloniaOtherExemptonReason,USABostonHotel otel,USABostonBedBreakfastLodging,USABostonInsttutonalBusiness,USABostonHospitals,USASanta onicaLicensedHotelOrBb

Push_PutProperty_RQ/Property/LicenceInfo/IsVATRegistered

bool O Is the rental registered for Value Added Tax. For now needed for French propertes pushed to booking.com.

Push_PutProperty_RQ/Property/LicenceInfo/Is anagedByPrivatePerson

bool O Is the rental managed by a private person or a company. For now needed for French propertes pushed to booking.com.

Push_PutProperty_RQ/Property/LicenceInfo/Is anagedByOwner

bool O Is the rental managed by its owner – informaton required by Catalonian and Portugese law

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo

C, O

Data required because of the new law in France efectve from January

RENTALSUNITED


2019. Skip it for propertes located outside France.

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo/IsRegisteredAtTradeCommercialRegister

bool O Is registered as a professional at the trade commercial register (Registre du Commerce et des Sociétés)

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo/DeclaresRevenuesAsProfessionalForDirectTaxPurposes

bool O Does the owner declare revenues as professional fordirect tax purposes (see artcle 155 IV du CGI)

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo/TypeOfResidence

int O Type of residence accordingto the French law. Possible values: 1-31 – Primary2 – Secondary3 - Other

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo/PropertyTypeForTaxPurposes

string O Type of property in terms ofFrench law to determine proper City Tax Category. Needed in some regions of France.

Possible values:FurnishedTourism, TouristHotel, OutdoorAccommodatons,HolidayVillage, TouristResidence,Bnb, CarsiteParkingLot, arinas, Palaces

Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo/CityTaxCategory

int O Obsolete – lef only for backwards compatbility. Use the combinaton ofNumberOfStars and LicenceInfo/FrenchLicenceInfo/PropertyTypeForTaxPurposes instead

You only need to specify it ifall three out of DeclaresRevenuesAsProfessionalForDirectTaxPurposes, IsRegisteredAtTradeCommercialRegister and IsVATRegistered are “false”. Possible values: 11-1911 - palaces12 - 5 star tourist hotels, 5 star tourist residences, 5

RENTALSUNITED


star furnished tourism13 - 4 star tourist hotels, 4 star tourist residences, 4 star furnished tourist accommodaton14 - 3 star tourist hotels, 3 star tourist residences, 3 star furnished tourist accommodaton15 - 2-star tourist hotels, 2-star tourist residences, 2-star furnished holiday homes, 4 and 5-star holiday villages16 - 1-star tourist hotels, 1-star tourist residences, 1-star furnished holiday homes, 1,2 and 3-star holiday villages, bed and breakfasts, RV parks and tourist parking lots for each 24 hours17 - Campgrounds and caravan parks classifed in 3,4 and 5 stars18 - Campsites and caravan parks classifed in 1 and 2 stars, marinas19 - Accommodatons awaitng classifcaton or without classifcaton

Push_PutProperty_RQ/Property/LicenceInfo/BrazilianLicenceInfo

C, O The registraton data required by Brazilian authorites

Push_PutProperty_RQ/Property/LicenceInfo/BrazilianLicenceInfo/CityHallInfoId

String O The 8-digit ID for the city hall which issued the CNPJ or CPF number.

Push_PutProperty_RQ/Property/LicenceInfo/JapaneseLicenceInfo

C, O Licencing data required by Japanese law. Please contact us for details

Push_PutProperty_RQ/Property/PreparatonTimeBeforeArrival

Integer O Sets Preparaton Time Before Arrival in number of days for a property. Send 0 to remove it. aximum value is 42 days.

Push_PutProperty_RQ/Property/NumberOfStars

Integer O Star ratng of the property (1-5)

Please oite: you cannot use both Push_PutProperty_RQ/Property/CompositonRooms and Push_PutProperty_RQ/Property/CompositonRoomsAmenites elements. Use

RENTALSUNITED


Push_PutProperty_RQ/Property/CompositonRoomsAmenites when you are able to assign amenites to a specifc room. In this case defne general amenites (e.g. parking, wireless internet connecton) using the Push_PutProperty_RQ/Property/Amenites element.If you are not able to defne such precise data, please defne rooms in the Push_PutProperty_RQ/Property/CompositonRooms element and all the amenites in the Push_PutProperty_RQ/Property/Amenites element.

Additioal fees oites:Additonal fees represent diferent kinds of additonal fees which can be applied to the rental price.This do not concern explicitly specifed fees on the property, for example cleaning fees, security deposit, extra guest price etc.Additonal fees are applied onto the fnal price (for example, afer adding the cleaning fee). Each fee is applied according to it's order: fees with small order number are applied frst. Eeach fee is applied on the result from the previous fee calculaton, unless otherwise specifed.Additonal fee item consists of: Order, KindID, DiscriminatorID and Value. Use list methods to get possible KindIDs and DiscriminatorIDs

Example 1:Taking input price: 33.12, reservaton for 2 days and following fees collecton:<AdditionalFees> <AdditionalFee KindID="1" DiscriminatorID="1" Order="0"> <Value>10</Value> </AdditionalFee> <AdditionalFee KindID="1" DiscriminatorID="3" Order="1"> <Value>0.1</Value> </AdditionalFee> <AdditionalFee KindID="1" DiscriminatorID="4" Order="2"> <Value>0.15</Value> </AdditionalFee> <AdditionalFee KindID="1" DiscriminatorID="2" Order="5"> <Value>2</Value> </AdditionalFee> <AdditionalFee KindID="1" DiscriminatorID="3" Order="66"> <Value>0.23</Value> </AdditionalFee></AdditionalFees>

The calculatons is as follows:1. DiscriminatorID=”1” is a “FlatPerStay” fee, therefore to 33.12 we add 10. Current price: 43.12.2. DiscriminatorID=”3” is a “IndependentPercentage” fee, therefore the current price doesn't change (stays 43.12), but at the end we have to remember to add 4.31 for the taxes fees.3. DiscriminatorID="4" is a “CumulatvePercentage” fee, therefore to 43.12 we add (43.12*0.15)=6.47. Current price: 43.12 +6.47 = 49.59.4. DiscriminatorID="2" is a “FixedPerDay” fee, therefore to the current price we add 2 (the length of the reservaton)*2 (the value of the fee)=4. Current price: 53.59.5. DiscriminatorID=”3” is a “IndependentPercentage” fee, therefore the current price doesn't change (stays 53.59), but at the end we have to remember to add 53.59*0.23=12.33 for the taxes fees.End of calculatons. The fnal price is: 53.59 (the price from the last step) + 4.31 + 12.33 (the independent fees) = 70.23. All of the fees were taxes, so taxes added in this example = 37.11.Please note: order values doesn't have to be contnuous.

Example 2:Taking input price: 100, reservaton for 2 days and following fees collecton:<AdditionalFees>

<AdditionalFee KindID="1" DiscriminatorID="1"

RENTALSUNITED

http://www.RentalsUnited.com Order="2"><Value>10</Value></AdditionalFee>

<AdditionalFee KindID="1" DiscriminatorID="3"Order="1"><Value>0.1</Value></AdditionalFee>


<AdditionalFee KindID="1" DiscriminatorID="2"Order="5"><Value>2</Value></AdditionalFee>


</AdditionalFees>

The calculatons is as follows:1. DiscriminatorID= 4 (note the order value) is a “CumulatvePercentage” fee, therefore to 100 we add (0.15*100). Current price: 115.2. DiscriminatorID=”3” is a “IndependentPercentage” fee, therefore the current price doesn't change (stays 115), but at the end we have to remember to add 115*0.1=11.5 for the taxes fees.3. DiscriminatorID=”1” is a “FlatPerStay” fee, therefore to 115 we add 10. Current price: 125.4. DiscriminatorID="2" is a “FixedPerDay” fee, therefore to the current price we add 2 (the length of the reservaton)*2 (the value of the fee)=4. Current price: 129.5. DiscriminatorID=”3” is a “IndependentPercentage” fee, therefore the current price doesn't change (stays 129), but at the end we have to remember to add 129*0.23=29.67 for the taxes fees.End of calculatons. The fnal price is: 129 (the price from the last step) + 11.5 + 29.67 (the independent fees) = 170.17. All of the fees were taxes, so taxes added in this example = 70.17.

3.1.3.2.1. Example (put a new property, without detailed amenities data)<Push_PutProperty_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Property> <PUID BuildingID="1">1</PUID> <Name>Apartment 1</Name> <OwnerID>1</OwnerID> <DetailedLocatonID TypeID="4">1</DetailedLocatonID> <IsActve>true</IsActve> <IsArchived>false</IsArchived> <CleaningPrice>10.00</CleaningPrice> <Space>45</Space> <StandardGuests>3</StandardGuests> <CanSleep ax>5</CanSleep ax> <PropertyTypeID>1</PropertyTypeID> <Floor>1</Floor> <Street>Street 1</Street> <ZipCode>00-001</ZipCode> <Coordinates> <Longitude>40.21334234</Longitude> <Lattude>42.123123</Lattude> </Coordinates> <Distances> <Distance> <DestnatonID>1</DestnatonID> <DistanceUnitID>1</DistanceUnitID> <DistanceValue>10</DistanceValue> </Distance> </Distances> <CompositonRooms> <CompositonRoomID Count="1">1</CompositonRoomID> <CompositonRoomID Count="1">2</CompositonRoomID> </CompositonRooms>

RENTALSUNITED


<Amenites> <Amenity Count="2">1</Amenity> <Amenity>2</Amenity> </Amenites> <Images> <Image ImageTypeID="1">htp://www.domain.com/1.jpg</Image> </Images> <ArrivalInstructons> <Landlord>John Smith</Landlord> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <DaysBeforeArrival>2</DaysBeforeArrival> <HowToArrive> <Text LanguageID="1">Informaton about how to arrive in English</Text> <Text LanguageID="2">Informaton about how to arrive in German</Text> </HowToArrive> <PickupService> <Text LanguageID="1">Informaton about pickup service in English</Text> </PickupService> </ArrivalInstructons> <CheckInOut> <CheckInFrom>10:00</CheckInFrom> <CheckInTo>13:00</CheckInTo> <CheckOutUntl>09:00</CheckOutUntl> <Place>apartment</Place> <LateArrivalFees> <LateArrivalFee From="13:00" To="20:00">10.00</LateArrivalFee> <LateArrivalFee From="20:00" To="01:00">30.00</LateArrivalFee> </LateArrivalFees> <EarlyDepartureFees> <EarlyDepartureFee From="03:00" To="05:00">30.00</EarlyDepartureFee> <EarlyDepartureFee From="05:00" To="13:00">25.00</EarlyDepartureFee> </EarlyDepartureFees> </CheckInOut> <Payment ethods> <Payment ethod Payment ethodID="1">Account number: 000000000000000</Payment ethod> <Payment ethod Payment ethodID="2" >Visa/ asterCard</Payment ethod> </Payment ethods> <Deposit DepositTypeID="3">15.00</Deposit> <CancellatonPolicies> <CancellatonPolicy ValidFrom="0" ValidTo="3">100</CancellatonPolicy> <CancellatonPolicy ValidFrom="4" ValidTo="10">50</CancellatonPolicy> </CancellatonPolicies> <Descriptons> <Descripton LanguageID="1"> <Text>Descripton in English.</Text> </Descripton> <Descripton LanguageID="2"> <Image>htp://YourServer/GermanDescripton.jpg</Image> </Descripton> <Descripton LanguageID="3"> <Text>Descripton in Polish</Text> <Image>htp://YourServer/PolishDescripton.jpg</Image> </Descripton> </Descriptons> <SecurityDeposit DepositTypeID="5">85.00</SecurityDeposit> <AdditonalFees> <AdditonalFee KindID="1" DiscriminatorID="1" Order="0"> <Value>50.05</Value> </AdditonalFee> <AdditonalFee KindID="1" DiscriminatorID="4" Order="1">

RENTALSUNITED


<Value>0.1255</Value>  </AdditonalFee> </AdditonalFees> <LicenceInfo> <LicenceNumber>Licence_Number</LicenceNumber> </LicenceInfo> </Property></Push_PutProperty_RQ>

3.1.3.2.2. Example (update a previously uploaded property, with detailed amenity data)<Push_PutProperty_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Property> <ID>1</ID> <PUID BuildingID="1">apt1</PUID> <Name>Apartment 1</Name> <OwnerID>1</OwnerID> <DetailedLocatonID TypeID="1">1</DetailedLocatonID> <IsActve>true</IsActve> <CleaningPrice>10.00</CleaningPrice> <Space>45</Space> <StandardGuests>3</StandardGuests> <CanSleep ax>5</CanSleep ax> <PropertyTypeID>1</PropertyTypeID> <Floor>1</Floor> <Street>Street 1</Street> <ZipCode>00-001</ZipCode> <Coordinates> <Longitude>40.21334234</Longitude> <Lattude>42.123123</Lattude> </Coordinates> <Distances> <Distance> <DestnatonID>1</DestnatonID> <DistanceUnitID>1</DistanceUnitID> <DistanceValue>10</DistanceValue> </Distance> </Distances> <CompositonRoomsAmenites> <CompositonRoomAmenites CompositonRoomID="1"> <Amenites> <Amenity Count="1">1</Amenity> </Amenites> </CompositonRoomAmenites> <CompositonRoomAmenites CompositonRoomID="2"> <Amenites> <Amenity Count="1">1</Amenity> </Amenites> </CompositonRoomAmenites> </CompositonRoomsAmenites> <Amenites> <Amenity>2</Amenity> </Amenites> <Images> <Image ImageTypeID="1">htp://www.domain.com/1.jpg</Image> </Images> <ArrivalInstructons>

RENTALSUNITED


<Landlord>John Smith</Landlord> <Email>[email protected]</Email> <Phone>+48 22 000 00 00</Phone> <DaysBeforeArrival>2</DaysBeforeArrival> <HowToArrive> <Text LanguageID="1">Informaton about how to arrive in English</Text> <Text LanguageID="2">Informaton about how to arrive in German</Text> </HowToArrive> <PickupService> <Text LanguageID="1">Informaton about pickup service in English</Text> </PickupService> </ArrivalInstructons> <CheckInOut> <CheckInFrom>10:00</CheckInFrom> <CheckInTo>13:00</CheckInTo> <CheckOutUntl>09:00</CheckOutUntl> <Place>apartment</Place> <LateArrivalFees> <LateArrivalee From="13:00" To="20:00">10.00</LateArrivalee> <LateArrivalee From="20:00" To="01:00">30.00</LateArrivalee> </LateArrivalFees> </CheckInOut> <Payment ethods> <Payment ethod Payment ethodID="1">Account number: 000000000000000</Payment ethod> <Payment ethod Payment ethodID="2" >Visa/ asterCard</Payment ethod> </Payment ethods> <Deposit DepositTypeID="3">15.00</Deposit> <CancellatonPolicies> <CancellatonPolicy ValidFrom="0" ValidTo="3">100</CancellatonPolicy> <CancellatonPolicy ValidFrom="4" ValidTo="10">50</CancellatonPolicy> </CancellatonPolicies> <Descriptons> <Descripton LanguageID="1"> <Text>Descripton in English.</Text> </Descripton> <Descripton LanguageID="2"> <Image>htp://YourServer/GermanDescripton.jpg</Image> </Descripton> <Descripton LanguageID="3"> <Text>Descripton in Polish</Text> <Image>htp://YourServer/PolishDescripton.jpg</Image> </Descripton> </Descriptons> <SecurityDeposit DepositTypeID="5">85.00</SecurityDeposit> <AdditonalFees> <AdditonalFee KindID="1" DiscriminatorID="1" Order="0"> <Value>50.05</Value> </AdditonalFee> <AdditonalFee KindID="1" DiscriminatorID="4" Order="1"> <Value>0.1255</Value>  </AdditonalFee> </AdditonalFees> <LicenceInfo> <LicenceNumber>Licence_Number</LicenceNumber> </LicenceInfo> </Property></Push_PutProperty_RQ>

RENTALSUNITED


3.1.3.3. ResponseXML Path Data Type Type DescriptioPush_PutProperty_RS C Root elementPush_PutProperty_RS/Status String(100

) See ListStatuses

Push_PutProperty_RS/Status@ID Integer See ListStatusesPush_PutProperty_RS/ID Integer O Property's unique ID

3.1.3.3.1. Example (completed successfully)<Push_PutProperty_RS> <Status ID="1">Success</Status> <ResponseID ID="1">Success</ResponseID> <ID>1</ID> <ResponseId>1</ResponseId></Push_PutProperty_RS>

3.1.3.3.2. Example (error occurred)<Push_PutProperty_RS> <Status ID="4">Wrong authentcaton data</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID></Push_PutProperty_RS>

3.1.4. Set properties status

3.1.4.1. UsageThis method allows you to manipulate the statuses of multple propertes owned by you in the RU system.

3.1.4.2. RequestXML Path Data Type Type DescriptioPush_SetPropertesStatus_RQ C Root elementPush_SetPropertesStatus_RQ/Authentcaton C, Authentcaton detailsPush_SetPropertesStatus_RQ/Authentcaton/UserName


Push_SetPropertesStatus_RQ/Authentcaton/Password


Push_SetPropertesStatus_RQ/IsActve Boolean Actvate (True/1) or deactvate (False/0) propertes for the specifed IDs

Push_SetPropertesStatus_RQ/IsArchived Boolean Archive (True/1) or restore (False/0) propertes for the specifed IDs

Push_SetPropertesStatus_RQ/PropertyIDs C, A collecton of property IDsPush_SetPropertesStatus_RQ/PropertyIDs/PropertyID

Integer Single property ID

3.1.4.2.1. Example<Push_SetPropertesStatus_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password>

RENTALSUNITED


</Authentcaton> <IsActve>0</IsActve> <IsArchived>0</IsArchived> <PropertyIDs> <PropertyID>1</PropertyID> <PropertyID>4</PropertyID> <PropertyID>13</PropertyID> </PropertyIDs></Push_SetPropertesStatus_RQ>

3.1.4.3. ResponseXML Path Data Type Type DescriptioPush_SetPropertesStatus_RS C Root elementPush_SetPropertesStatus_RS/Status String(100

) See ListStatuses

Push_SetPropertesStatus_RS/Status@ID Integer See ListStatusesPush_SetPropertesStatus_RS/Warnings C, O Collecton of warnings.

Warnings do not block the whole process

Push_SetPropertesStatus_RS/Warnings/Warning

String(100)

Warning for the specifc property from the specifed IDs.

Push_SetPropertesStatus_RS/Warnings/Warning@StatusID

Integer ID of the status message. See ListStatuses for details.

Push_SetPropertesStatus_RS/Warnings/Warning@ID

Integer Property's ID

3.1.4.3.1. Example (completed successfully)<Push_SetPropertesStatus_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_SetPropertesStatus_RS>

3.1.4.3.2. Example (error occurred)<Push_SetPropertesStatus_RS> <Status ID="17">Unexpected error, contact IT or try again</Status></Push_SetPropertesStatus_RS>

3.1.4.3.3. Example (warnings occurred)<Push_SetPropertesStatus_RS> <ResponseID ID="1">Success</ResponseID> <Status ID="0">Success</Status> <Warnings> <Warning StatusID="18" ID="1">Property with the specifed ID does not exist.</Warning> <Warning StatusID="18" ID="4">Property with the specifed ID does not exist.</Warning> </Warnings></Push_SetPropertesStatus_RS>

3.1.5. Put property external listing

3.1.5.1. UsageThis method inserts detailed informaton about a property external listng. When you download a property to your system, you should invoke this method to inform RentalsUnited about a synchronizaton process.

RENTALSUNITED


3.1.5.2. RequestXML Path Data Type Type DescriptioPush_PutPropertyExternalListng_RQ C Root elementPush_PutPropertyExternalListng_RQ/Authentcaton


Push_PutPropertyExternalListng_RQ/Authentcaton/UserName


Push_PutPropertyExternalListng_RQ/Authentcaton/Password


Push_PutPropertyExternalListng_RQ/Propertes


Push_PutPropertyExternalListng_RQ/Propertes/Property

C Single property

Push_PutPropertyExternalListng_RQ/Propertes/Property@ID


Push_PutPropertyExternalListng_RQ/Propertes/Property/Url

String(300)

Url to external service

Push_PutPropertyExternalListng_RQ/Propertes/Property/Status

Integer ID of the status to be set (see ListPropExtStatuses).Passing "Requested publishing" or "Requested removal" statuses is not allowed here

Push_PutPropertyExternalListng_RQ/Propertes/Property/Descripton

String(500)

Additonal informaton for the owner, e.g. “property is online, but the property plan is missing, we need this”, “property is not online, amenites are missing”

3.1.5.2.1. Example<Push_PutPropertyExternalListng_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Propertes> <Property ID="0"> <Url>htp://someAgency.com/apartment0</Url> <Status>1</Status> <Descripton>Online but the property plan will be nice</Descripton> </Property> <Property ID="1"> <Url>htp://someAgency.com/apartment1</Url> <Status>1</Status> <Descripton>everything ok</Descripton> </Property> </Propertes></Push_PutPropertyExternalListng_RQ>

RENTALSUNITED


Push_PutPropertyExternalListng_RS C Root elementPush_PutPropertyExternalListng_RS/Status String(100

) See ListStatuses

Push_PutPropertyExternalListng_RS/Status@ID


3.1.5.3.1. Example<Push_PutPropertyExternalListng_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_PutPropertyExternalListng_RS>

3.1.6. Put property review

3.1.6.1. UsageThis method allows to insert user made reviews for apartment. Only Apartment owners can insert reviews. Only one review can be uploaded per request.

3.1.6.2. Request

XML Path Data Type Type DescriptioPush_PutPropertyReviews_RQ C Root elementPush_PutPropertyReviews_RQ/Authentcaton


Push_PutPropertyReviews_RQ/Authentcaton/UserName

String (50) Provided by RU

Push_PutPropertyReviews_RQ/Authentcaton/Password

String (50) Provided by RU

Push_PutPropertyReviews_RQ/Reviews C Collecton of reviewsPush_PutPropertyReviews_RQ/Reviews@PropertyID

Integer The code that uniquely identfes a property in RU system.

Push_PutPropertyReviews_RQ/Reviews/Review

Informaton about review

Push_PutPropertyReviews_RQ/Reviews/Review/FirstName

String(100)

First name of the user that made review

Push_PutPropertyReviews_RQ/Reviews/Review/LastName

String(100)

Last name of the user that made review

Push_PutPropertyReviews_RQ/Reviews/Review/DisplayName

String(100)

Display name of the user that made review

Push_PutPropertyReviews_RQ/Reviews/Review/Email

String(100)

Email of the use who created the review

Push_PutPropertyReviews_RQ/Reviews/Review/Ratng

Integer Ratng value for the review. Values may range between 0 and 5

Push_PutPropertyReviews_RQ/Reviews/Review/ArrivalDate

String(10) Date on which user arrived (YYYY- -DD format)

Push_PutPropertyReviews_RQ/Reviews/Review/Submited

String(10) Date on which the review was created. ust be laster than ArrivalDate (YYYY- -DD format)

RENTALSUNITED


Push_PutPropertyReviews_RQ/Reviews/Review/Texts

C, Collecton of translated texts

Push_PutPropertyReviews_RQ/Reviews/Review/Texts/Text

String Review text

Push_PutPropertyReviews_RQ/Reviews/Review/Texts/Text@LanguageID

Integer Code that identfy the language of descriptonPull_ListLanguages

3.1.6.2.1. Example

<Push_PutPropertyReviews_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Reviews PropertyID="123"> <Review> <FirstName>John</FirstName> <LastName>Smith</LastName> <DisplayName>John S</DisplayName> <Email>[email protected]</Email> <Ratng>5</Ratng> <ArrivalDate>2015-04-02</ArrivalDate> <Submited>2015-05-01</Submited> <Texts> <Text LanguageID="1">Very nice fat</Text> <Text LanguageID="3">Bardzo ładne mieszkanie</Text> </Texts> </Review> </Reviews></Push_PutPropertyReviews_RQ>

3.1.6.3. Response

XML Path Data Type Type DescriptioPush_PutPropertyReviews_RS C Root elementPush_PutPropertyReviews_RS/Status String


Push_PutPropertyReviews_RS/Status@ID Integer See ListStatusesPush_PutPropertyReviews_RS/ReviewID Integer Unique identfer of the

review

3.1.6.3.1. Example<Push_PutPropertyReviews_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ReviewID>123</ReviewID></Push_PutPropertyReviews_RS>

3.1.7. Push standard number of guests

3.1.7.1. UsageThis method allows to update standard guests only. Apartments owners and R S systems can update number of standard guests.

RENTALSUNITED


3.1.7.2. RequestXML Path Data Type Type DescriptioPush_StandardNumberOfGuests_RQ Integer C Root elementPush_StandardNumberOfGuests_RQ/Authentcaton


Push_StandardNumberOfGuests_RQ/Authentcaton/UserName


Push_StandardNumberOfGuests_RQ/Authentcaton/Password


Push_StandardNumberOfGuests_RQ/Property

C Single property

Push_StandardNumberOfGuests_RQ/Property/ID

Integer O Property's unique ID, use this element if you want to update an already uploadedproperty

Push_StandardNumberOfGuests_RQ/Property/StandardGuests

Integer , X Number of guest included in the base price

3.1.7.2.1. Example<Push_StandardNumberOfGuests_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Property> <ID>1</ID> <StandardGuests>2</StandardGuests> <Property> </Property></Push_StandardNumberOfGuests_RQ>

3.1.7.3. ResponseXML Path Data

TypeType Descriptio

Push_StandardNumberOfGuests_RS C Root elementPush_StandardNumberOfGuests_RS/Status String(1

00) See ListStatuses

Push_StandardNumberOfGuests_RS/Status@ID Integer See ListStatuses

3.1.7.3.1. Example (completed successfully)<Push_StandardNumberOfGuests_RS> <Status ID="0">Success</Status> <ResponseId>85f7f6d1c13348b7a426600c17cfaf3</ResponseId></Push_StandardNumberOfGuests_RS>

3.1.7.3.2. Example (error occurred)<Push_PutProperty_RS> <Status ID="97">Standard number of guests must be a positve value</Status> <ResponseID>0123456789ABCDEF0123456789ABCDEF</ResponseID></Push_PutProperty_RS>

RENTALSUNITED


3.2. Availability and prices

3.2.1. Upload availability

3.2.1.1. UsageThis method allows you to keep the property's availability calendar up-to-date. Each tme you use this method, the system overwrites only the specifed period. Thanks to that you can upload only afew days and leave the other days unmodifed. Ranges provided for an availability upload have to be separable. This method also allows you to upload minimum the stay restricton policy (see Put min stay method to fnd out how this works).

3.2.1.2. RequestXML Path Data Type Type DescriptioPush_PutAvb_RQ C Root elementPush_PutAvb_RQ/Authentcaton C, Authentcaton detailsPush_PutAvb_RQ/Authentcaton/UserName String(50) Provided by RUPush_PutAvb_RQ/Authentcaton/Password String(50) Provided by RUPush_PutAvb_RQ/Calendar C, Informaton about the

property's availability calendar

Push_PutAvb_RQ/Calendar@PropertyID Integer Property's unique ID

Push_PutAvb_RQ/Calendar/Availability Boolean Specifes whether the property is available for booking in the specifed dates

Push_PutAvb_RQ/Calendar/Availability@DateFrom

String(10) Start of the range when the availability informaton is valid(YYYY- -DD format)

Push_PutAvb_RQ/Calendar/Availability@DateTo

String(10) End of the range when the availability informaton is valid(YYYY- -DD format)

3.2.1.2.1. Example<Push_PutAvb_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Calendar PropertyID="1"> <Availability DateFrom="2012-03-01" DateTo="2012-03-04">true</Availability> <Availability DateFrom="2012-04-05" DateTo="2012-03-02">false</Availability> <Availability DateFrom="2012-04-03" DateTo="2012-09-08">true</Availability> <Availability DateFrom="2012-09-09" DateTo="2013-03-02">false</Availability> </Calendar></Push_PutAvb_RQ>

RENTALSUNITED


Push_PutAvb_RS C Root elementPush_PutAvb_RS/Status String(100

) (100) See ListStatuses

Push_PutAvb_RS/Status@ID Integer See ListStatusesPush_PutAvb_RS/Notfs C,O A collecton of informaton

with uploading process errors. Successfully updatedranges are not included in this collecton

Push_PutAvb_RS/Notf Integer C, Detailed informaton about the erronous ranges

Push_PutAvb_RS/Notf@StatusID Integer See ListStatuses

Push_PutAvb_RS/Notf@DateFrom String(10) Start of a single erronous range (YYYY- -DD format)

Push_PutAvb_RS/Notf@DateTo String(10) End of a single erronous range (YYYY- -DD format)

3.2.1.3.1. Example<Push_PutAvb_RS> <Status ID="5">An error occurred for some of the ranges</Status> <ResponseID ID="1">Success</ResponseID> <Notfs> <Notf StatusID="5" DateFrom="2012-03-01" DateTo="2012-03-04">Internal error, please try again</Notf> <Notf StatusID="6" DateFrom="2012-04-05" DateTo="2012-03-02">Dates mishmash</Notf> </Notfs></Push_PutAvb_RS>

3.2.2. Put min stay

3.2.2.1. UsageThis method inserts minimum stay restrictons ( S – a minimum amount of nights) for the specifed dates and property. This means that any stay between those dates has to be at least as long as the S policy states. inimum stay restrictons which are already uploaded to the RU system for the specifed dates will be overwriten by the new values (if the dates overlap). S parameter value must always be greater than 0. When you want to remove a restricton, upload S=1 for the range of dates you want to unrestrict.

Each element is processed independently. If you receive an error message, you only need to correct the erroneous elements, the other elements (without errors) will be added.

3.2.2.2. RequestXML Path Data Type Type DescriptioPush_Put instay_RQ C Root elementPush_Put instay_RQ/Authentcaton C, Authentcaton detailsPush_Put instay_RQ/Authentcaton/UserName


Push_Put instay_RQ/Authentcaton/Passwo String(50) Provided by RU

RENTALSUNITED


rdPush_Put instay_RQ/Property inStay C Informaton about the

property's minimum stay restrictons

Push_Put instay_RQ/Property inStay@PropertyID


Push_Put instay_RQ/Property inStay/ inStay

Integer inimum stay restricton, any stay between DateFromand DateTo has to be at least as long as the S policy states

Push_Put instay_RQ/ instays/ inStay@DateFrom

String(10) Start of the range when a S value is valid(YYYY- -DD format)

Push_Put instay_RQ/ instays/ inStay@DateTo

String(10) End of the range when a Svalue is exclusively valid(YYYY- -DD format)

3.2.2.2.1. Example<Push_Put instay_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Property inStay PropertyID="1"> < inStay DateFrom="2012-03-01" DateTo="2012-03-05">4</ inStay> < inStay DateFrom="2012-05-05" DateTo="2012-04-03">3</ inStay> < inStay DateFrom="2012-04-03" DateTo="2012-09-09">2</ inStay> < inStay DateFrom="2012-09-09" DateTo="2013-03-02">1</ inStay> </Property inStay></Push_Put instay_RQ>

3.2.2.3. ResponseXML Path Data Type Type DescriptioPush_Put instay_RS Integer C Root elementPush_Put instay_RS/Status String(100

) See ListStatuses

Push_Put instay_RS/Status@ID Integer See ListStatusesPush_Put instay_RS/Notfs C, O A collecton of informaton


Push_Put instay_RS/Notf Integer C, Detailed informaton about the erronous ranges

Push_Put instay_RS/Notf@StatusID Integer See ListStatuses

Push_Put instay_RS/Notf@DateFrom String(10) Start of a single erronous range (YYYY- -DD format)

Push_Put instay_RS/Notf@DateTo String(10) End of a single erronous

RENTALSUNITED


range (YYYY- -DD format)

3.2.2.3.1. Example<Push_Put instay_RS> <Status ID="5">An error occurred for some of the ranges</Status> <ResponseID ID="1">Success</ResponseID> <Notfs> <Notf StatusID="5" DateFrom="2012-03-01" DateTo="2012-03-04">Internal error, please try again</Notf> <Notf StatusID="6" DateFrom="2012-05-05" DateTo="2012-04-03">Dates mishmash</Notf> </Notfs></Push_Put instay_RS>

3.2.3. Put changeover days

3.2.3.1. UsageThis method inserts changeover restrictons for the specifed dates and property. Each digit of the changeover string represents one day startng from the StartDate. Changeover restrictons that are already uploaded to the RU system for specifed dates will be overwriten by new values if the dates overlap. Changeover string must consist of digits representng changeover types IDs, that is: 1, 2, 3 and 4. When you want to remove restrictons for the specifed dates, you should upload a changeover string consistng of 4's, repeated for each day since StartDate up untl the last day of the range of dates to be overwriten.

3.2.3.2. RequestXML Path Data Type Type DescriptioPush_PutChangeoverDays_RQ C Root elementPush_PutChangeoverDays_RQ/Authentcaton


Push_PutChangeoverDays_RQ/Authentcaton/UserName


Push_PutChangeoverDays_RQ/Authentcaton/Password


Push_PutChangeoverDays_RQ/PropertyID Integer Property's unique ID

Push_PutChangeoverDays_RQ/StartDate String(10) Start of the range (YYYY- -DD format). Please note that there is no end date parameter!

Push_PutChangeoverDays_RQ/Changeover String A string representng changeover policy to be set

3.2.3.2.1. Example<Push_PutChangeoverDays_RQ> <Authentication> <UserName>test</UserName> <Password>test</Password> </Authentication> <PropertyID>1</PropertyID> <StartDate>2014-10-10</StartDate> <Changeover>11122233344</Changeover></Push_PutChangeoverDays_RQ>

RENTALSUNITED


Push_PutChangeoverDays_RS Integer C Root elementPush_PutChangeoverDays_RS/Status String(100

) See ListStatuses

Push_PutChangeoverDays_RS/Status@ID Integer See ListStatuses

3.2.3.3.1. Example<Push_PutChangeoverDays_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_PutChangeoverDays_RS>

3.2.4. Put base price

3.2.4.1. UsageThis method allows you to defne the base/default price for a property. When the property has no seasonal prices (inserted by Push_PutPrices_RQ) the base/default price will be applied. When the seasonal price exists, the base/default price is ignored. The example in “How is the price calculated?” explains how this works.

3.2.4.2. RequestXML Path Data Type Type DescriptioPush_PutPropertyBasePrice_RQ C Root elementPush_PutPropertyBasePrice_RQ/Authentcaton


Push_PutPropertyBasePrice_RQ/Authentcaton/UserName


Push_PutPropertyBasePrice_RQ/Authentcaton/Password


Push_PutPropertyBasePrice_RQ/PropertyBasePrices

C Informaton about the property's base prices

Push_PutPropertyBasePrice_RQ/PropertyBasePrices@PropertyID


Push_PutPropertyBasePrice_RQ/PropertyBasePrices/BasePrice

Base price informaton

Push_PutPropertyBasePrice_RQ/PropertyBasePrices/BasePrice@DayOfWeek

Integer 0 – onday1 – Tuesday2 – Wednesday3 – Thursday4 – Friday5 – Saturday6 – Sunday

Push_PutPropertyBasePrice_RQ/PropertyBasePrices/BasePrice@Price

Decimal O Price for the standard number of guests defned for that property

Push_PutPropertyBasePrice_RQ/PropertyBasePrices/BasePrice@Extra

Decimal O Extra fee for each guest above the standard numberof guests

3.2.4.2.1. Example<Push_PutPropertyBasePrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password>

RENTALSUNITED


</Authentcaton> <PropertyBasePrices PropertyID="1"> <BasePrice DayOfWeek="0" Price="100" Extra="10"/> <BasePrice DayOfWeek="1" Price="100" Extra="10"/> <BasePrice DayOfWeek="2" Price="120" Extra="15"/> <BasePrice DayOfWeek="3" Price="120" Extra="20"/> <BasePrice DayOfWeek="4" Price="120" Extra="20"/> <BasePrice DayOfWeek="5" Price="200" Extra="20"/> <BasePrice DayOfWeek="6" Price="200" Extra="20"/> </PropertyBasePrices></Push_PutPropertyBasePrice_RQ>

3.2.4.3. ResponseXML Path Data Type Type DescriptioPush_PutPropertyBasePrice_RS Integer C Root elementPush_PutPropertyBasePrice_RS/Status String(100

) See ListStatuses

Push_PutPropertyBasePrice_RS/Status@ID Integer See ListStatuses

3.2.4.3.1. Example<Push_PutPropertyBasePrice_RS> <Status ID="64">DayOfWeek atribute must be between 0 and 6.</Status> <ResponseID ID="1">Success</ResponseID></Push_PutPropertyBasePrice_RS>

3.2.5. Put prices

3.2.5.1. UsageThis method allows you to upload the property's price for the specifed dates and number of guests. Each tme you use this method, the system overwrites only the specifed period. Thanks to that you can upload only a few days and leave the other days unmodifed. Ranges provided for an availability upload have to be separable.

3.2.5.2. RequestXML Path Data Type Type DescriptioPush_PutPrices_RQ Integer C Root elementPush_PutPrices_RQ/Authentcaton C, Authentcaton detailsPush_PutPrices_RQ/Authentcaton/UserName


Push_PutPrices_RQ/Authentcaton/Password String(50) Provided by RUPush_PutPrices_RQ/Prices C Informaton about the

property's pricesPush_PutPrices_RQ/Prices@PropertyID Integer Property's unique ID

Push_PutPrices_RQ/Prices/Season C, Informaton about the property price for the specifed dates and numberof guests

Push_PutPrices_RQ/Prices/Season@DateFrom

String(10) Start of the range when a price is valid(YYYY- -DD format)

RENTALSUNITED


Push_PutPrices_RQ/Prices/Season@DateTo String(10) End of the range when a price value is valid(YYYY- -DD format)

Push_PutPrices_RQ/Prices/Season/Price Decimal (19,2)

Price for the standard number of guests defned for that property

Push_PutPrices_RQ/Prices/Season/Extra Decimal (19,2)

O Extra fee for each guest above the standard numberof guests

Push_PutPrices_RQ/Prices/Season/LOSS C,O A collecton of nightly price setngs depending on the length of stay

Push_PutPrices_RQ/Prices/Season/LOSS/LOS C,O Single nightly price

Push_PutPrices_RQ/Prices/Season/LOSS/LOS@Nights

Integer Number of nights for which the price applies

Push_PutPrices_RQ/Prices/Season/LOSS/LOS/Price

Decimal (19,2)

Nightly price value for the specifed length of stay

Push_PutPrices_RQ/Prices/Season/LOSS/LOS/LOSPS

C,O A collecton of nightly price setngs depending on the number of guests

Push_PutPrices_RQ/Prices/Season/LOSS/LOS/LOSPS/LOSP

C, Single nightly price depending on the number of guests

Push_PutPrices_RQ/Prices/Season/LOSS/LOS/LOSPS/LOSP@NrOfGuests


Push_PutPrices_RQ/Prices/Season/LOSS/LOS/LOSPS/LOSP/Price

Decimal (19,2)

Nightly price

Push_PutPrices_RQ/Prices/Season/EGPS C,O A collecton of extra person price setngs depending on the number of extra guests

Push_PutPrices_RQ/Prices/Season/EGPS/EGP C,O Single extra guest price

Push_PutPrices_RQ/Prices/Season/EGPS/EGP@ExtraGuests

Integer Number of extra guests for which the price applies

Push_PutPrices_RQ/Prices/Season/EGPS/EGP/Price

Decimal (19,2)

Single extra guest price value for the specifed number of extra guests

3.2.5.2.1. Example<Push_PutPrices_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Prices PropertyID="1"> <Season DateFrom="2012-03-01" DateTo="2012-03-04"> <Price>100.00</Price> <Extra>10.00</Extra> </Season> <Season DateFrom="2012-04-05" DateTo="2012-03-02"> <Price>120.00</Price> <Extra>10.00</Extra>

RENTALSUNITED


<EGPS> <EGP ExtraGuests="1"> <Price>70.00</Price> </EGP> <EGP ExtraGuests="2"> <Price>72.00</Price> </EGP> </EGPS> </Season> <Season DateFrom="2012-04-03" DateTo="2012-09-08"> <Price>120.00</Price> <Extra>10.00</Extra> <LOSS> <LOS Nights="1"> <Price>700.00</Price> <LOSPS> <LOSP NrOfGuests="5"> <Price>750.00</Price> </LOSP> <LOSP NrOfGuests="6"> <Price>800.00</Price> </LOSP> </LOSPS> </LOS> <LOS Nights="2"> <Price>702.00</Price> </LOS> </LOSS> </Season> <Season DateFrom="2012-09-09" DateTo="2013-03-02"> <Price>190.00</Price> <Extra>20.00</Extra> <LOSS> <LOS Nights="1"> <Price>700.00</Price> </LOS> <LOS Nights="2"> <Price>702.00</Price> </LOS> </LOSS> <EGPS> <EGP ExtraGuests="1"> <Price>70.00</Price> </EGP> <EGP ExtraGuests="2"> <Price>72.00</Price> </EGP> </EGPS> </Season> </Prices></Push_PutPrices_RQ>

3.2.5.3. ResponseXML Path Data Type Type DescriptioPush_PutPrices_RS Integer C Root elementPush_PutPrices_RS/Status String(100

) See ListStatuses

Push_PutPrices_RS/Status@ID Integer See ListStatuses

RENTALSUNITED


Push_PutPrices_RS/Notfs C, O A collecton of informaton with uploading process errors. Successfully updatedranges are not included in this collecton

Push_PutPrices_RS/Notf Integer C, Detailed informaton about the erronous ranges

Push_PutPrices_RS/Notf@StatusID Integer See ListStatuses

Push_PutPrices_RS/Notf@DateFrom String(10) Start of a single erronous range (YYYY- -DD format)

Push_PutPrices_RS/Notf@DateTo String(10) End of a single erronous range (YYYY- -DD format)

3.2.5.3.1. Example<Push_PutPrices_RS> <Status ID="5">An error occurred for some of the ranges</Status> <ResponseID ID="1">Success</ResponseID> <Notfs> <Notf StatusID="5" DateFrom="2012-03-01" DateTo="2012-03-04">Internal error, please try again</Notf> <Notf StatusID="6" DateFrom="2012-04-05" DateTo="2012-03-02">Dates mishmash</Notf> </Notfs></Push_PutPrices_RS>

3.2.6. Put long stay discounts

3.2.6.1. UsageThis method inserts long stay discount informaton into the RU system

3.2.6.2. RequestXML Path Data Type Type DescriptioPush_PutLongStayDiscounts_RQ C Root elementPush_PutLongStayDiscounts_RQ/Authentcaton


Push_PutLongStayDiscounts_RQ/Authentcaton/UserName


Push_PutLongStayDiscounts_RQ/Authentcaton/Password


Push_PutLongStayDiscounts_RQ/LongStays C, A collecton of long stay discounts

Push_PutLongStayDiscounts_RQ/LongStays/LongStay

C, O Long stay discount

Push_PutLongStayDiscounts_RQ/LongStays@PropertyID

Integer C, Property's unique ID

Push_PutLongStayDiscounts_RQ/LongStays/LongStay

Integer Long stay discounts value, percentage of the fnal price

Push_PutLongStayDiscounts_RQ/LongStays/L String(10) Start of the range

RENTALSUNITED


ongStay@DateFrom (YYYY- -DD format)Push_PutLongStayDiscounts_RQ/LongStays/LongStay@DateTo


Push_PutLongStayDiscounts_RQ/LongStays/LongStay@Bigger

Integer inimum length of stay required in order to get the discount

Push_PutDiscounts_RQ/LongStays/LongStay@Smaller

Integer aximum length of stay required in order to get the discount (max value is 180)

3.2.6.2.1. Example<Push_PutLongStayDiscounts_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LongStays PropertyID="1"> <LongStay DateFrom="2012-03-01" DateTo="2012-09-10" Bigger="2" Smaller="20"> 10 </LongStay> <LongStay DateFrom="2012-09-11" DateTo="2012-12-01" Bigger="2" Smaller="20"> 20 </LongStay> <LongStay DateFrom="2012-12-02" DateTo="2012-12-11" Bigger="2" Smaller="20"> 5 </LongStay> </LongStays></Push_PutLongStayDiscounts_RQ>

3.2.6.3. ResponseXML Path Data Type Type DescriptioPush_PutLongStayDiscounts_RS C Root elementPush_PutLongStayDiscounts_RS/Status String(100

) See ListStatuses

Push_PutLongStayDiscounts_RS/Status@ID Integer See ListStatusesPush_PutLongStayDiscounts_RS/Notfs C, O A collecton of informaton


Push_PutLongStayDiscounts_RS/Notf Integer C, Detailed informaton about the erronous ranges

Push_PutLongStayDiscounts_RS/Notf@StatusID


Push_PutLongStayDiscounts_RS/Notf@DateFrom

String(10) Start of a single erronous range (YYYY- -DD format)

Push_PutLongStayDiscounts_RS/Notf@DateTo

String(10) End of a single erronous range (YYYY- -DD format)

3.2.6.3.1. Example<Push_PutLongStayDiscounts_RS>

RENTALSUNITED


<Status ID="5">An error occurred for some of the ranges</Status> <ResponseID ID="1">Success</ResponseID> <Notfs> <Notf StatusID="5" DateFrom="2012-12-02" DateTo="2012-12-11">Internal error, please try again</Notf> </Notfs></Push_PutLongStayDiscounts_RS>

3.2.7. Put last minute discounts

3.2.7.1. UsageThis method inserts last minute discount informaton into the RU system.

3.2.7.2. RequestXML Path Data Type Type DescriptioPush_PutLast inuteDiscounts_RQ C Root elementPush_PutLast inuteDiscounts_RQ/Authentcaton


Push_PutLast inuteDiscounts_RQ/Authentcaton/UserName


Push_PutLast inuteDiscounts_RQ/Authentcaton/Password


Push_PutLast inuteDiscounts_RQ/Last inutes

C, Last minute discounts

Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute

C, O Last minute discount

Push_PutLast inuteDiscounts_RQ/Last inutes@PropertyID


Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute

Integer C Last minute discount, percentage of fnal price

Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DateFrom


Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DateTo


Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DaysToArrivalFrom

Integer inimum number of days away from the arrival date when the discount is valid

Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DaysToArrivalTo

Integer aximum number of days away from the arrival date when the discount is valid

3.2.7.2.1. Example<Push_PutLast inuteDiscounts_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Last inutes PropertyID="1"> <Last inute DateFrom="2012-09-09" DateTo="2012-09-10" DaysToArrivalFrom="2" DaysToArrivalTo="5"> 10 </Last inute> <Last inute DateFrom="2012-09-11" DateTo="2012-12-01" DaysToArrivalFrom="1" DaysToArrivalTo="4">

RENTALSUNITED


20 </Last inute> < Last inute DateFrom="2012-12-02" DateTo="2012-12-11" DaysToArrivalFrom="2" DaysToArrivalTo="3"> 5 </Last inute> </Last inutes></Push_PutLast inuteDiscounts_RQ>

3.2.7.3. ResponseXML Path Data Type Type DescriptioPush_PutLast inuteDiscounts_RS C Root elementPush_PutLast inuteDiscounts_RS/Status String(100

) See ListStatuses

Push_PutLast inuteDiscounts_RS/Status@ID Integer See ListStatusesPush_PutLast inuteDiscounts_RS/Notfs C, O A collecton of informaton


Push_PutLast inuteDiscounts_RS/Notf Integer C, Detailed informaton about the erronous ranges

Push_PutLast inuteDiscounts_RS/Notf@StatusID


Push_PutLast inuteDiscounts_RS/Notf@DateFrom


Push_PutLast inuteDiscounts_RS/Notf@DateTo


3.2.7.3.1. Example<Push_PutLast inuteDiscounts_RS> <Status ID="5">An error occurred for some of the ranges</Status> <ResponseID ID="1">Success</ResponseID> <Notfs> <Notf StatusID="5" DateFrom="2012-12-02" DateTo="2012-12-11">Internal error, please try again</Notf> </Notfs></Push_PutLast inuteDiscounts_RS>

3.2.8. How is the price calculated?

The price consists of diferent elements. However, the price for a night is calculated based on the seasonal price, any extra guests fees and discounts.

[seasonal price] + [(max guests - standard guests)*extra guests fee] - [last minute discount] - [long stay discount] = [price for 1 night]

where [last minute discount] = ([seasonal price] + [(max guests - standard guests)*extra guests fee]) * discount value

where [long stay discount] = ([seasonal price] + [(max guests - standard guests)*extra guests fee]) *discount value

RENTALSUNITED


The below examples will use the scenario to walk you step by step and explain how the price is calculated.

3.2.8.1. Property detailsThe property owner can defne various details for the property which afect the fnal price.

For example:

Standard number of guest – 3

Can sleep max – 5

Cleaning price - 10,00

These details mean that the property price for 1, 2 or 3 guests is the same, but there is an extra feefor the 4th and 5th guest.

3.2.8.2. Property prices<Push_PutPropertyBasePrice_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyBasePrices PropertyID="1"> <BasePrice DayOfWeek="0" Price="100" Extra="10"/> <BasePrice DayOfWeek="1" Price="100" Extra="10"/> <BasePrice DayOfWeek="2" Price="120" Extra="15"/> <BasePrice DayOfWeek="3" Price="120" Extra="20"/> <BasePrice DayOfWeek="4" Price="120" Extra="20"/> <BasePrice DayOfWeek="5" Price="200" Extra="20"/> <BasePrice DayOfWeek="6" Price="200" Extra="20"/> </PropertyBasePrices></Push_PutPropertyBasePrice_RQ>

<Push_PutPrices_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Prices PropertyID="1"> <Season DateFrom="2012-03-01" DateTo="2012-03-04"> <Price>100.00</Price> <Extra>10.00</Extra> <LOSS> <LOS Nights="2"> <Price>90.00</Price> <LOSPS> <LOSP NrOfGuests="5"> <Price>160.00</Price> </LOSP> </LOSPS> </LOS> </LOSS> </Season> <Season DateFrom="2012-03-05" DateTo="2012-04-02"> <Price>120.00</Price> <Extra>10.00</Extra> <EGPS> <EGP ExtraGuests="1"> <Price>20.00</Price>

RENTALSUNITED


</EGP> <EGP ExtraGuests="2"> <Price>20.00</Price> </EGP>

</EGPS> </Season> <Season DateFrom="2012-04-03" DateTo="2012-09-08"> <Price>120.00</Price> <Extra>10.00</Extra> </Season> <Season DateFrom="2012-09-09" DateTo="2013-03-02"> <Price>190.00</Price> <Extra>20.00</Extra> </Season> </Prices></Push_PutPrices_RQ>

3.2.8.3. Property discounts<Push_PutLongStayDiscounts_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <LongStays PropertyID="1"> <LongStay DateFrom="2012-03-01" DateTo="2012-09-10" Bigger="2" Smaller="20"> 10 </LongStay> <LongStay DateFrom="2012-09-11" DateTo="2012-12-01" Bigger="2" Smaller="20"> 20 </LongStay> <LongStay DateFrom="2012-12-02" DateTo="2012-12-11" Bigger="2" Smaller="20"> 5 </LongStay> <LongStay DateFrom="2014-01-02" DateTo="2014-12-11" Bigger="2" Smaller="20"> 10 </LongStay> </LongStays></Push_PutLongStayDiscounts_RQ>

<Push_PutLast inuteDiscounts_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Last inutes PropertyID="1"> <Last inute DateFrom="2012-09-09" DateTo="2012-09-10" DaysToArrivalFrom="1" DaysToArrivalTo="5"> 10 </Last inute> <Last inute DateFrom="2012-09-11" DateTo="2012-12-01" DaysToArrivalFrom="1" DaysToArrivalTo="4"> 20 </Last inute> < Last inute DateFrom="2012-12-02" DateTo="2012-12-11" DaysToArrivalFrom="2" DaysToArrivalTo="3"> 5 </Last inute> </Last inutes></Push_PutLast inuteDiscounts_RQ>

RENTALSUNITED


3.2.8.4. Example stay 1In this example the current date is 2012-01-01.

Stay details:

arrival – 2012-03-04

departure – 2012-03-06

number of guests: 4

It is a 2 nights stay and the number of guests is above the standard number of guests (3), thus the fee for an extra guest will be applied.

The seasonal price for 2012-03-04 is 90, and the seasonal price for 2012-03-05 is 120.

A long stay discount will be applied.

3.2.8.4.1. Price calculationPrice calculation for each day:2012-03-04 – 90+(4-3)*10 = 100 – there is a LOS element with Nights = 2 (equal to the length of stay), in this case the price from the LOS element (90) will be applied.

2012-03-05 – 120+(4-3)*20= 140 – there is an EGP element with ExtraGuests=1 (equal to the number of extra guests), in this case the extra guest price from the EGP element (20) will be applied.

Seasonal prices total before discounts – 100+140= 240

Discounts:Last minute:

2012-03-04: none

2012-03-05: none

Long stay:

2012-03-04: 10% of 90 = 9

2012-03-05: 10% of 120 = 12

Final calculaton:

Seasonal price – discounts

2012-03-04: 100-0-9 = 91

2012-03-05: 140-0-12 = 128

Final price:

Daily prices + cleaning price

91+128+10 = 229

3.2.8.5. Example stay 2In this example today's date is 2012-09-07.

Stay details:

arrival – 2012-09-08


RENTALSUNITED


number of guests: 5

It is a 3 nights stay and the number of guests is above the standard number of guests (3) and the fee for extra guests will be applied. A last minute element is present and the discount will be applied.

3.2.8.5.1. Price calculationPrice calculation for each day:2012-09-08 – 120+(5-3)*10 = 140

2012-09-09 – 190+(5-3)*20 = 230

2012-09-10 – 190+(5-3)*20 = 230

2012-09-11 – 190+(5-3)*20 = 230

Seasonal prices total before discounts – 140+230+230+230= 830


2012-09-08: none

2012-09-09: 10% of 190 = 19

2012-09-10: 10% of 190 = 19

2012-09-11: 20% of 190 = 38

Long stay:

2012-09-08: 10% of 120 = 12

2012-09-09: 10% of 190 = 19

2012-09-10: 10% of 190 = 19

2012-09-11: 20% of 190 = 28

Final calculation:Seasonal price – discounts

2012-09-08: 140-0-12 = 128

2012-09-09: 230-19-19 = 192

2012-09-10: 230-19-19 = 192

2012-09-11: 230-38-38 = 154

Final price:Daily prices + cleaning price

128+192+192+154+10,00 = 676,00


Stay details:

arrival – 2014-09-08


number of guests: 5

RENTALSUNITED


It is a 3 nights stay and the number of guests is above the standard number of guests (3) and the fee for extra guests will be applied. There is no seasonal price defned for this period, so the normal, base price, will be applied. There is a long stay element and the LOS discount will be applied.

3.2.8.6.1. Price calculationPrice calculation for each day:2014-09-08 – 100+(5-3)*10 = 120

2014-09-09 – 100+(5-3)*10 = 120

2014-09-10 – 120+(5-3)*15 = 150

2014-09-11 – 120+(5-3)*20 = 160

Base prices total before discounts – 120+120+150+160= 550


2014-09-08: none

2014-09-09: none

2014-09-10: none

2014-09-11: none

Long stay:

2014-09-08: 10% of 100 = 10

2014-09-09: 10% of 100 = 10

2014-09-10: 10% of 120 = 12

2014-09-11: 10% of 120 = 12

Final calculation:Base price – discounts

2014-09-08: 120-0-10 = 110

2014-09-09: 120-0-10 = 110

2014-09-10: 150-0-12 = 138

2014-09-11: 160-0-12 = 148

Final price:Daily prices + cleaning price

110+110+138+148+10,00 = 516,00


Stay details:

arrival – 2012-03-04


number of guests: 5

RENTALSUNITED


It is a 2 nights stay and the number of guests is above th standard number of guests (3) and the feefor extra guests will be applied. There is an LOS element for the period. There is also nightly price (LOSP) element defned for bookings for 5 guests.

3.2.8.7.1. Price calculationPrice calculation for each day:2012-03-04 – 160+(5-3)*10 = 180 – there is LOS element with Nights = 2 (equal to the length of stay) and LOSP element with NrOfGuests=5 (equal to the number of guests), in this case the price fromLOS element (90) is ignored and LOSP element price (160) will be applied.

2012-03-05 – 120+(5-3)*20= 160 – there is EGP element with ExtraGuests=2 (equal to the number of extra guests), in this case the extra guest price from EGP element (20) will be applied.

Seasonal price – 180+160= 340


2012-03-04: none

2012-03-05: none

Long stay:

2012-03-04: 10% of 160 = 16

2012-03-05: 10% of 120 = 12

Final calculaton:

Seasonal price – discounts

2012-03-04: 180-0-16 = 164

2012-03-05: 160-0-12 = 148

Final price:

Daily prices + cleaning price

164+148+10 = 322

3.3. Reservations

3.3.1. Put reservation on hold [DEPRECATED]

3.3.1.1. UsageUse this method to temporarily block the property in the specifed dates. If the reservaton is not confrmed within 15 minutes the property will be released automatcally.

DEPRECATED – use Put Reservatons On Hold instead, which allows you to block more than one property in one reservaton.

3.3.1.2. RequestXML Path Data Type Type DescriptioPush_PutPropertyOnHold_RQ C Root elementPush_PutPropertyOnHold_RQ/Authentcaton C, Authentcaton detailsPush_PutPropertyOnHold_RQ/Authentcaton/UserName


RENTALSUNITED


Push_PutPropertyOnHold_RQ/Authentcaton/Password


Push_PutPropertyOnHold_RQ/PropertyID Integer Property's unique IDPush_PutPropertyOnHold_RQ/DateFrom String(10) Arrival date

(YYYY- -DD format)Push_PutPropertyOnHold_RQ/DateTo String(10) Departure date

(YYYY- -DD format)Push_PutPropertyOnHold_RQ/NumberOfGuests


3.3.1.2.1. Example<Push_PutPropertyOnHold_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <PropertyID>1</PropertyID> <DateFrom>2012-03-01</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests></Push_PutPropertyOnHold_RQ>

3.3.1.3. ResponseXML Path Data Type Type DescriptioPush_PutPropertyOnHold_RS C Root elementPush_PutPropertyOnHold_RS/Status String(100

) See ListStatuses

Push_PutPropertyOnHold_RS/Status@ID Integer See ListStatusesPush_PutPropertyOnHold_RS/ReservatonID Integer O Reservaton's unique ID,

this element is not present when an error occurs

3.3.1.3.1. Example (completed successfully)<Push_PutPropertyOnHold_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ReservatonID>123456</ReservatonID></Push_PutPropertyOnHold_RS>

3.3.1.3.2. Example (error occurred)<Push_PutPropertyOnHold_RS> <Status ID="3">Property is not available in the selected dates</Status></Push_PutPropertyOnHold_RS>

3.3.2. Put properties on hold

3.3.2.1. UsageUse this method to temporarily block one or more property in the specifed dates. If the reservaton(s) is (are) not confrmed within 15 minutes the property(ies) will be automatcally released.

RENTALSUNITED


3.3.2.2. RequestXML Path Data Type Type DescriptioPush_PutPropertesOnHold_RQ C Root elementPush_PutPropertesOnHold_RQ/Authentcaton


Push_PutPropertesOnHold_RQ/Authentcaton/UserName


Push_PutPropertesOnHold_RQ/Authentcaton/Password


Push_PutPropertesOnHold_RQ/OnHolds C, A list of stay details to put on hold

Push_PutPropertesOnHold_RQ/OnHolds/OnHold

C, Single stay details

Push_PutPropertesOnHold_RQ/OnHolds/OnHold/PropertyID


Push_PutPropertesOnHold_RQ/OnHolds/OnHold/DateFrom


Push_PutPropertesOnHold_RQ/OnHolds/OnHold/DateTo


Push_PutPropertesOnHold_RQ/NumberOfGuests


3.3.2.2.1. Example<Push_PutPropertesOnHold_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <OnHolds> <OnHold> <PropertyID>1</PropertyID> <DateFrom>2012-03-01</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> </OnHold> <OnHold> <PropertyID>2</PropertyID> <DateFrom>2012-03-01</DateFrom> <DateTo>2012-03-9</DateTo> <NumberOfGuests>3</NumberOfGuests> </OnHold> </OnHolds></Push_PutPropertesOnHold_RQ>

3.3.2.3. ResponseXML Path Data Type Type DescriptioPush_PutPropertesOnHold_RS C Root elementPush_PutPropertesOnHold_RS/Status String(100

) See ListStatuses

Push_PutPropertesOnHold_RS/Status@ID Integer See ListStatusesPush_PutPropertesOnHold_RS/ReservatonID Integer O Reservaton's unique ID,

this element is not present when an error occurs

RENTALSUNITED


3.3.2.3.1. Example (completed successfully)<Push_PutPropertesOnHold_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ReservatonID>123456</ReservatonID></Push_PutPropertesOnHold_RS>

3.3.2.3.2. Example (error occurred)<Push_PutPropertesOnHold_RS> <ResponseID ID="1">Success</ResponseID> <Status ID="3">Property is not available in the selected dates</Status></Push_PutPropertesOnHold_RS>

3.3.3. Put confirmed reservation [DEPRECATED]

3.3.3.1. UsageUse this method to create a confrmed reservaton or to confrm a reservaton that is currently on hold.

DEPRECATED – use Put Confrmed Reservatons instead, which allows you to book more than one property in one reservaton.

3.3.3.2. RequestXML Path Data Type Type DescriptioPush_PutConfrmedReservaton_RQ C Root elementPush_PutConfrmedReservaton_RQ/Authentcaton


Push_PutConfrmedReservaton_RQ/Authentcaton/UserName


Push_PutConfrmedReservaton_RQ/Authentcaton/Password


Push_PutConfrmedReservaton_RQ/ReservatonID

Integer O Reservaton's unique ID, this element is optonal, you should use it if you put the property on hold previously

Push_PutConfrmedReservaton_RQ/StayInfo C, Informaton about the stayPush_PutConfrmedReservaton_RQ/StayInfo/PropertyID


Push_PutConfrmedReservaton_RQ/StayInfo/DateFrom


Push_PutConfrmedReservaton_RQ/StayInfo/DateTo


Push_PutConfrmedReservaton_RQ/StayInfo/NumberOfGuests


Push_PutConfrmedReservaton_RQ/CustomerInfo


Push_PutConfrmedReservaton_RQ/CustomerInfo/Name


Push_PutConfrmedReservaton_RQ/CustomerInfo/SurName

RENTALSUNITED


Push_PutConfrmedReservaton_RQ/CustomerInfo/Email

String(100)


Push_PutConfrmedReservaton_RQ/CustomerInfo/Phone


Push_PutConfrmedReservaton_RQ/CustomerInfo/SkypeID


Push_PutConfrmedReservaton_RQ/CustomerInfo/Address


Push_PutConfrmedReservaton_RQ/CustomerInfo/ZipCode


Push_PutConfrmedReservaton_RQ/CustomerInfo/CountryID


Push_PutConfrmedReservaton_RQ/Costs C, Informaton about the reservaton costs

Push_PutConfrmedReservaton_RQ/Costs/RUPrice

Decimal (19,2)

The price returned by one of the RU methods for the property in the specifed dates

Push_PutConfrmedReservaton_RQ/Costs/ClientPrice

Decimal (19,2)


Push_PutConfrmedReservaton_RQ/Costs/AlreadyPaid

Decimal(19,2)

Amount already paid by thecustomer

3.3.3.2.1. Example (if you put the property on hold previously)<Push_PutConfrmedReservaton_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <ReservatonID>123456</ReservatonID> <StayInfo> <PropertyID>1</PropertyID> <DateFrom>2012-03-01</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> </StayInfo> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> </CustomerInfo> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs></Push_PutConfrmedReservaton_RQ>

3.3.3.2.2. Example (when you did not put the property on hold previously)<Push_PutConfrmedReservaton_RQ>

RENTALSUNITED


<Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <StayInfo> <PropertyID>1</PropertyID> <DateFrom>2012-03-01</DateFrom> <DateTo>2012-03-10</DateTo> <NumberOfGuests>2</NumberOfGuests> </StayInfo> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> </CustomerInfo> <Costs> <RUPrice>100.00</RUPrice> <ClientPrice>110.00</ClientPrice> <AlreadyPaid>10.00</AlreadyPaid> </Costs></Push_PutConfrmedReservaton_RQ>

3.3.3.3. ResponseXML Path Data Type Type DescriptioPush_PutConfrmedReservaton_RS C Root elementPush_PutConfrmedReservaton_RS/Status String(100

) See ListStatuses

Push_PutConfrmedReservaton_RS/Status@ID


Push_PutConfrmedReservaton_RS/ReservatonID

Integer O Reservaton's unique ID, his element is not present when an error occurs

3.3.3.3.1. Example (completed successfully)<Push_PutConfrmedReservaton_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ReservatonID>123456</ReservatonID></Push_PutConfrmedReservaton_RS>

3.3.3.3.2. Example (error occurred)<Push_PutConfrmedReservaton_RS> <Status ID="3">Property is not available in selected dates</Status> <ResponseID ID="1">Success</ResponseID></Push_PutConfrmedReservaton_RS>

3.3.4. Put confirmed reservations

3.3.4.1. UsageUse this method to create a confrmed reservaton or to confrm a previously created on hold

RENTALSUNITED


reservaton. With this method you can book more than one property in a single reservaton.

3.3.4.2. RequestXML Path Data Type Type DescriptioPush_PutConfrmedReservaton ult_RQ C Root elementPush_PutConfrmedReservaton ult_RQ/Authentcaton


Push_PutConfrmedReservaton ult_RQ/Authentcaton/UserName


Push_PutConfrmedReservaton ult_RQ/Authentcaton/Password


Push_PutConfrmedReservaton ult_RQ/Reservaton

Single reservaton

Push_PutConfrmedReservaton ult_RQ/Reservaton/ReservatonID

Integer O Reservaton's unique ID, this element is optonal, you should use it if you put the property on hold previously

Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos

C, A collecton of stay informaton

Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/PropertyID


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/DateFrom


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/DateTo


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/NumberOfGuests

Integer Number of guests staying inthe property

Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/Costs

C, Informaton about the property costs

Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/Costs/RUPrice

Decimal (19,2)


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/Costs/ClientPrice

Decimal (19,2)


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/Costs/AlreadyPaid

Decimal(19,2)


Push_PutConfrmedReservaton ult_RQ/Reservaton/StayInfos/StayInfo/Comments

String(500)

O Additonal comments aboutthis stay

Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo


Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/Name


Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/SurName


Push_PutConfrmedReservaton ult_RQ/Res String(100 Customer's email address

RENTALSUNITED


ervaton/CustomerInfo/Email )Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/Phone

String(30) O Customer's phone number with country code

Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/SkypeID


Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/Address


Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/ZipCode


Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/LanguageID

Integer O Country's unique ID, see ListLanguages

Push_PutConfrmedReservaton ult_RQ/Reservaton/CustomerInfo/CountryID


Push_PutConfrmedReservaton ult_RQ/Reservaton/Comments

String(4000)


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/CCNumber


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/CVC

String(4)


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/NameOnCard

String(400)


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/Expiraton


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/BillingAddress

String(400)

O Billing address

Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/CardType


Push_PutConfrmedReservaton ult_RQ/Reservaton/CreditCard/Comments

String(400)

O Additonal comments for the Credit Card

Push_PutConfrmedReservaton ult_RQ/Quote odeId

Integer O See List quote modes.

3.3.4.2.1. Example (if you put the property on hold previously)<Push_PutConfrmedReservaton ult_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Reservaton>

RENTALSUNITED


<ReservatonID>124</ReservatonID> <StayInfos> <StayInfo> <PropertyID>2</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> <StayInfo> <PropertyID>4</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <LanguageID>1</LanguageID> <CountryID>42</CountryID> </CustomerInfo> <Comments>test</Comments> </Reservaton></Push_PutConfrmedReservaton ult_RQ>

3.3.4.2.2. Example (when you did not put the property oh hold previously)<Push_PutConfrmedReservaton ult_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Reservaton> <StayInfos> <StayInfo> <PropertyID>2</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> <StayInfo> <PropertyID>4</PropertyID>

RENTALSUNITED


<DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <LanguageID>1</LanguageID> <CountryID>42</CountryID> </CustomerInfo> <Comments>test</Comments> </Reservaton></Push_PutConfrmedReservaton ult_RQ>

3.3.4.2.3. Example (when the credit card information is provided)<Push_PutConfrmedReservaton ult_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Reservaton> <StayInfos> <StayInfo> <PropertyID>2</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> <StayInfo> <PropertyID>4</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email>

RENTALSUNITED


<Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <LanguageID>1</LanguageID> <CountryID>42</CountryID> </CustomerInfo> <Comments>test</Comments> <CreditCard> <CCNumber>00000000000</CCNumber> <CVC>321</CVC> <NameOnCard>Test</NameOnCard> <Expiraton>12/2015</Expiraton> <BillingAddress>testaddr</BillingAddress> <CardType>VISA</CardType> <Comments>comments</Comments> </CreditCard> </Reservaton></Push_PutConfrmedReservaton ult_RQ>

3.3.4.2.4. Example (when you did not put the property oh hold previously and want to ignore PMS and RU quote)<Push_PutConfrmedReservaton ult_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <Reservaton> <StayInfos> <StayInfo> <PropertyID>2</PropertyID> <DateFrom>2019-03-02</DateFrom> <DateTo>2019-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> <StayInfo> <PropertyID>4</PropertyID> <DateFrom>2019-03-02</DateFrom> <DateTo>2019-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid> </Costs> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <LanguageID>1</LanguageID>

RENTALSUNITED


<CountryID>42</CountryID> </CustomerInfo> <Comments>test</Comments> </Reservaton> <Quote odeId>2</Quote odeId></Push_PutConfrmedReservaton ult_RQ>

3.3.4.3. ResponseXML Path Data Type Type DescriptioPush_PutConfrmedReservaton ult_RS C Root elementPush_PutConfrmedReservaton ult_RS/Status

String(100)

See ListStatuses

Push_PutConfrmedReservaton ult_RS/Status@ID


Push_PutConfrmedReservaton ult_RS/ReservatonID

Integer O Reservaton's unique ID, this element is not present when an error occurs

3.3.4.3.1. Example (completed successfully)<Push_PutConfrmedReservaton ult_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ReservatonID>124</ReservatonID></Push_PutConfrmedReservaton ult_RS>

3.3.4.3.2. Example (error occurred)<Push_PutConfrmedReservaton ult_RS> <Status ID="3">Property is not available in selected dates</Status> <ResponseID ID="1">Success</ResponseID></Push_PutConfrmedReservaton ult_RS>

3.3.5. Cancel reservation

3.3.5.1. UsageThis method cancels a reservaton (confrmed or on hold).

3.3.5.2. RequestXML Path Data Type Type DescriptioPush_CancelReservaton_RQ C Root elementPush_CancelReservaton_RQ/Authentcaton C, Authentcaton detailsPush_CancelReservaton_RQ/Authentcaton/UserName


Push_CancelReservaton_RQ/Authentcaton/Password


Push_CancelReservaton_RQ/ReservatonID Integer Reservaton's unique ID

3.3.5.2.1. Example<Push_CancelReservaton_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <ReservatonID>123</ReservatonID></Push_CancelReservaton_RQ>

RENTALSUNITED


3.3.5.3. ResponseXML Path Data Type Type DescriptioPush_CancelReservaton_RS C Root elementPush_CancelReservaton_RS/Status String(100

) See ListStatuses

Push_CancelReservaton_RS/Status@ID Integer See ListStatuses

3.3.5.3.1. Example<Push_CancelReservaton_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_CancelReservaton_RS>

3.3.6. Archive reservation

3.3.6.1. UsageThis method archives a reservaton (requests, on hold, canceled, past reservatons).

3.3.6.2. RequestXML Path Data Type Type DescriptioPush_ArchiveReservaton_RQ C Root elementPush_ArchiveReservaton_RQ/Authentcaton C, Authentcaton detailsPush_ArchiveReservaton_RQ/Authentcaton/UserName


Push_ArchiveReservaton_RQ/Authentcaton/Password


Push_ArchiveReservaton_RQ/ReservatonID Integer Reservaton's unique IDPush_ArchiveReservaton_RQ/Archive Book Indicates whether to

archive or unarchive reservaton / lead

true = archivefalse = unarchive

3.3.6.2.1. Example<Push_ArchiveReservaton_RQ> <Authentcaton> <UserName>Test</UserName> <Password>Test</Password> </Authentcaton> <ReservatonID>123</ReservatonID> <Archive>true</Archive></Push_ArchiveReservaton_RQ>

3.3.6.3. ResponseXML Path Data Type Type DescriptioPush_ArchiveReservaton_RS C Root elementPush_ArchiveReservaton_RS/Status String(100

) See ListStatuses

Push_ArchiveReservaton_RS/Status@ID Integer See ListStatuses

RENTALSUNITED


3.3.6.3.1. Example<Push_ARchiveReservaton_RS> <Status ID="0">Success</Status> <ResponseID ID="1">0123456789ABCDEF0123456789ABCDEF</ResponseID></Push_ArchiveReservaton_RS>

3.3.7. Put Lead

3.3.7.1. UsageThis method inserts a new reservaton with a request status (Lead). Leads do not block the availability of the property. Leads are just an informaton that a customer is interested in rentng the property. Leads can be transformed to a confrmed reservaton or cancelled. If you want to confrm a lead you need to call Push_PutConfrmedReservaton ult_RQ with the Push_PutConfrmedReservaton ult_RQ/Reservaton/ReservatonID element flled (which is the value of Push_PutLead_RS/ReservatonID). If you want to cancel a lead you need to call Push_CancelReservaton_RQ (you do not have to cancel leads, but this can be useful for conversiontracking).Leads can be confrmed or cancelled by the lead creator or a that property's owne. Confrmed leads are transformed into confrmed reservatons. It means they will be included in Pull_ListReservatons_RQ and LN as a standard confrmed reservaton.

3.3.7.2. RequestXML Path Data Type Type DescriptioPush_PutLead_RQ C Root ElementPush_PutLead_RQ/Authentcaton C, Authentcaton detailsPush_PutLead_RQ/Authentcaton/UserName String

(50) Provided by RU

Push_PutLead_RQ/Authentcaton/Password String(50)

Provided by RU

Push_PutLead_RQ/Lead Single reservaton requestPush_PutLead_RQ/Lead/ExternalReservatonID

String Lead's unique identfer from the external system that created it

Push_PutLead_RQ/Lead/PropertyID Integer Property's unique IDPush_PutLead_RQ/Lead/DateFrom String

(10) Start of the lead

(YYYY- -DD format)Push_PutLead_RQ/Lead/DateTo String

(10) End of the lead

(YYYY- -DD format)Push_PutLead_RQ/Lead/NumberOfGuests Int Number of guests Push_PutLead_RQ/Lead/CustomerInfo C. Informaton about the

customerPush_PutLead_RQ/Lead/CustomerInfo/Name String

(20) Customer's name

Push_PutLead_RQ/Lead/CustomerInfo/SurName

String(30)

Customer's surname

Push_PutLead_RQ/Lead/CustomerInfo/Email String(100)


Push_PutLead_RQ/Lead/CustomerInfo/Phone String(30)

O Customer's phone number with the country code

Push_PutLead_RQ/Lead/CustomerInfo/SkypeI String O Customer's Skype ID

RENTALSUNITED


d (50)Push_PutLead_RQ/Lead/CusomterInfo/Address

String(50)


Push_PutLead_RQ/Lead/CustomerInfo/ZipCode

String(15)

O Customer's zip Code

Push_PutLead_RQ/Lead/CustomerInfo/CountryID

Integer Country's unique ID, see ListLocatons (flter LocatonTypeID=2)

Push_PutLead_RQ/Lead/CustomerInfo/LanguageID

Integer Code that identfes the language of the descriptonsee Pull_ListLanguages

Push_PutLead_RQ/Lead/Comments String(4000)

Additonal informaton

3.3.7.2.1. Example<Push_PutLead_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <Lead> <ExternalLeadID>123_asd_213</ExternalLeadID> <PropertyID>1</PropertyID> <DateFrom>2014-04-10</DateFrom> <DateTo>2014-04-20</DateTo> <NumberOfGuests>2</NumberOfGuests> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> <LanguageID>1</LanguageID> </CustomerInfo> <Comments>How much is it?</Comments> </Lead></Push_PutLead_RQ>

3.3.7.3. ResponseXML Path Data Type Type DescriptioPush_PutLead_RS C Root ElementPush_PutLead_RS/Status String


Push_PutLead_RS/Status/@ID Integer See ListStatusesPush_PutLead_RS/ReservationID Integer Reservaton's unique ID

3.3.7.3.1. Example <Push_PutLead_RS> <Status ID="0">Success</Status> <ReservationID>123456</ReservationID> <ResponseID ID="1">Success</ResponseID></Push_PutLead_RS>

RENTALSUNITED


3.3.8. Push ModifyStay

3.3.8.1. UsageAllows the user to modify an existing part of a confirmed reservation to move the user to a differentproperty\apartment or change the arrival \ depature dates, number of guests, client's price and the al-ready paid amount.

3.3.8.2. RequestXML Path Data Type Type DescriptioPush_ odifyStay_RQ C Root ElementPush_ odifyStay_RQ/Authentcaton C, Authentcaton detailsPush_ odifyStay_RQ/Authentcaton/UserName

String(50)

Provided by RU

Push_ odifyStay_RQ/Authentcaton/Password

String(50)

Provided by RU

Push_ odifyStay_RQ/ReservatonID Reservaton's unique IDPush_ odifyStay_RQ/Current C, Reservaton detailsPush_ odifyStay_RQ/Current/PropertyID Integer ID of the originally booked

propertyPush_ odifyStay_RQ/Current/DateFrom String

(10) Arrival date

(YYYY- -DD format)Push_ odifyStay_RQ/Current/DateTo String

(10) Departure date

(YYYY- -DD format)Push_ odifyStay_RQ/ odify C, odifcaton detailsPush_ odifyStay_RQ/ odify/PropertyID Integer O New property's IDPush_ odifyStay_RQ/ odify/DateFrom String

(10)O New Arrival date (YYYY-

-DD format)Push_ odifyStay_RQ/ odify/DateTo String

(10)O New Departure date (YYYY-

-DD format)Push_ odifyStay_RQ/ odify/NumberOfGuests

Integer O New number of guests staying in the property

Push_ odifyStay_RQ/ odify/ClientPrice Decimal(19,2)

O New price the client has to pay.

Push_ odifyStay_RQ/ odify/AlreadyPaid Decimal(19,2)

O New price the client has already paid.

Push_ odifyStay_RQ/ odify/P SReservatonId

String(100)

O New reservaton Id from P S

Push_ odifyStay_RQ/AllowOverbooking Boolean O If true, then allows for an overbooking. Default is false.

3.3.8.2.1. Example<Push_ModifyStay_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <ReservationID>123456</ReservationID> <Current> <PropertyID>1</PropertyID> <DateFrom>2015-05-20</DateFrom> <DateTo>2015-06-30</DateTo> </Current>

RENTALSUNITED

http://www.RentalsUnited.com <Modify> <PropertyID>2</PropertyID> <DateFrom>2015-06-01</DateFrom> <DateTo>2015-06-15</DateTo> <NumberOfGuests>2</NumberOfGuests> <ClientPrice>123.45</ClientPrice> <AlreadyPaid>123.45</AlreadyPaid> <PMSReservationId>7yd8</PMSReservationId> </Modify> <AllowOverbooking>false</AllowOverbooking></Push_ModifyStay_RQ>

1.1.1.1. ResponseXML Path Data Type Type DescriptioPush_ odifyStay_RS C Root ElementPush_ odifyStay_RS/Status String


Push_ odifyStay_RS/Status/@ID Integer See ListStatuses

3.3.8.2.2. Example<Push_PutLead_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_PutLead_RS>

3.4. User management

3.4.1. Create user

3.4.1.1. UsageThis method allows users with the "CreateUser" role to create new user accounts.

3.4.1.2. RequestXML Path Data Type Type DescriptioPush_CreateUser_RQ C Root ElementPush_CreateUser_RQ/Authentcaton C, Authentcaton detailsPush_CreateUser_RQ/Authentcaton/UserName

String(50)

Provided by RU

Push_CreateUser_RQ/Authentcaton/Password

String(50)

Provided by RU

Push_CreateUser_RQ/FirstName String(50)

User's frst name

Push_CreateUser_RQ/LastName String(50)

User's last name

Push_CreateUser_RQ/Email String(50)

User's email

Push_CreateUser_RQ/Password String(50)

User's password

Push_CreateUser_RQ/P SId Integer O Allows to associate User to P S serviceProvided by RU

Push_CreateUser_RQ/ConfguratonString String(150)

O Had to be consulted with RU support what should be

RENTALSUNITED


provided in this feldPush_CreateUser_RQ/Locatons C, User's locatonsPush_CreateUser_RQ/LocatonId Integer At least one the user's

locatons

3.4.1.2.1. Example<Push_CreateUser_RQ> <Authentication> <UserName>test</UserName> <Password>test</Password> </Authentication> <FirstName>John</FirstName> <LastName>Doe</LastName> <Email>[email protected]</Email> <Password>testpass</Password> <Locations> <LocationId>1</LocationId> </Locations></Push_CreateUser_RQ>

3.4.1.3. ResponseXML Path Data Type Type DescriptioPush_CreateUser_RS C Root ElementPush_CreateUser_RS/Status String


Push_CreateUser_RS/Status/@ID Integer See ListStatuses

3.4.1.3.1. Example <Push_CreateUser_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_CreateUser_RS>

RENTALSUNITED


4. Live Notification Mechanism (LNM)

4.1. OverviewThe RU system can call your system whenever a change is made. The call is a simple

HTTP/HTTPS GET request, along with specifc query string. Query string depends on the type of change. There are diferent types of changes available. You should call Pull_ListLiveNotificationMechanismChangeTypes_RQ method to get available change types, along with description and example. To subscribe for changes, use Push_PutLiveNotificationMechanismSubscriptions_RQ method. To review your subscriptions, use Pull_ListLiveNotificationMechanismSubscriptions_RQ method. The LNM request will never carry sensitive information (HTTP GET is not secure) or any detailed information about the values of the change. For example, the request will contain information like “price for property X changed between May and July”, but NOT “price for property X changed from Y to Z between May and July”. The information in the notification should be used to fetch actual values from RU API.

4.2. DetailsThe LN makes a simple HTTP/HTTPS GET request to a URL provided by you. It expects

HTTP status 200 response. The response content doesn't mater. You should process the request within 3 seconds and therefore the LN notfcaton request must be processed asynchronously byyou. Synchronous processing is not allowed.

The LN uses “at-least-once” notfcaton delivery reliability. Your URL will be called at leastonce. Afer getng HTTP 200 response, usually you will never be called again with this partcular notfcaton (each distnct notfcaton have the ChangeId – a GUID for tracking purposes). However,in some cases you AY be called again, even if HTTP 200 response is given within 3 seconds, therefore notfcaton handling must be idempotent.

Failed notfcatons (those which for RU do not get HTTP 200 response within 3 seconds) are scheduled for delivery later. The LN will try do deliver the notfcaton around three tmes. First tme immediately, then around 2 minutes later. If failed, around 8 minutes later. If failed, around 18 minutes later.

4.3. API Methods

4.3.1. List Change Types

4.3.1.1. UsageUse this method to get information about possible notifications.

4.3.1.2. RequestXML Path Data Type Type DescriptioPull_ListLiveNotfcaton echanismChangeTypes_RQ

C Root Element

Pull_ListLiveNotfcaton echanismChangeTypes_RQ/Authentcaton


Pull_ListLiveNotfcaton echanismChangeTypes_RQ/Authentcaton/UserName

String(50)

Provided by RU

Pull_ListLiveNotfcaton echanismChangeTypes_RQ/Authentcaton/Password

String(50)

Provided by RU

RENTALSUNITED


4.3.1.3. Example<Pull_ListLiveNotificationMechanismChangeTypes_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication></Pull_ListLiveNotificationMechanismChangeTypes_RQ>

4.3.1.4. ResponseXML Path Data Type Type DescriptioPull_ListLiveNotfcaton echanismChangeTypes_RS

C Root Element

Pull_ListLiveNotfcaton echanismChangeTypes_RS/Status

String(100)

See ListStatuses

Pull_ListLiveNotfcaton echanismChangeTypes_RS/Status/@ID


Pull_ListLiveNotfcaton echanismChangeTypes_RS/ChangeTypesPull_ListLiveNotfcaton echanismChangeTypes_RS/ChangeTypes

C, A collecton of change types

Pull_ListLiveNotfcaton echanismChangeTypes_RS/ChangeTypes/ChangeType/Descripton

String(2000)

Descripton of change type

Pull_ListLiveNotfcaton echanismChangeTypes_RS/ChangeTypes/ChangeType/ExampleUrl

String(2000)

Example url with defned query string

Pull_ListLiveNotfcaton echanismChangeTypes_RS/ChangeTypes/ChangeType@ID

String(50) Change type ID

4.3.1.5. Example<Pull_ListLiveNotificationMechanismChangeTypes_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ChangeTypes> <ChangeType ID="PropertyStaticDetails"> <Description>This notification will be triggered each time property static details arechanged. Publisher is the ID of the property owner.</Description> <ExampleUrl>http://test.com/something?ChangeId=f892a4eb-f070-43ee-881e-b3737f1bd462&PropertyId=123456&Publisher=234567&Type=PropertyStaticDetails</ExampleUrl> </ChangeType> <ChangeType ID="PropertyChangeover"> <Description>This notification will be triggered each time modification of the property changeover is made. Publisher is the ID of the property owner.</Description> <ExampleUrl>http://test.com/something?ChangeId=3a2882f2-6421-47e8-97e4-10003fc363f9&DateFrom=2015-06-11T00-00-00Z&DateTo=2015-06-18T00-00-00Z&PropertyId=123456&Publisher=234567&Type=PropertyChangeover</ExampleUrl> </ChangeType> <ChangeType ID="PropertyMinStay"> <Description>This notification will be triggered each time modification of the property min stay is made. Publisher is the ID of the property owner.</Description> <ExampleUrl>http://test.com/something?ChangeId=7ed67358-3f25-4c3a-aba6-faef66a30fb9&DateFrom=2015-06-11T00-00-00Z&DateTo=2015-06-18T00-00-00Z&PropertyId=123456&Publisher=234567&Type=PropertyMinStay</ExampleUrl> </ChangeType> <ChangeType ID="PropertyAvailability"> <Description>This notification will be triggered each time property availability is changed. Publisher is the ID of the property owner.</Description>

RENTALSUNITED

http://www.RentalsUnited.com <ExampleUrl>http://test.com/something?ChangeId=bda563b1-93e1-428b-a6bf-729f9f5d7d8b&DateFrom=2015-06-11T00-00-00Z&DateTo=2015-06-18T00-00-00Z&PropertyId=123456&Publisher=234567&Type=PropertyAvailability</ExampleUrl> </ChangeType> <ChangeType ID="PropertyPrice"> <Description>This notification will be triggered each time property price is changed. Publisher is the ID of the property owner.</Description> <ExampleUrl>http://test.com/something?ChangeId=7e3026f5-cb6e-4519-897a-8f6b0c15f7a2&DateFrom=2015-06-11T00-00-00Z&DateTo=2015-06-18T00-00-00Z&PropertyId=123456&Publisher=234567&Type=PropertyPrice</ExampleUrl> </ChangeType> </ChangeTypes></Pull_ListLiveNotificationMechanismChangeTypes_RS>

4.3.2. Subscribe for notifications request

4.3.2.1. UsageUse this method to subscribe for notifications. This method replaces all your subscriptions

with the subscriptions in the request. To unsubscribe from all notifications, send a request without ChangeTypes, ObservedOwners and UrlBase XML elements (only authentication element should beleft).

4.3.2.2. RequestXML Path Data Type Type DescriptioPush_PutLiveNotfcaton echanismSubscriptons_RQ

C Root Element

Push_PutLiveNotfcaton echanismSubscriptons_RQ/Authentcaton


Push_PutLiveNotfcaton echanismSubscriptons_RQ/Authentcaton/UserName

String(50)

Provided by RU

Push_PutLiveNotfcaton echanismSubscriptons_RQ/Authentcaton/Password

String(50)

Provided by RU

Push_PutLiveNotfcaton echanismSubscriptons_RQ/ChangeTypes

C, List of types of notfcatons to subscribe for

Push_PutLiveNotfcaton echanismSubscriptons_RQ/ChangeTypes/Type

String(50)

Notfcaton type ID

Push_PutLiveNotfcaton echanismSubscriptons_RQ/ObservedOwners

C, List of observed owners to subscribe for

Push_PutLiveNotfcaton echanismSubscriptons_RQ/ObservedOwners/Owner

Integer Observed owner ID

Push_PutLiveNotfcaton echanismSubscriptons_RQ/UrlBase

String(200)

The URL base to which query string will be added. It is the “htp://test.com/something” part in the examples in Pull_ListLiveNotfcaton echanismChangeTypes_RS.

4.3.2.3. Example<Push_PutLiveNotificationMechanismSubscriptions_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <ChangeTypes> <Type>PropertyStaticDetails</Type> <Type>PropertyMinStay</Type>

http://test.com/something

RENTALSUNITED

http://www.RentalsUnited.com <Type>PropertyPrice</Type> </ChangeTypes> <ObservedOwners> <Owner>123456</Owner> <Owner>987654</Owner> </ObservedOwners> <UrlBase>http://mywebsite.com/api/lnm</UrlBase></Push_PutLiveNotificationMechanismSubscriptions_RQ>

4.3.2.4. ResponseXML Path Data Type Type DescriptioPush_PutLiveNotfcaton echanismSubscriptons_RS

C Root Element

Push_PutLiveNotfcaton echanismSubscriptons_RS/Status

String(100)

See ListStatuses

Push_PutLiveNotfcaton echanismSubscriptons_RS/Status/@ID


4.3.2.5. Example<Push_PutLiveNotificationMechanismSubscriptions_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID></Push_PutLiveNotificationMechanismSubscriptions_RS>

4.3.3. List subscriptions

4.3.3.1. UsageUse this method get information about your subscriptions.

4.3.3.2. RequestXML Path Data Type Type DescriptioPull_ListLiveNotfcaton echanismSubscriptons_RQ

C Root Element

Pull_ListLiveNotfcaton echanismSubscriptons_RQ/Authentcaton


Pull_ListLiveNotfcaton echanismSubscriptons_RQ/Authentcaton/UserName

String(50)

Provided by RU

Pull_ListLiveNotfcaton echanismSubscriptons_RQ/Authentcaton/Password

String(50)

Provided by RU

4.3.3.3. Example<Pull_ListLiveNotificationMechanismSubscriptions_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication></Pull_ListLiveNotificationMechanismSubscriptions_RQ>

4.3.3.4. ResponseXML Path Data Type Type DescriptioPull_ListLiveNotfcaton echanismSubscriptons_RS

C Root Element

Pull_ListLiveNotfcaton echanismSubscriptons_RS/Status

String(100)

See ListStatuses

Pull_ListLiveNotfcaton echanismSubscript Integer See ListStatuses

RENTALSUNITED


ons_RS/Status/@IDPull_ListLiveNotfcaton echanismSubscriptons_RS/ChangeTypes

C,O List of types of subscribed notfcatons

Pull_ListLiveNotfcaton echanismSubscriptons_RS/ChangeTypes/Type

String(50)

Notfcaton type ID

Pull_ListLiveNotfcaton echanismSubscriptons_RS/ObservedOwners

C, O List of observed owners

Pull_ListLiveNotfcaton echanismSubscriptons_RS/ObservedOwners/Owner

Integer Observed owner ID

Pull_ListLiveNotfcaton echanismSubscriptons_RS/UrlBase

String(200)

O The URL base to which query string will be added. It is the “htp://test.com/something” part in the examples in Pull_ListLiveNotfcaton echanismChangeTypes_RS.

4.3.3.5. Example<Pull_ListLiveNotificationMechanismSubscriptions_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <ChangeTypes> <Type>PropertyMinStay</Type> <Type>PropertyPrice</Type> <Type>PropertyStaticDetails</Type> </ChangeTypes> <ObservedOwners> <Owner>123456</Owner> <Owner>987654</Owner> </ObservedOwners> <UrlBase>http://mywebsite.com/api/lnm</UrlBase></Pull_ListLiveNotificationMechanismSubscriptions_RS>

5. Reservation Live Notification Mechanism (RLNM)The RU system can call your system to transfer informaton about a new reservaton (confrmed or lead) or a cancellaton. To use this feature you should create a HTTP/HTTPS request handler. The RU system will post this service (with a specifc X L content) every tme someone puts a confrmed reservaton/lead for your property or cancels it. RLN simply posts your handler and does not expect a response. There are 3 types of content that can be posted to your handler:

• LN _PutConfrmedReservaton_RQ – confrmed reservatons• LN _CancelReservaton_RQ – cancellatons (confrmed reservatons or leads)• LN _PutLeadReservaton_RQ – leads

Your RLN request handler should be a single URL and accept 3 types of content. Please note, thatin order to receive credit card numbers, you need to pass an HTTPS URL.

5.1. Enabling RLNMYou have to set up your request handler and get the password hash frst, if you want posts from RLN . Sending this request will replace current handler URL, if any.

5.1.1. RequestXML Path Data Type Type Descriptio

http://test.com/something

RENTALSUNITED


LN _PutHandlerUrl_RQ C Root elementLN _PutHandlerUrl_RQ/Authentcaton C, Authentcaton detailsLN _PutHandlerUrl_RQ/Authentcaton/UserName


LN _PutHandlerUrl_RQ/Authentcaton/Password


LN _PutHandlerUrl_RQ/HandlerUrl String Request handler URL

5.1.2. Example<LNM_PutHandlerUrl_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <HandlerUrl>https://example.com/handler/rentals-united</HandlerUrl></LNM_PutHandlerUrl_RQ>

5.1.3. ResponseXML Path Data Type Type DescriptioLN _PutHandlerUrl_RS Integer C Root elementLN _PutHandlerUrl_RS/Status String(100

) See ListStatuses

LN _PutHandlerUrl_RS/Status@ID Integer See ListStatusesLN _PutHandlerUrl_RS/Hash String(40) Password hash

5.1.4. Example<LNM_PutHandlerUrl_RS> <Status ID="0">Success</Status> <ResponseID ID="1">Success</ResponseID> <Hash>1X7J9SALRDJ283FMY8PFO8BIGBTEZ5J68WGNEGZW</Hash></LNM_PutHandlerUrl_RS>

5.2. Confirmed reservationRLN will call your request handler with this format every tme when someone puts a confrmed reservaton for one of your propertes in the RU system.

XML Path Data Type Type DescriptioLN _PutConfrmedReservaton_RQ C Root elementLN _PutConfrmedReservaton_RQ/Authentcaton


LN _PutConfrmedReservaton_RQ/Authentcaton/UserName

String(50) RU Username

LN _PutConfrmedReservaton_RQ/Authentcaton/Password

String(50) Password hash. See PutHandlerUrl

LN _PutConfrmedReservaton_RQ/Reservaton

O Single reservaton

LN _PutConfrmedReservaton_RQ/Reservaton/ReservatonID

Integer Reservaton's unique ID, this element is optonal, you should use it if you put property on hold previously

LN _PutConfrmedReservaton_RQ/Reservaton/Reservaton/Last od

String Date of creaton of the reservaton

RENTALSUNITED


YYYY- -DD HH- -SS format)

LN _PutConfrmedReservaton_RQ/Reservaton/Reservaton/ReservatonStatusID

Int See ListReservatonStatuses

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos

C, A collecton of stay informaton

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/PropertyID


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/DateFrom


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/DateTo


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/NumberOfGuests

Integer Number of guests that will be staying in the property

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Costs

C, Informaton about the stay costs

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Costs/RUPrice

Decimal (19,2)


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Costs/ClientPrice

Decimal (19,2)


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Costs/AlreadyPaid

Decimal(19,2)


LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Costs/PriceScale

String Informaton about what price scale was used

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/Comments

String(500)

O Additonal comments aboutthis stay

LN _PutConfrmedReservaton_RQ/Reservaton/StayInfos/StayInfo/ResApaID

Integer Apartment reservaton ID

LN _PutConfrmedReservaton_RQ /Reservatons/Reservaton/StayInfos/StayInfo/ apping/ReservatonID

String(50)

Reservaton's unique ID from the external system that created it

LN _PutConfrmedReservaton_RQ /Reservatons/Reservaton/StayInfos/StayInfo/ apping/StayID

String(50)

O External reservaton ID associated with the property

LN _PutConfrmedReservaton_RQ /Reservatons/Reservaton/StayInfos/StayInfo/ apping/HotelID

String(50)

O External system's property ID

LN _PutConfrmedReservaton_RQ /Reservatons/Reservaton/StayInfos/StayInfo/ apping/RoomID

String(50)

O External system's room ID

LN _PutConfrmedReservaton_RQ /Reservatons/Reservaton/StayInfos/StayInfo/ apping/RateID

String(50)

O External system's rate ID

LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo


LN _PutConfrmedReservaton_RQ/Reservat String(20) Customer's name

RENTALSUNITED


on/CustomerInfo/NameLN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/SurName


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/Email

String(100)


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/Phone


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/SkypeID


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/Address


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/ZipCode


LN _PutConfrmedReservaton_RQ/Reservaton/CustomerInfo/CountryID


LN _PutConfrmedReservaton_RQ/Reservaton/Creator


LN _PutConfrmedReservaton_RQ/Reservaton/Comments

String(4000)


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/CCNumber


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/CVC

String(4)


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/NameOnCard

String(400)


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/Expiraton

String(7) C redit Card expiraton date( /YYYY format)

LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/BillingAddress

String(400)

O Billing address

LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/CardType


LN _PutConfrmedReservaton_RQ/Reservaton/CreditCard/Comments

String(400)

O Additonal comments for the Credit Card

5.2.1. Example<LNM_PutConfirmedReservation_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password>

RENTALSUNITED

http://www.RentalsUnited.com </Authentication> <Reservation> <ReservationID>124</ReservationID> <LastMod>2012-08-12 14:10:00</LastMod> <StayInfos> <StayInfo> <PropertyID>2</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid>

<PriceScale>0%</PriceScale> </Costs> </StayInfo> <StayInfo> <PropertyID>4</PropertyID> <DateFrom>2012-03-02</DateFrom> <DateTo>2012-03-14</DateTo> <NumberOfGuests>3</NumberOfGuests> <Costs> <RUPrice>120.00</RUPrice> <ClientPrice>140.00</ClientPrice> <AlreadyPaid>0.00</AlreadyPaid>

<PriceScale>0%</PriceScale> </Costs>

<ResApaID>123456</ResApaID> </StayInfo> </StayInfos> <CustomerInfo> <Name>Test</Name> <SurName>Test</SurName> <Email>[email protected]</Email> <Phone>+11 111 111 111</Phone> <SkypeID>test.test</SkypeID> <Address>Street 1/2</Address> <ZipCode>00-000</ZipCode> <CountryID>100</CountryID> </CustomerInfo> <Mapping> <ReservationID>123</ReservationID> <StayID>123</StayID> <HotelID>123</HotelID> <RoomID>123</RoomID> <RateID>123</RateID> </Mapping> <Creator>[email protected]</Creator> <Comments>test</Comments> </Reservation></LNM_PutConfirmedReservation_RQ>

5.3. Cancellation of the reservation/leadRLN will call your request handler with this format every tme someone cancels a reservaton on one of your propertes in the RU system.

XML Path Data Type Type DescriptioLN _CancelReservaton_RQ C Root element

RENTALSUNITED


LN _CancelReservaton_RQ/Authentcaton C, Authentcaton detailsLN _CancelReservaton_RQ/Authentcaton/UserName

String(50) RU Username

LN _CancelReservaton_RQ/Authentcaton/Password

String(50) Password hash provided by RU

LN _CancelReservaton_RQ/ReservatonID Integer Reservaton's unique ID

5.3.1. Example<LNM_CancelReservation_RQ> <Authentication> <UserName>Test</UserName> <Password>Test</Password> </Authentication> <ReservationID>123</ReservationID></LNM_CancelReservation_RQ>

5.4. New LeadRLN will call your request handler with this format every tme someone puts a lead for one of your propertes in the„request handler” with this format each tme when someone puts lead for one of your propertes in RU system.

XML Path Data Type Type DescriptioLNM_PutLeadReservation_RQ C Root ElementLNM_PutLeadReservation_RQ/Authentication C, Authentcaton detailsLNM_PutLeadReservation_RQ/Authentication/UserName

String(50)

O RU Username

LNM_PutLeadReservation_RQ/Authentication/Password

String(50)

O Password hash provided by RU

LNM_PutLeadReservation_RQ/Reservation O Single reservaton requestLNM_PutLeadReservation_RQ/Reservation/ExternalLeadID

String O Lead's unique identfer from the external system that created it

LNM_PutLeadReservation_RQ/Reservation/PropertyID

Integer O Property's unique ID

LNM_PutLeadReservation_RQ/Reservation/DateFrom

String(10)

O Start of the lead(YYYY- -DD format)

LNM_PutLeadReservation_RQ/Reservation/DateTo

String(10)

O End of the lead(YYYY- -DD format)

LNM_PutLeadReservation_RQ/Reservation/NumberOfGuests

Int O Number of guests

LNM_PutLeadReservation_RQ/Reservation/ResApaID

Int Apartment Reservaton ID

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo

C. Informaton about the customer

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/Name

String(20)

O Customer's name

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/SurName

String(30)

O Customer's surname

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/Email

String(100)

O Customer's email address

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/Phone

String O Customer's phone number

RENTALSUNITED


(30) with the country codeLNM_PutLeadReservation_RQ/Reservation/CustomerInfo/SkypeId

String(50)

O Customer's Skype ID

LNM_PutLeadReservation_RQ/Reservation/CusomterInfo/Address

String(50)


LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/ZipCode

String(15)

O Customer's zip code

LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/CountryID


LNM_PutLeadReservation_RQ/Reservation/CustomerInfo/LanguageID

Integer O Code that identfes the language of the descriptonsee Pull_ListLanguages

LNM_PutLeadReservation_RQ/Reservation/Comments

String(4000)

Additonal informaton

LNM_PutLeadReservation_RQ/Reservation/Creator

String(50)

Informaton about the user who created the lead

LNM_PutLeadReservation_RQ/Reservation/DateEntered

String(19) Informaton when the lead was created(YYYY- -DD HH: :SS format)

5.4.1. Example<LNM_PutLeadReservation_RQ> <Authentication> <UserName>TEST</UserName> <Password>TEST</Password> </Authentication> <Reservation> <ExternalReservationID>123asd123</ExternalReservationID> <PropertyID>1</PropertyID> <DateFrom>2014-06-01</DateFrom> <DateTo>2014-06-08</DateTo> <NumberOfGuests>2</NumberOfGuests> <ResApaID>12345</ResApaID> <CustomerInfo> <Name>test</Name> <SurName>test</SurName> <Email>[email protected]</Email> <Phone>0000000</Phone> <CountryID>66</CountryID> </CustomerInfo> <Comments> How much is it? </Comments> <Creator>[email protected]</Creator> <DateEntered>2014-05-26 09:17:00</DateEntered> </Reservation></LNM_PutLeadReservation_RQ>

6. Credit Card policyRentals United does not store credit card informaton. Rentals United's only functon is to provide credit card informaton from the seller to the property provider. Credit card informaton is

RENTALSUNITED


transferred from Push_PutConfrmedReservaton ult_RQ request (invoked by the seller) to the agent's Live Notfcaton echanism feed upon booking. Live Notfcaton echanism requests will include the credit card informaton only if the gent's Live Notfcaton echanism feed is secured by SSL – otherwise, the credit card informaton will not be transferred. Credit card informaton will be transferred only once, with the Live Notfcaton echanism request at the same tme as the client provides a credit card on the selling agent's website. It is not possible to fetch credit card informaton again later without contactng the selling agent (or the customer).

7. Recommended integration scenarioThis secton describes recommended the scenario of integraton. You can do it in your own, more suitable way, but this example allows you to easily understand our main idea.

7.1. Properties uploadThe propertes that you have decided to ofer in the RU system should be uploaded to the RU system (including the most detailed informaton allowed in this API). You should keep your propertes' availability and prices up to date in the RU system. Thanks to this the customers will always have accurate informaton about your ofer.

7.1.1. DefinitionsAbstract DescriptioSearch criteria Stay dates, destnaton, number of guests that are

provided by the customerSearch result page The web page that displays the ofers (propertes)

for the requested search criteriaProperty details page The web page that displays the property details

for the requested search criteriaBooking form The web page that allows the customer to book

the selected property

7.1.2. Initial operationsYou should download all of the propertes available in the RU system and dictonaries to your own system (database). The downloaded data should be updated periodically. RU will inform you about any changes to the dictonaries, but you have to track changes of property data in you own way (List Propertes method and Last od atribute would be very helpful to check whether any property details have changed).

7.1.3. WorkflowStep API methid1. Customer provides the search criteria None2. Search result page is displayed To display this page you have to know which of

the propertes are available and what is their pricefor the requested criteria.You can do it in 2 ways:1) Cache modePeriodically (e.g. once a day) invoke List property availability calendar, List propertes prices, List property discounts and store the results in your database. Using the stored results you can check

RENTALSUNITED


for available apartments and prices. In this mode, there is no guarantee that the availability and prices are up to date, but it's very fast. You do not have to invoke the RU system to get the data.

2) Live modeEach tme you want to display a search result pageyou have to invoke Get propertes avb price. In this mode you will get current data, but the page rendering tme will be longer.

3. The customer has chosen the most suitable ofer (property details page is displayed)

In this step you should invoke Get property avb price to get the property's fnal and current availability and price

4. The customer has decided to book the selected property (booking form is displayed)

In this step you should invoke Put reservaton on hold. Thanks to that you have a guarantee that no one else will book the selected property.

5. Booking form completed In this step you should invoke Put confrmed reservaton. This method inserts a fnal reservaton to the RU system.

7.2. Receiving reservations and leads for you propertiesThe RU system provides two ways of receiving reservatons and leads:

• Pull_ListReservatons_RQ and Pull_GetLeads_RQ methods – you can call this method periodically to receive reservaton informaton. It returns informaton about new (confrmed/lead) and cancelled reservatons. We recommend that you call this method at least once a day.

• Live Notfcaton echanism (LN ) – the RU system invokes your HTTP/HTTPS request handler to inform you about new confrmed reservatons, new leads and cancelled reservatons/leads. This soluton requires a X L handler on your side.

We recommend a mix of these methods. LN allows you to get the booking informaton immediately afer a booking/cancellaton occurs. Pull_ListReservatons_RQ , Pull_GetLeads_RQ methods will allow you to verify that your request handler received all the reservatons in the specifed period and locaton. You shouldn't use the LN method without using Pull_ListReservatons_RQ , Pull_GetLeads_RQ verifcaton (network issues with LN calls can resultin missed reservatons).

8. Change log• 2012-05-10

new method: ListStatuses

• 2012-05-10

New element Costs in Push_PutConfrmedReservaton_RQ

• 2012-05-10

- Changes in Push_PutLast inuteDiscounts_RQ, Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DaysToArrival [DEPRECATED]

RENTALSUNITED


Push_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DaysToArrivalFrom – new attributePush_PutLast inuteDiscounts_RQ/Last inutes/Last inute@DaysToArrivalTo – new attribute

• 2012-08-12

- PutPropertyOnHold [DEPRECATED] (please use PutPropertesOnHold)- PutConfrmedReservaton [DEPRECATED] (please use PutConfrmedReservaton ult)- new method: GetLocatonByName- new method: ListReservatonStatuses- new method: ListReservatons- new method: CancelReservaton- new method: PutConfrmedReservaton ult- new method: PutPropertesOnHold- Live Notification Mechanism

• 2012-08-21

- new method: GetPropertyPrice

• 2012-08-31

- new method: ListAllOwners- new method: ListOwnerProp

• 2012-09-07

- new method: ListCurrenciesWithCites

• 2012-09-27

- Pull_ListSpecProp_RS/Property/IsOnlineAvailable [DEPRECATED]

• 2012-11-13

- new method: Pull_ListAmenitesAvailableForRooms_RS (allows to upload informaton about the amenites available in a given room type)- new element CompositonRoomsAmenites in Pull_ListSpecProp_RS- new element CompositonRoomsAmenites in Push_PutProperty_RQ

• 2012-11-20

- spelling mistake fx: Pull_ListSpecProp_RS/Property/CompostonRoomsAmenites to Pull_ListSpecProp_RS/Property/CompositonRoomsAmenites- spelling mistake fx: Push_PutProperty_RQ/Property/CompostonRoomsAmenites to Push_PutProperty_RQ/Property/CompositonRoomsAmenites

• 2012-12-27

- new elements LOSS, EGPS in Pull_ListPropertyPrices_RS, Pull_ListPropertesPrices_RS, Push_PutPrices_RQ- new example in How is the price calculated? Section

• 2013-01-14

- new elements Descriptions in Push_PutProperty_RQ, Pull_ListSpecProp_RS- new method: Pull_ListLanguages- new elements IMAP and DateCreated in Pull_ListProp_RS, Pull_ListOwnerProp_RS, Pull_ListSpecProp_RS- new example in How is the price calculated? section- new method: Pull_ListPropertyBasePrice- new method: Push_PutPropertyBasePrice- new method: Pull_ListPropByCreatonDate

• 2013-01-21

- new method: Pull_ListPropExtStatuses- new method: Pull_GetPropertyExternalListng- new method: Push_PutPropertyExternalListng

• 2013-01-25

- new element HowToArrive in Pull_ListSpecProp_RS, Push_PutProperty_RQ- new element PickupService in Pull_ListSpecProp_RS, Push_PutProperty_RQ

• 2013-02-18

RENTALSUNITED


- new element LOSP in Pull_ListPropertyPrices_RS, Pull_ListPropertesPrices_RS, Push_PutPrices_RQ- new example in How is the price calculated? Secton

• 2013-04-26

- new atributes Cleaning, ExtraPersonPrice in Pull_GetPropertyPrice_RS, Pull_GetPropertyAvbPrice_RS, Pull_GetPropertyAvbPrice_RS

• 2013-05-09

- new method: Pull_ListPropertyChangeLog, Pull_ ListPropertyPriceChanges, Pull_ ListPropertyAvbChanges

• 2013-05-15

- new method: Pull_ ListCitesProps

• 2013-08-08

- new element Creator in Pull_ListReservatons_RS/Reservatons/Reservaton- new element Creator in LN _PutConfrmedReservaton_RQ/Reservaton

• 2013-09-03

- new element SecurityDeposit in Pull_ListSpecProp_RS/Property and Push_PutProperty_RQ/Property- new atribute SecurityDeposit in Pull_GetPropertyPrice_RS/PropertyPrices/PropertyPrice, Pull_GetPropertyAvbPrice_RS/PropertyPrices/PropertyPrice and Pull_GetPropertesAvbPrice_RS/Propertes/PropertyPrices/PropertyPrice- fxed examples Pull_ListDepositTypes_RS, Pull_ListSpecProp_RS and Push_PutProperty_RQ

• 2013-11-18

- new element IncludeNLA in Pull_ListProp_RQ, Pull_ListOwnerProp_RQ. Pull_ListPropByCreatonDate_RQ, Pull_ListPropertesBlocks_RQ. Pull_ListPropertesPrices_RQ. Pull_GetPropertesAvbPrice_RQ.- new methods: Push_SetPropertesStatus_RQ, Pull_GetAvailablePropertes_RQ.

• 2013-12-16

- new element Comments in Pull_ListReservatons_RS/Reservatons/Reservaton, Push_PutConfrmedReservaton ult_RQ/Reservaton and LN _PutConfrmedReservaton_RQ/Reservaton

• 2013-12-30

- new element CreditCard in Push_PutConfrmedReservaton ult_RQ, LN _PutConfrmedReservaton_RQ- new secton: Credit Card policy

• 2014-01-10

- new element NOP in Pull_GetPropertyPrice_RQ, Pull_GetPropertyAvbPrice_RQ- new methods: Pull_GetOwnReservatons_RQ, Pull_ListPropertesChangeLog_RQ

• 2014-01-20

- changes in Pull_ListPropertesChangeLog_RQ (Pull_ListPropertesChangeLog_RQ/PropertyIDs marked optonal).

• 2014-02-05

- new statuses in Pull_ListPropExtStatuses_RS,- updated descripton of element: Push_PutPropertyExternalListng_RQ/Propertes/Property/Status.

• 2014-05-09

- new attribute OwnerID in Push_PutOwner_RQ – allows owner details update• 2014-05-26- new methods: Pull_GetLeads_RQ, Push_PutLead_RQ- LN for leads

• 2014-10-13

- new methods: Pull_ListChangeoverTypes_RQ, Pull_GetChangeoverDays_RQ and Push_PutChangeoverDays_RQ.• 2014-12-08

- bulk methods: Pull_GetResponse_RQ and Push_PutProperty_RQ.• 2014-12-11- new element /StayInfo/Comments in Push_PutConfrmedReservaton ult_RQ, LN _PutConfrmedReservaton_RQ, Pull_GetOwnReservatons_RS, Pull_ListReservatons_RS

RENTALSUNITED


• 2015-01-22

- Fixed entries in Pull_ListReservations_RS - Added information about CDATA in Pull_ListSpecProp_RS and Push_PutProperty_RQ• 2015-01-29

- new method: Push_CreateUser_RQ- 2015-03-09- new element /StayInfo/Costs/PriceScale in LN _PutConfrmedReservaton_RQ,

• 2015-04-16

- new method: Pull_GetAgents_RQ• 2015-05-05

- updated Pull_ListPropertyChangeLog_RS and Pull_ListPropertiesChangeLog_RS with new attribute• 2015-05-22

- new method: Push_ModifyStay_RQ• 2015-06-02

- Added Mapping details for Pull_ListReservations_RS and LNM_PutConfirmedReservations_RQ• 2015-06-02

- Added Credit Card info for Pull_ListReservations_RS • 2015-06-25

- Added “Modified” status for Pull_ListReservationStatuses_RS, fixed mapping info for LNM_PutConfirmedReservation_RQ, added ReservationStatusID for LNM_PutConfirmedReservation_RQ• 2015-07-08

- updated Pull_ListPropertyReviews_RS with new feld Email

- updated Pull_GetOwnerDetails_RS with ScreenName

• 2015-07-13

- Changed the processing mechanism for Pull_PutAvb_RQ, Pull_PutPrices_RQ, Pull_PutLongStayDiscounts_RQ and Pull_PutLastMinuteDiscounts_RQ to no longer process each element independently. - Reviewed contents

- New methods Pull_ListPropertyReviews_RQ, and Push_PutPropertyReviews_RQ

- Added missing Credit Card info example to Pull_ListReservatons_RS

• 2015-07-22

- updated Pull_GetOwnerDetails_RS with CompanyName

• 2015-07-28

- new method Pull_ListOTAPropTypes_RQ

- updated Pull_ListSpecProp_RS with ObjectTypeID

- updated Push_PutProperty_RQ with ObjectTypeID

• 2015-12-28

- updated Pull_ListReservatons_RS with ResapaID in StayInfo

• 2016-01-15

- new method Pull_GetLocatonByCoordinates_RQ

• 2016-08-08

- updated Push_PutProperty_RQ with CancellatonPolicyText

- updated Pull_ListSpecProp_RS with CancellatonPolicyText

• 2016-10-17

- new method Pull_GetReservatonByID_RS

• 2016-12-12

RENTALSUNITED


- new method Pull_GetFeesAndTaxesTypes

- FeeTaxType added to Pull_ListSpecProp_RS and Push_PutProperty_RQ

• 2017-03-07

- updated Pull_ListReservatons_RS, Pull_GetOwnerReservatons_RS, Pull_GetReservatonByID_RS with Passport in CustomerInfo

• 2017-04-19

- new feld LicenseNumber added to Pull_ListSpecProp_RS and Push_PutProperty_RQ

• 2017-04-19

- renamed ExternalLeadID to ExternalReservatonID in Push_PutLead_RQ

- added missing elements in Push_PutLast inuteDiscount_RQ and Push_PutLongStayDiscount

• 2017-06-13

- Added Pull_List yUsers method

- Added P SId and ConfguratonString in Push_CreateUser

• 2017-08-22

- updated Push_PutProperty_RQ with Property/Descriptions/Description/Text

• 2017-08-29

- added ResponseID

• 2018-02-23

- added new method Pull_CancellationTypes_RQ

- updated pull reservaton methods with opton CancelTypeID feld.

• 2018-03-08

- added Push_ArchiveReservation_RQ

• 2018-04-16

- added Pull_PropCount_RQ

• 2018-06-19

- added Push_StandardNumberOfGuests_RQ

• 2018-06-26

- added Pull_ListReservationsOwnerUser_RQ

• 2018-08-06

- added User details for Pull_GetOwnerDetails_RS, Pull_ListAllOwners_RS, Pull_GetAgents_RS

• 2018-08-06

- added ResApaID for LNM_PutConfirmedReservation_RQ and LNM_PutLeadReservation_RQ,

• 2018-09-11

- added new method Pull_QuoteModes_RQ

- updated put confirmed reservation method with optional QuoteModeId field

• 2018-11-16

- added CollectTime attribute to additional fee

• 2018-11-28

- added additional info about CollectTime attribute

• 2018-12-23

- added XmlApartmentID for Pull_ListReservations_RS, Pull_GetOwnReservations_RS, Pull_GetReservationByID_RS, Pull_ListReservationsOwnerUser_RS

RENTALSUNITED

http://www.RentalsUnited.com• 2019-01-14

- Maximum value of Push_PutDiscounts_RQ/LongStays/LongStay@Smaller limited to 180

• 2019-01-22

- New field LicenceInfo added to Pull_ListSpecProp_RS and Push_PutProperty_RQ

• 2019-02-12

- New field XmlApartmentID added to Pull_GetLeads_RS

• 2019-03-13

- New field PreparationTimeBeforeArrival added to Push_PutProperty_RQ and Pull_ListSpecProp_RS

• 2019-08-06

- update Pull_ListReservations_RS and Push_ModifyStay_RQ with PmsReservationId

• 2019-10-15

- updated description for Push_PutProperty_RQ/Property/PreparationTimeBeforeArrival

• 2019-11-08

- updated description for Push_PutProperty_RQ/Property/Images/Image

• 2019-11-14

- Push_PutProperty_RQ/Property/LicenceInfo and Push_PutProperty_RQ/Property/LicenceInfo/FrenchLicenceInfo marked as container (C) and Push_PutProperty_RQ/Property/LicenceInfo mared as ommitable (X)

• 2019-12-19

- Added new fields regarding LicenceInfo and NumberOfStars in Pull_ListSpecProp_RS and Push_PutProperty_RQ

• 2020-01-06

- Added two licence exemption reasons for Andalusia, Spain

- Added TasmanianLicenceInfo/TypeOfResidence

rentals unitedrm.rentalsunited.com/api/ruspecification.pdfvilla

Documents