 |
AllSpaces.com’s RSS Feed Details |
- Are you a property manager, landlord or realtor who manages many units?
-
Do you want a quick & easy way to post your available rentals on AllSpaces.com?
- Do you want to be able to keep all of your rental ads up to date?
Our listing feed is based on the RSS 2.0 XML format. This is the standard format used for data publication and broadcasting on the Internet today. It is used by podcasters, media outlets, and other such organizations who regularly publish data to the Internet. As a property manager, landlord or realtor you have data (vacancy listings) to publish, and this standard along with the AllSpaces enhancements explained below, is an excellent way to do it. For more information about RSS, please review this article: RSS 2.0 at Harvard Law
In order to publish your feed to AllSpaces.com, you will need to meet the following requirements:
- The ability to create a valid XML file in the appropriate format using your existing database and systems. This document explains the XML format, fields, and acceptable values but does not explain generation of the file. Please consult with your IT professional about how to produce this file.
- The ability to publish your feed to a publicly available URL.
|
AllSpaces.com Feed Creation Instructions
Section #1: AllSpaces.com’s Feed Format |
|
|
We have our XML format based upon the format Google is using for their RSS feeds to Google Base. If you have an existing Google Base RSS 2.0 feed you may use that feed with few alterations. However, the AllSpaces file format offers several additional features to enhance your ads.
Besides the additional features use in the AllSpaces format, there are a couple of significant differences from the Google Base RSS feed.
- <g:location> vs. <allspaces:streetnumber> / <allspaces:streetname> / <allspaces:city> / <allspaces:zipcode>
Google uses a single field to specify the address of the listing. The Allspaces.com format uses three fields that are used to place your listing in the correct neighborhood in our listings. Of these, only the <allspaces:zipcode> field is required. The <allspaces:city> field can be used to clarify the exact location of the listing. The <allspaces:streetnumber> field is optional. The exact locations of your vacancies are not displayed on the website for tenants to view. For more information on these fields, see the table of fields below.
Section #2: Example of a Basic Ad
Below is a sample document containing a single listing. This file includes the minimum required fields.
The first two lines specify that this is an XML document using the RSS 2.0 standard. The xmlns:allspaces specification in the second line specifies the namespace for the fields that are specific to the AllSpaces feed format and begin with "allspaces:".
The "channel" field, which wraps the rest of the RSS document holds one or more "item" fields. Each of these items represnts a listing and contains fields that specifies the details of the listing.
Section #3: Available Fields & Values
|
| <guid> |
| Required Field |
This must be a UNIQUE ID for each Listing.
Max: 50 characters.
Value: text
Example: <guid>ABC-100051</guid> |
| |
| <title> |
Headline that will appear in the ad.
Max: 200 characters.
Value: text
Example: <title>Beautiful two story 3 bedroom house</title> |
| |
| <description> |
This is the comment section of the ad. This text will be used to explain the extra details of your ad.
Max: 1,600 characters
Value: text
Example: <description>This apartment has all new appliances, new carpet, new paint, ceiling fans, and network wiring throughout. Close to schools, shopping, and restaurants.</description> |
| |
| <allspaces:num_rooms> |
The number of rooms in the rental.
Value: number
Example: <allspaces:num_rooms>2</allspaces:num_rooms> |
| |
| <allspaces:num_bathrooms> |
| Required Field |
The number of bathrooms in the rental.
Value: number
Example: <allspaces:num_bathrooms>1.5</allspaces:num_bathrooms> |
| |
| <allspaces:num_bedrooms> |
| Required Field |
The number of bedrooms in the rental.
Value: number
Example: <allspaces:num_bedrooms>2</allspaces:num_bedrooms> |
| |
| <allspaces:num_kitchen> |
| Required Field |
The number of kitchens in the rental.
Value: number
Default: 1
Example: <allspaces:num_kitchen>2</allspaces:num_kitchen> |
| |
| <allspaces:spacetype> |
| Required Field |
This is the rental type.
Following are the accepted values :
- 1 for Apartment in Building
- 2 for Apartment in House
- 3 for Apartment in Complex
- 4 for Condo
- 5 for Co-op
- 6 for Cottage
- 7 for Duplex
- 8 for Room For Rent
- 9 for House Share
- 10 for Mobile Home
- 11 for Whole House
- 12 for Townhouse
- 13 for Vacation House
Value: Number
Example: <allspaces:spacetype>4</allspaces:spacetype> |
| |
| <allspaces:ownertype> |
This is the type of owner who owns or manages the rentals on this feed (Ex: Management Company, Private Owner, Real Estate Broker).
Following are the accepted values :
- Management Company
- Private Owner
- Real Estate Broker
Value: text
Example: <allspaces:ownertype>Private owner</allspaces:ownertype> |
| |
| <allspaces:StreetName> |
| Required Field |
The Street Name where the rental is located.
Value: text
Example: <allspaces:StreetName>Western Highway </allspaces:StreetName> |
| |
| <allspaces:StreetNumber> |
The is the number character in the address of the property.
Value: Number
Example: <allspaces:StreetNumber>123</allspaces:StreetNumber> |
| |
| <allspaces:StreetSuffix> |
The street suffix where the rental is located.
Value: Text
Example: <allspaces:StreetSuffix>Ave</allspaces:StreetSuffix> |
| |
| <allspaces:City> |
| Required Field |
The City where the rental is located.
Value: text
Example: <allspaces:City>Downtown Seattle</allspaces:City> |
| |
|
| <allspaces:County> |
The County where the rental is located.
Value: text
Example: <allspaces:county>Queen</allspaces:county> |
| |
| <allspaces:State> |
| Required Field |
The State where the rental is located.
Value: text
Example: <allspaces:State>WA</allspaces:State> |
|
|
| <allspaces:Zip> |
| Required Field |
The Zip Code where the listing is located.
Value: text
Example: <allspaces:Zip>98121</allspaces:Zip> |
| |
| <allspaces:CrossStreetName> |
| Required Field |
The Cross Street name where the rental is located
Value: text
Default: Unknown
Example: <allspaces:CrossStreetName>crossRoad</allspaces:CrossStreetName> |
| |
| <allspaces:ComplexName> |
The Complex/Building Name of the rental.
Value: text
Example: <allspaces:ComplexName>Renting House</allspaces:ComplexName> |
| |
| <allspaces:rent> |
| Required Field |
The rent price of the rental.
Value: text
Example: <allspaces:rent>1000.00</allspaces:rent> |
| |
| <allspaces:rentfrequency> |
The frequency the rent is paid.
Following are the accepted values :
- 1 for Per Day
- 2 for Per Week
- 3 for Per Month
- 4 for Per Season
Value: number
Example: <allspaces:rentfrequency>3</allspaces:rentfrequency> |
| |
|
|
| <allspaces:status> |
The status of the rental. Value: text
Default: For Rent
Example: <allspaces:status>For Rent</allspaces:status> |
| |
| <allspaces:site_name> |
The website name the rentals are coming from. Value: text
Example: <allspaces:site_name>eliterenting.com</allspaces:site_name> |
| |
| <allspaces:link> |
The URL which links to the specific ad on the site the rentals are coming from. Value: text
Example: <link>http://www.Allspaces.com/RRdetail.asp?sid=134567</link> |
| |
| <allspaces:agent_firstname> |
| Required Field |
The first name of the landlord of the rental. This is a required field so if needed you can insert any name that you want to use. Value: text
Example: <allspaces:agent_firstname>Eric</allspaces:agent_firstname> |
| |
| <allspaces:agent_lastname> |
| Required Field |
The last name of the landlord of the rental. This is a required field so if needed you can insert any name that you want to use. Value: text
Example: <allspaces:agent_lastname>Goldstein</allspaces:agent_lastname> |
| |
| <allspaces:agent_email> |
| Required Field |
The email address of the person who will be in charge of the tenant inquiries made online. Value: text
Example: <allspaces:agent_email>info@eliterenting.com</allspaces:agent_email> |
| |
| <allspaces:agent_phone> |
| Required Field |
The phone number of the person who will be answering the calls from interested tenants. Value: text
Example: <allspaces:agent_phone>516-798-1600</allspaces:agent_phone> |
| |
| <allspaces:image1>,<allspaces: image2>, <allspaces:image3>, <allspaces:image4>, <allspaces:image5>, <allspaces:image6 > |
The photos of the rental. You can send a max of 6 photos for each rental. Value: text
Example:
<allspaces:image1><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/1.jpg]]></allspaces:image1>
<allspaces:image2><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/2.jpg]]></allspaces:image2>
<allspaces:image3><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/3.jpg]]></allspaces:image3>
<allspaces:image4><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/4.jpg]]></allspaces:image4>
<allspaces:image5><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/5.jpg]]></allspaces:image5>
<allspaces:image6><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/6.jpg]]></allspaces:image6> |
|
| |
| <allspaces:image7>, <allspaces:image8>, <allspaces:image9> |
The photos of the floor plan in the rental. You can send a max of 3 photos.
Value: text
Example:
<allspaces:image7><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/7.jpg]]></allspaces:image7>
<allspaces:image8><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/8.jpg]]></allspaces:image8>
<allspaces:image9><![CDATA[http://www.allspaces.com/images/community_images/800x600/42/792/9.jpg]]></allspaces:image9> |
|
| |
| <allspaces:pets> |
Does this rental accept Pets?
Accepted values :
Value: Number
Example: <allspaces:pets>1</allspaces:pets> |
|
| |
| <allspaces:Smoking> |
Is Smoking allowed in this Rental?
Accepted values :
Value: Number
Example: <allspaces:Smoking>0</allspaces:Smoking> |
|
| |
| <allspaces:BuyOption> |
Is there an option to buy this property?
Accepted values :
Value: Number
Example: <allspaces:BuyOption>0</allspaces:BuyOption> |
|
| |
| <allspaces:Elevators> |
Are there elevators in this rental?
Accepted values :
Value: Number
Example: <allspaces:Elevators>1</allspaces:Elevators> |
|
| |
| <allspaces:Intercom> |
Is there an intercom in this rental?
Accepted values :
Value: Number
Example: <allspaces:Intercom>1</allspaces:Intercom> |
|
| |
| <allspaces:Thermostat> |
Is there a private thermostat in this rental?
Accepted values :
Value: Number
Example: <allspaces:Thermostat>1</allspaces:Thermostat> |
|
| |
| <allspaces:cathedralceiling> |
Are there cathedral ceilings in this rental?
Accepted values :
Value: Number
Example: <allspaces:cathedralceiling>1</allspaces:cathedralceiling> |
|
|
| |
| <allspaces:Lighting> |
Is there outdoor lighting for this rental?
Accepted values :
Value: Number
Example: <allspaces:Lighting>1</allspaces:Lighting> |
|
| |
| <allspaces:Closets> |
Are there closets in this rental?
Accepted values :
Value: Number
Example: <allspaces:Closets>1</allspaces:Closets> |
|
| |
| <allspaces:CableReady> |
Is this rental cable ready?
Accepted values :
Value: Number
Example: <allspaces:CableReady>1</allspaces:CableReady> |
|
| |
| <allspaces:Furnished> |
Is this rental furnished?
Accepted values :
Value: Number
Example: <allspaces:Furnished>1</allspaces:Furnished> |
|
| |
| <allspaces:Electric> |
Is the electric included for this rental?
Accepted values :
- 0 for not included
- 1 for included
Value: Number
Example: <allspaces:Electric>1</allspaces:Electric> |
|
| |
| <allspaces:Water> |
Is the water included for this rental?
Accepted values :
- 0 for not included
- 1 for included
Value: Number
Example: <allspaces:Water>1</allspaces:Water> |
|
| |
| <allspaces:Cable> |
Is the cable included for the rental price?
Accepted values :
- 0 for not included
- 1 for included
Value: Number
Example: <allspaces:Cable>1</allspaces:Cable> |
|
|
|
| <allspaces:Internet> |
Is internet service included for this rental?
Accepted values :
- 0 for not included
- 1 for included
Value: Number
Example: <allspaces:Internet>1</allspaces:Internet> |
|
| |
| <allspaces:Refrigerator> |
Is there a refrigerator included in this rental?
Accepted values :
Value: Number
Example: <allspaces:Refrigerator>1</allspaces:Refrigerator> |
|
| |
| <allspaces:Stove> |
Is there a stove included in this rental?
Accepted values :
Value: Number
Example: <allspaces:Stove>1</allspaces:Stove> |
|
| |
| <allspaces:Microwave> |
Is there a microwave included in this rental?
Accepted values :
Value: Number
Example: <allspaces:Microwave>1</allspaces:Microwave> |
|
| |
| <allspaces:Dishwasher> |
Is there a dishwasher included in this rental?
Accepted values :
Value: Number
Example: <allspaces:Dishwasher>1</allspaces:Dishwasher>
|
|
|