|  Login  |   Support  |


Post / Update Ad API

Post Url:   http://www.freevacationrentalsite.com/post/
Secure Post Url:   https://www.freevacationrentalsite.com/post/   ( Warning: This will slow the performance of your post, but can be used to secure the transmission )
XML Variable:   xmlString
Content Type:   application/x-www-form-urlencoded
CharSet:   UTF-8
*** Remember to URL Encode Your XML String


Post XML
Req'd DataType Description
<post>
<userID> X guid Your gateway access username.
[ Click Here to Request an Account ]
<transkey> X sting(20) Your gateway password. Can be found by logging into your account, clicking on the "My Account".
<testmode> X boolean Process this transaction in test mode?
0 = Not a Test Transaction (will process your ad)
1 = Test Mode (will validate xml / data only)
<ad>
<metainfo>
<adID> C integer The unique adID that we generate when the ad is created. If the adID is not supplied we will create a brand new ad. If you do supply an adID we will update that ads information.
<sourceID> string(50) This is Your Unique ID. This will allow you to update your ads without having to store our ID's on your system. Example: The first time you feed an ad with a source id of "A12345" it will create a new ad. The next time your feed an ad with the same source id "A12345" it will update your original ad on our system with new information. It will not create a new ad.
<adStatusID> integer This will allow you to change the status of the ad on our system.
1 = Activate (available for the public to see)
2 = De-Activate (available for property manager to see but not the public)
3 = Delete (ad gets archived so no one can see the ad, however it isn't removed from the system)
<segmentID> integer Allows you to override the default API you are posting to. If posting to FreeRentalSite.com and you do not supply a segmentID it will default to 1. If posting to www.FreeRentalSite.com and you supply a segmentID of 2 then your ad will be posted to www.FreeCommercialSite.com. This will allow you to post Rental, Commercial, Real Estate, and Vacation Rental Ads in one feed. ***Note by overriding the default segmentID you will be validated against that site's API.
1 = www.FreeRentalSite.com
2 = www.FreeCommercialSite.com
3 = www.FreeRealEstateSite.com
4 = www.FreeVacationRentalSite.com
</metainfo>
<address>
<countryCode> X string(3) The country code of the property. E.g. United States = US. Please choose from a list below:
AU = Australia
BS = Bahamas
BD = Bangladesh
BM = Bermuda
BR = Brazil
BG = Bulgaria
CA = Canada
CN = China
CO = Colombia
CD = Democratic Republic of the Congo
DK = Denmark
EG = Egypt
ET = Ethiopia
FI = Finland
FR = France
DE = Germany
GR = Greece
IN = India
ID = Indonesia
IR = Iran
IE = Ireland
IT = Italy
JP = Japan
KE = Kenya
LT = Lithuania
MX = Mexico
ME = Montenegro
MM = Myanmar
NL = Netherlands
NZ = New Zealand
NG = Nigeria
NO = Norway
PK = Pakistan
PA = Panamá
PH = Philippines
PL = Polska
PR = Puerto Rico
QA = Qatar
RU = Russia
SG = Singapore
ZA = South Africa
KR = South Korea
ES = Spain
SE = Sweden
CH = Switzerland
TW = Taiwan
TZ = Tanzania
TH = Thailand
TR = Turkey
UA = Ukraine
AE = United Arab Emirates
GB = United Kingdom
US = United States
VN = Vietnam
<stateName> X string(50) The name of the State / Region / Province / Voivodship that the property is located in. E.g. "New York" is a State located in the United States of America. The <stateName> must be spelled exactly as it is found in our system. Select from the list below:
Select Your Country:
<cityName> X string(50) The name of the City / Town / Village that the property is located in. E.g. "Toronto" is a city located in Ontario, Canada.
<address> string(200) The primary address of the property. E.g. "123 Main Street"
<address2> string(200) The secondary address of the property. E.g. "Suite 202"
<address3> string(200) The tertiary address of the property. E.g. "Office space 5"
<postalCode> string(40) The postal code of the property. E.g. Poland: "32-015", Canada: "M4B 1C4", United States: "80918"
</address>
<adinfo>
<adTypeID> C integer Type of Ad being posted. Select an option below:
4 = Beach
5 = Golf
6 = Ski
7 = Luxury
8 = City
9 = Mountain
10 = Adventure
11 = Island
12 = Romantic
13 = Lake
14 = Family
<adTitle> X string(200) The title of the Ad.
<adDescription> X string(4000) The detailed description of the property / unit.
<moveInSpecial> string(500) A description of the current promotion being offered for this property / unit.
<websiteUrl> string(250) This is a permanent URL pointing to a webpage containing information regarding this property or your company.
***Only available for upgraded ads
<applicationUrl> string(250) This is a URL pointing to an online rental application.
<virtualTourUrl> string(250) This is a URL pointing to a webpage containing a virtual tour of the property / unit.
</adinfo>
<imginfo>
<deleteAllImages> boolean Allows you to delete all images attached to this ad. Will only be used when updating an existing ad.
0 = Don't Delete / Ignore Parameter
1 = Delete All Images
<urlString> string(4000) A comma seperated list of URL's for each Image to be attached to this Ad. These images will be downloaded to our server, resized / optimized for performance, and watermarked for security. We will also create a thumbnail to ensure our search results load quickly for the end user. In the example below you will see we have three images (House, Kitchen, Living Room):
http://www.freevacationrentalsite.com/images/samples/house.jpg, http://www.freevacationrentalsite.com/images/samples/kitchen.jpg, http://www.freevacationrentalsite.com/images/samples/livingRoom.jpg,
<captionString> string(4000) A comma seperated list of Captions for the Images being attached to this ad. Must have one comma / item per image even if the image doesn't have a caption. In the example below we have added a caption to our 1st and 3rd image, but not the 2nd:
View from the road, ,Living Room,
</imginfo>
<contactinfo>
<contactName> C string(200) The name of the person that will be listed as the contact on the ad.
<contactCompany> C string(200) The name of the company that will be listed as the contact on the ad.
<contactEmail> X string(150) Email address of the person / entity to contact. This will be used to send any correspondences from the contact button / lead form on the ad.
<licenseNbr> string(50) This is the licence number of the company / entity that is posting the ad.
<contactPhone1> string(40) Primary Contact Phone # displayed on the Ad.
<contactExt1> string(16) Primary Contact Phone's Extension
<contactName2> string(200) The name of the person that will be listed as the secondary contact on the ad.
<contactEmail2> string(150) Email address of the secondary person to contact. This will be used to send any correspondences from the contact button / lead form on the ad.
<contactPhone2> string(40) Secondary Contact Phone # displayed on the Ad.
<contactExt2> string(16) Secondary Contact Phone's Extension
</contactinfo>
<propertyinfo>
<propertyTypeID> X integer The type of property being listed. Must select one of the options below:
20 = Single Family House
21 = Townhouse
22 = Condo
23 = Bungalow
24 = Loft
25 = Cottage
26 = Cabin
27 = Hotel
28 = Bed & Breakfast
34 = Duplex
35 = Villa
<currencyTypeID> X integer The currency type for all financial fields of the ad. E.g.: Rent Amount / Purchase Price / Deposit / Taxes. Must select one of the options below:
1 = United States Dollar (USD)
2 = Canadian Dollar (CAD)
3 = Australian Dollar (AUD)
4 = New Zealand Dollar (NZD)
5 = Hong Kong Dollar (HKD)
6 = Euro (EUR)
7 = Japanese Yen (JPY)
8 = Pound Sterling (GBP)
9 = Swiss Franc (CHF)
10 = Swedish Krona (SEK)
11 = Norwegian Krone (NOK)
12 = Mexican Peso (MXN)
13 = Singapore Dollar (SGD)
14 = South Korean Won (KRW)
15 = Indian Rupee (INR)
16 = Chinese Yuan (CNY)
17 = Polish zloty (PLN)
18 = Israeli shekel (ILS)
19 = Singapore Dollar (SGD)
20 = Czech koruna (CZK)
21 = Danish krone (DKK)
22 = New Taiwan Dollar (TWD)
23 = Brazilian real (BRL)
24 = South African rand (ZAR)
25 = Indonesian Rupiah (IDR)
26 = Bangladeshi taka (BDT)
27 = Pakistani rupee (PKR)
28 = Nigerian naira (NGN)
29 = Russia Rubles (RUB)
30 = Panamanian Balboa (PAB)
31 = Iran Rials (IRR)
32 = Turkish Lira (TRY)
33 = Congolese Franc (CDF)
34 = Thailand Baht (THB)
35 = Myanma kyat (MMK)
36 = Philippine peso (PHP)
37 = Colombian peso (COP)
38 = Ukrainian hryvnia (UAH)
39 = Tanzanian shilling (TZS)
40 = Bulgarian lev (BGN)
41 = Singapore Dollar (SGD)
42 = Lithuanian litas (LTL)
43 = Bahamian dollar (BSD)
44 = East Caribbean Dollar (XCD)
45 = Kenyan shilling (KES)
<amount> X decimal(11,2) Rent Amount of the property being listed.
<amountMax> decimal(11,2) Maximum Rent Amount of the property being listed.
<rentFrequencyID> C integer The frequency at which the rent is collected. Must select one of the options below:
13 = Amt / Night
14 = Amt / Week
16 = Amt / Month
<deposit> decimal(11,2) The amount of the deposit according to the terms of the lease, or sale.
<depositText> string(100) A description of the deposit. This can be used instead of deposit if you would prefer to use text instead of a monetary value.
<beds> C integer The number of bedrooms the property has.
<area> C integer The area or size of the property. Eg. "2000" for 2000 sq. meters.
<cleaningFees> string(100) A description of any cleaning fees that pertain to this ad.
<checkInDetails> string(100) Any check-in / check-out details.
<uomID> C integer The unit of measurement for area / size of the property. Must select one of the options below:
1 = SqFt
2 = m²
<locatedNear> string(2000) The description of the surrounding area, including restaurants, stores, or other amendities near and/or accessible to this property.
<maxOccupancy> integer Maximum # of people this property is intended to sleep.
<minStayDuration> integer Minimum # of days the tenant must rent this property for.
<additionalFeeDescription> string(4000) A detailed description of any additional fees pertaining to this property.
</propertyinfo>
<restrictions>
<dog> boolean 0 = no dogs allowed
1 = dogs allowed
<cat> boolean 0 = no cats allowed
1 = cats allowed
<petDescription> string(400) Additional description of the pet policy for the property.
<smoking> boolean 0 = no smoking allowed (outside only)
1 = smoking allowed inside the property
</restrictions>
<features>
<featureString> string(4000) A comma seperated list of the features applicable to the property being listed (E.g.: 1,4,6,11,23,32,). Must select from the list below:
175 = Breakfast Nook
176 = Dishwasher
177 = Disposal
178 = Island
179 = Microwave
180 = Pantry
181 = Refrigerator
182 = Stove
349 = Coffee Maker
350 = Blender
183 = Ceramic Tile
184 = Hardwood Flooring
185 = Upgraded Carpet
186 = Linoneum
187 = Media Room
188 = Den
189 = Dining Room
190 = Finished Basement
191 = Living Room
192 = Recreation Room
193 = Study
194 = Unfinished Basement
195 = Utility Room
196 = Wet Bar
252 = Family room
253 = Foyer
348 = Screened Porch
370 = Games
396 = Video Games
397 = Central Air Conditioning
398 = DVD/VCR Player
399 = Stereo/CD Player
400 = Internet
401 = Pool Table
375 = Linens Provided
257 = Window coverings
258 = Telephone
259 = Intercom
347 = Elevator
242 = Dryer
243 = HD Television
244 = Dish Washer
245 = Refrigerator
246 = Freezer
247 = Stove / Range
360 = Housekeeper Available
361 = Chef Available
362 = Chauffer Available
363 = Child Care/Babysitting Available
197 = Air Conditioning
198 = Attic
199 = Blinds
200 = Books
201 = Satellite/Cable
202 = Ceiling Fan
203 = Central Vacuum
204 = Fireplace
205 = Furnishings
206 = Toys
207 = Heat
208 = Wi-Fi
209 = Intrusion Alarm
210 = Jetted Tub
211 = Scenic View
212 = Skylights
213 = Vaulted Ceilings
214 = Walk In Closets
215 = Washer / Dryer Hookups
216 = Washing Machine
217 = Waterfront Property
218 = Balcony
219 = Deck
220 = Fence
221 = Hot Tub
222 = Patio
223 = Pool
224 = Porch
225 = Sprinkler
226 = Storage
364 = Grill (gas/charcoal)
365 = Parking Off-Street
366 = Garage
367 = Beach Chairs
368 = Beach Towels
369 = Boat Dock/Slip
248 = Garden
249 = Back yard
250 = Front yard
251 = Plot
402 = Sundeck
403 = Outdoor Shower
405 = Basketball Goal
393 = Hammock
394 = Fish Cleaning Station
395 = Bicyles
254 = Coin laundry
255 = On site maintenance
256 = Recreation Center
227 = Access Gate
228 = Business Center
229 = Club House
230 = Elevator
231 = Golf
232 = Gym / Excercise room
233 = Handicap Access
234 = Jacuzzi
235 = Laundry
236 = Playground
237 = Pool
238 = Racquet Ball
239 = Storage
240 = Tennis
241 = Volleyball
351 = Walk to Beach
352 = On Beach
353 = Walk to Ski Lifts
354 = Ski In Ski Out
355 = Near Restaurants
356 = Near Hospital
357 = Near Theme/Amusement Parks
358 = Near Shopping
359 = On Shuttle Route
371 = Wheelchair Accessible
372 = Non-Smoking
373 = Elevator
374 = Child Safe
404 = Weddings
376 = Skiing
377 = Shopping
378 = Tennis
379 = Swimming
380 = Horseback Riding
381 = Hiking
382 = Cycling
383 = Fishing
384 = Golf
385 = Mountain Biking
386 = Rafting
387 = Gambling
388 = Scuba Diving
389 = Snorkeling
390 = Surfing
391 = Boating
392 = Jet Skiing
</features>
</ad>
</post>



RESPONSE XML
Req'd DataType Description
<response>
<errorCode> n/a integer Feed Level Error Code
0 = No Feed Level Errors
<errorDescription> n/a string(4000) A description of a feed level error. (ie: invalid xml)
<stats> n/a string(1000) Statistics for the feed. Ie: # of ads processed.
<ad>
<adID> n/a integer An output of our ad id that was generated. Only supplied if no errors encountered and not in test mode.
<errorCode> n/a integer The Error Code for this specific ad.
0 = No Errors Encountered
<errorMsg> n/a string(4000) A description of the error for this specific ad.
</ad>
</response>





Copyright © 2017, FreeRentalSite. All Rights Reserved  |   Site Map  |   Our Blog