|  Login  |   Support  |


Post / Update Ad API

Post Url:   http://www.freecommercialsite.com/post/
Secure Post Url:   https://www.freecommercialsite.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
KN = Saint Kitts and Nevis
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:
1 = Sale
2 = Lease
3 = Sub-Lease
<adTitle> X string(200) The title of the Ad.
<adDescription> X string(4000) The detailed description of the property / unit.
<moveInSpecial> string(500) The description of any current move-in specials offered for this property / unit. (Only applies to leases and sub-leases)
<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.freecommercialsite.com/images/samples/house.jpg, http://www.freecommercialsite.com/images/samples/kitchen.jpg, http://www.freecommercialsite.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
<managingAgent> string(500) The name of the managing agent to contact for more information regarding this ad.
<buildingOwner> string(500) The name of the person / entity that ownes the building.
</contactinfo>
<propertyinfo>
<propertyTypeID> X integer The type of property being listed. Must select one of the options below:
7 = Industrial
8 = Office
9 = Retail
10 = Medical
11 = Warehouse
29 = Land
36 = RV Park
37 = Mini Storage
38 = Mobile Home
<multiUnit> boolean Ad is a Multi Unit Listing. Allows you to supply a range of values for Rent / Deposit / Area / Beds / Baths. Note: If not supplied this will default to 0 for single unit listing.
0 = NOT a Multi Unit Listing. Single Unit Listing Only
1 = Multi Unit Listing
<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 for all properties being sold & Rent Amount of all properties for lease or sub-lease.
<amountMax> decimal(11,2) Maximum Rent Amount of the property being listed (Only applies to leases and sub-leases).
For Multi Unit Listing Only
<leaseTypeID> integer The type of lease being offered. (Only applies to leases and sub-leases). Must select one of the options below:
1 = Full Service
7 = Gross
5 = Industrial Gross
3 = Modified Gross
4 = Modified Net
2 = NNN
6 = Other
<rentFrequencyID> C integer The frequency at which the rent is collected (Only applies to leases and sub-leases). Must select one of the options below:
9 = Amt / SqFt / Month
10 = Amt / SqFt / Year
11 = Amt / Month
12 = Amt / Year
<deposit> decimal(11,2) The amount of the deposit according to the terms of the lease, or sale.
<depositMax> decimal(11,2) Maximum Deposit Amount for the property being listed (Only applies to leases and sub-leases).
For Multi Unit Listing Only
<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.
<applicationFee> decimal(11,2) The fee amount that is required to apply for the property being listed.
<area> C integer The area or size of the property. Eg. "2000" for 2000 sq. meters.
<areaMax> integer The max area or size of the property. Eg. "2000" for 2000 sq. meters (Only applies to leases and sub-leases)..
For Multi Unit Listing Only
<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.
<ceilingHeight> string(200) The properties ceiling height.
<locatedNear> string(2000) The description of the surrounding area, including restaurants, stores, or other amendities near and/or accessible to this property.
<securityDescription> string(2000) The description of any security systems that are available or provided on the property.
</propertyinfo>
<leaseinfo>
<availabilityDate> date (yyyymmdd) The date that the property is available to move into.
<sectionEight> boolean Is section 8 housing assistance accepted?
0 = No Accepted
1 = Accepted
[empty] = Ignore / Not Applicable
<sectionEightArea> string(100) The Section 8 Governing Area
<leaseDescription> string(2000) The decription of the lease terms available. Doesn't Apply to Properties for Sale.
<currentCondition> string(500) The description of the current condition of the property. Doesn't Apply to Properties for Sale.
<workLetter> string(500) The description of the work letter or any allowances, which includes any information pertaining to the build out of the property. Doesn't Apply to Properties for Sale.
<tenantMix> string(2000) General description of the surrounding tenants occupying other units.
<camFeeDescription> string(1000) The description of the Common Area Maintenace charges, including any charges the tenant will have to pay for concerning community space.
</leaseinfo>
<utilities>
<gas> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<electric> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<water> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<sewage> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<garbage> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<lawn> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<cable> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<internet> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<phone> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<heat> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<snow> boolean Doesn't Apply to Properties for Sale.
0 = tenant pays
1 = included in rent
<noUtilities> boolean Doesn't Apply to Properties for Sale.
0 = not set
1 = NO UTILITIES are included in rent
<heatType> string(50) Type of heating (gas, electric)
</utilities>
<parking>
<spaceCount> integer # of Surface Spaces for this Property (whole numbers only ie: 1, 2, 3)
<coveredCount> integer # of Structure Spaces for this Property (whole numbers only ie: 1, 2, 3)
<garageCarCount> integer # of Underground Spaces for this Property (whole numbers only ie: 1, 2, 3)
<parkingCost> string(200) The description of any charges associated with parking. Doesn't Apply to Properties for Sale.
</parking>
<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:
68 = Bathroom In Suite
69 = Elevator
70 = Tended Lobby
71 = Cafeteria
72 = Vending Machines
73 = Security Surveillance
74 = Janitorial
75 = Conceirge
76 = Package Drop Off
77 = Kitchen in Building
78 = Break Room
79 = Coffee Bar
80 = Scenic View
81 = Public Transportation Access
82 = Designated Smoking Area
83 = Handicaped Accessible
84 = Emergency Power Backup
85 = Bathroom in Building
86 = Shower Facilities
87 = Exercise Facility
88 = Medical Facilities
89 = Kitchen in Suite
</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