|  Login  |   Support  |


Post / Update Ad API

Post Url:   http://www.freerealestatesite.com/post/
Secure Post Url:   https://www.freerealestatesite.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>
<mlsNbr> string(50) The reference number if this ad is listed on the Multiple Listing Service.
<adTitle> X string(200) The title of the Ad.
<adDescription> X string(4000) The detailed description of the 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.freerealestatesite.com/images/samples/house.jpg, http://www.freerealestatesite.com/images/samples/kitchen.jpg, http://www.freerealestatesite.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:
12 = Single Family House
13 = Townhouse
14 = Condo
15 = Apartment
16 = Loft
17 = Multiplex
18 = Land
19 = Mobile Home
33 = Duplex
<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) Purchase Price of the property being listed.
<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.
<baths> C decimal(3,1) The number of bathrooms the property has.
|   1   |   1.5   |   2   |   2.5   |   3   |   3.5   |   4   |   4.5   |   5   |   5.5   |   6   |   6.5   |   7   |   7.5   |   8   |   8.5   |   9   |   9.5   |   10   |   
<area> C integer The area or size of the property. Eg. "2000" for 2000 sq. meters.
<uomID> C integer The unit of measurement for area / size of the property. Must select one of the options below:
1 = SqFt
2 = m²
<floors> integer The number of floors the property has.
<yearBuilt> integer The year that the property was built.
<taxes> decimal(11,2) The estimated yearly tax amount for the property being listed.
<lotSize> string(50) The size of the lot that the property is on.
<garageSize> string(50) The size of the garage. Must select one of the options below:
0 = No Garage
1 = 1 Car Garage
1.5 = 1.5 Car Garage
2 = 2 Car Garage
2.5 = 2.5 Car Garage
3 = 3 Car Garage
3.5 = 3.5 Car Garage
4 = 4 Car Garage
4.5 = 4.5 Car Garage
5 = 5 Car Garage
5.5 = 5.5 Car Garage
6 = 6 Car Garage
6.5 = 6.5 Car Garage
7 = 7 Car Garagee & up
<locatedNear> string(2000) The description of the surrounding area, including restaurants, stores, or other amendities near and/or accessible to this property.
<schools> string(2000) The description of the school system for this property. Either School district name, or school system options available. May also list individual schools.
<securityDescription> string(2000) The description of any security systems that are available or provided on the property.
</propertyinfo>
<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:
90 = Breakfast Nook
91 = Dishwasher
92 = Disposal
93 = Island
94 = Microwave
95 = Pantry
96 = Refrigerator
97 = Stove
296 = Coffee Pot
297 = Electric Tea Kettle
298 = Lazy Susan
299 = Oven
300 = Marble Flooring
421 = Laminate Flooring
422 = Parquet Flooring
98 = Ceramic Tile
99 = Hardwood Flooring
100 = Carpet
101 = Linoneum
102 = Crawlspace
103 = Den
104 = Dining Room
105 = Finished Basement
106 = Living Room
107 = Recreation Room
108 = Study
109 = Unfinished Basement
110 = Utility Room
111 = Wet Bar
301 = Family Room
302 = Foyer
303 = Kitchenette
304 = Guest Suite
305 = Office
306 = Floor to Ceiling windows
307 = Television
308 = Secure Controled Access
309 = Concierge / Doorman
310 = Window Coverings
311 = Telephone
312 = Intercom
313 = High Speed Internet
314 = Cable
315 = Furniture
316 = Infloor heating
317 = Window Security Blinds
318 = Washing Machine
319 = Dryer
320 = Maid Service
537 = Solar Panels
112 = Air Conditioning
113 = Attic
114 = Blinds
115 = Book Shelf
116 = Cable Ready
117 = Ceiling Fan
118 = Central Vacuum
119 = Fireplace
120 = Furnishings
121 = Handicap Access
122 = Heat
123 = Internet Ready
124 = Intrusion Alarm
125 = Jetted Tub
126 = Scenic View
127 = Skylights
128 = Vaulted Ceilings
129 = Walk In Closet(s)
130 = Washer / Dryer Hookups
131 = Washer and Dryer
132 = Waterfront Property
133 = Balcony
134 = Deck
135 = Fence
136 = Hot Tub
137 = Patio
138 = Pool
139 = Porch
140 = Sprinkler
141 = Storage
538 = Solar Panels
321 = Garden
322 = Back yard
323 = Front yard
324 = Plot
325 = Courtyard
326 = Barbeque
327 = Pond
328 = Greenhouse
329 = Sundeck
330 = Dock
331 = Coin Laundry
332 = On site Maintenance
333 = Media Room
334 = Sauna
335 = Social Room
336 = Indoor Pool
337 = Indoor Parking
338 = Heated Parking
339 = Billards / Pool table
340 = Party Room
341 = Spa
342 = Conference Room
343 = Library
344 = Computer room
345 = Movie Theatre
346 = Steam room
142 = Access Gate
143 = Business Center
144 = Club House
145 = Elevator
146 = Golf
147 = Gym
148 = Handicap Access
149 = Jacuzzi
150 = Laundry
151 = Playground
152 = Pool
153 = Racquet Ball
154 = Storage
155 = Tennis
156 = Volleyball
</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