UK Business Property RSS Module 1.1

Authors

The author of this spec:

This email address is being protected from spambots. You need JavaScript enabled to view it., UK Business Property

Version

Latest Version: http://www.ukbusinessproperty.co.uk/rss/1.1/

Status

Draft

Requirements

The RSS feed generator should accept the following GET parameters:

  • date (strongly recommended)
    A numeric timestamp representing the seconds since the UNIX Epoch.
    The properties returned should only be those modified on or after this timestamp.

  • limit (optional)
    An integer representing the maximum number of property entries to return.

  • offset (optional)
    An integer representing how many property entries to skip over.
    This is used in combination with limit for RSS feeds that would otherwise contain a large number of entries. This helps reduce server load by obtaining the updates gradually.

Notes

For each item the guid field must be completed with a unique value for the property.
This value may be alphanumeric and must always be used when providing updates to the property

The pubDate should be the last modified date of the property entry conforming to RFC 822
The description entry is optional and if used should be a short description or name of the property.

Any element that is specified but has no value will set that data to null
If an element is not specified it is ignored any old data for it shall remain

Description

Provides UK Business Property specific metadata for entries.

agentid
An optional string identifying a particular agent this property belongs to.

status
The "current status" for this entry, as text.
It may be specified as one and only one of the following types:

  • inactive - property is not available on the site but data should be retained
  • active - property is visible on the site
  • expired - property information is out of date and should not be shown
  • deleted - property information should be deleted from system

expires
The expiry date for this entry, as text or integer.
A text entry should conform to RFC 822
E.g. Wed, 12 Jul 2006 11:21:03 GMT
Alternatively this may be expressed as the number of seconds since the UNIX Epoch.
E.g. 1152705856

address
A container block for address information. The address is that as used for postal purposes.
The following child elements are defined...

  • no
    A number (letters permitted) representing the property number for postal purposes, as text.

  • name
    A name given to the property by the occupier, as text.

  • street
    The name of the street or road upon which the property is located, as text.

  • district
    Additional line to the address usually denoting a district or village, as text.

  • town
    Name of the town in which the property is located or nearest to, as text.

  • county
    Name of the county the town is within, as text.

  • country
    The ISO 3166 country code for the country the property is in, as text.

  • confidential
    For hiding precise location details of the property from visitors. Only the County and Region is displayed when this is set. Should be set as 1 to hide address and 0 to show it. Default is 0.

scheme
Specifies the name of the scheme the property is developed under, as text
Typically only applies to properties under construction.

size
A container block for property size information.
The following child elements are defined...

  • total
    The total property size, as an integer or floating point number.

  • minimum
    The smallest size available for purchase or rent, typically applies to office space, an integer or floating point number.

  • unit
    Units the sizes are measured in, as any one of the following:

    • square_meter
    • square_foot
    • hectare
    • acre

price
A container block for property price information.
The following child elements are defined...

  • sale
    The property selling price, as an integer or floating point number.
    If the type is auction, the value should represent a guide price.
    Also the expiry date for the property should be set to the date of the auction.
    Has the optional attribute typewhich may be:

    • region - Offers considered in the region of the sale price
    • excess - Offers should be in excess of the sale price
    • tender - People should make their best offer
    • auction - Property will be soled at auction on date in <ukbp:expires>
  • rent
    A container block for property rental information.
    The following child elements are defined...

    • amount
      The total property size, as an integer or floating point number.

    • unit
      Used to express the rental amount as per area. E.g. £200 per sq. ft
      The following units are defined:

      • square_meter
      • square_foot
      • hectare
      • acre
    • period
      Used to express the rental amount as per time. E.g £200 per week.
      May be used along with unit to express an amount per area per time.
      The following units are defined:

      • annum
      • month
      • fortnight
      • week
      • day
  • currency
    The currency the values are expressed in represented as ISO 4217 standard.

yield
Specifies the expected yield from the property, as a floating point number.
Has the attribute typewhich may be:

  • fixed - Yield is a fixed sum
  • percent - Yield is a percentage of the value

detail
Provides detailed information on the property, as text.

property_status
Specifies the current status of the property, the following are defined:

  • offer
  • part_let
  • construction
  • pre_let

tenures
Tenures is a container for a list of tenures that apply to the property.
It may consist of any number of the following element:

  • tenure
    A tenure is defined as being any one of the following:

    • freehold
    • leasehold

categories
Categories is a container for a list of categories that apply to the property.
It may consist of any number of the following element:

  • category
    A category is defined as being any one of the following:

    • assignment
    • business_sale
    • development
    • investment
    • let
    • sale

types
Types is a container for a list of property types that may apply to the property.
In some cases such a field may not be stored in a database, in this scenario it is suggested that a lookup table is create for keywords. These should be checked for in the property description and mapped on to the elements below.
It may consist of any number of the following element:

  • type
    A type is defined as being any one of the following:

    • business_park
    • caravan_park
    • cinema
    • country_property
    • day_nursery
    • farm
    • garden_centre
    • golf
    • hotel
    • industrial_other
    • industrial_warehouse
    • industrial_distribution
    • land
    • leisure_park
    • leisure_other
    • mixed
    • motor_station
    • motor_showroom
    • newsagents
    • non_residential_institution
    • nursing_home
    • office
    • other
    • pub
    • residential
    • restaurant
    • retail_high_street
    • retail_shopping_centre
    • retail_out_town
    • retail_other
    • rural_business
    • serviced_office
    • self_storage
    • rural_business
    • takeaway
    • technology
    • trade_park

business
Business is a container for a list of business types that may apply to a business for sale.
In some cases such a field may not be stored in a database, in this scenario it is suggested that a lookup table is create for keywords. These should be checked for in the property description and mapped on to the elements below.
It may consist of any number of the following element:

  • type
    A type is defined as being any one of the following:

    • agriculture - Agriculture
    • agriculture_farm - Farm
    • agriculture_forrestry - Forrestry
    • agriculture_horticulture - Horticulture
    • agriculture_mining - Mining & Quarrying
    • agriculture_supplies_services - Agricultural Supplies & Services
    • care - Care
    • care_child - Child Care & Nurseries
    • care_clinic - Clinic
    • care_disability - Disability Related
    • care_domiciliary - Domiciliary
    • care_foster - Fostering Related
    • care_home - Care Homes
    • care_laboratory - Laboratory
    • care_nursing - Nursing Home
    • care_pet - Pet Care
    • care_treatment - Treatment Related
    • engineering - Engineering
    • engineering_civil - Civil Engineers
    • engineering_engineering - Engineering
    • engineering_fabrication - Fabrication
    • engineering_machinery - Machinery & Metal
    • engineering_measurement - Measurement & Instrumentation
    • engineering_plastic - Plastic Fabrication
    • engineering_toolmaker - Toolmakers & Precision
    • food - Food
    • food_bakers - Bakers & Confectioners
    • food_catering - Catering Services
    • food_drink - Food & Drink
    • food_food - Food
    • food_mexican - Mexican Restaurant
    • food_middle_east - Middle Eastern Restaurant
    • food_pizza - Pizza Delivery
    • food_restaurant_asian - Asian Restaurant
    • food_restaurant_chinese - Chinese Restaurant
    • food_restaurant_coffee - Coffee Shop
    • food_restaurant_european - European Restaurant
    • food_restaurant_fastnotfranchise - Fast Food - Non Franchise
    • food_restaurant_fishchip - Fish & Chip Shop
    • food_restaurant_greek - Greek Restaurant
    • food_restaurant_indian - Indian Restaurant
    • food_restaurant_italian - Italian Restaurant
    • food_restaurant_pizza - Pizza Restaurant
    • food_restaurant_seafood - Sushi / Seafood Restaurant
    • food_sandwich - Sandwich Shop & Delivery
    • food_shop_bagel - Bagel Shops
    • food_smoothie - Smoothie & Yogurt Bar
    • food_snack - Snack Bar
    • franchise - Franchise Resales
    • franchise_fastfood - Fast Food Franchise
    • franchise_leisure - Leisure Franchise Resale
    • franchise_resales - Food Franchise Resale
    • franchise_service - Service Franchise Resale
    • leisure - Leisure
    • leisure - Amusement Parks & Arcade
    • leisure_bar - Bar
    • leisure_bistro - Bistro
    • leisure_bowling - Bowling Club
    • leisure_cafebar - Café Bar
    • leisure_camping - Camping & Caravan Park
    • leisure_casino - Casino
    • leisure_cinema - Cinema
    • leisure_diner - Diner
    • leisure_entertainment - Entertainment
    • leisure_fun - Entertainment & Fun
    • leisure_health_club - Health & Fitness Club
    • leisure_health_farm - Health Farm
    • leisure_holiday - Holiday Related Premise
    • leisure_holiday_resort - Holiday Resort
    • leisure_horse - Horse Riding
    • leisure_hotair - Hot Air Balloon
    • leisure_hotel - Hotel & Holiday Accommodation
    • leisure_museum - Art Galleries & Museum
    • leisure_nightclub - Nightclub
    • leisure_pub - Pub Premises
    • leisure_recreation - Recreation
    • leisure_restaurant - Restaurant
    • leisure_snooker - Snooker & Pool Centre
    • leisure_social - Social Club
    • leisure_spa - Spa
    • leisure_sports - Sports Centre
    • leisure_tanning - Tanning Salon
    • leisure_tearoom - Tea Room
    • leisure_tennis - Tennis Club
    • leisure_theatre - Theatre
    • leisure_themepark - Theme Park
    • leisure_tourism - Tourism Related, Gardens, Zoo
    • manufacturing - Manufacturing
    • manufacturing_boat - Boat Builders & Repair
    • manufacturing_ceramics - Ceramics Stone & Clay Products
    • manufacturing_chemicals - Chemicals & Allied Products
    • manufacturing_clothing - Clothing & Footwear Manufacturer
    • manufacturing_electrical - Electrical Appliance Manufacturer
    • manufacturing_food - Food & Drink Manufacturer
    • manufacturing_furniture - Furniture Manufacturer
    • manufacturing_glass - Glass Products Manufacturer
    • manufacturing_house - House & Garden Products Manufacturer
    • manufacturing_industrial - Industrial
    • manufacturing_it - I.T. Manufacturing
    • manufacturing_kitchen - Kitchen & Bedroom Manufacturer
    • manufacturing_leather - Leather & Leather Products
    • manufacturing_medical - Medical Products Manufacturer
    • manufacturing_metal - Metal Products Manufacturer
    • manufacturing_sport - Sport Equipment Manufacturer
    • manufacturing_wood - Wood Products Manufacturer
    • retail - Retail
    • retail_beauty - Health & Beauty Supply
    • retail_boats - Boats
    • retail_carpet - Carpet & Flooring
    • retail_carpetclean - Carpet Cleaning Equipment
    • retail_carsales - Car Sales - New & Used
    • retail_clothing - Clothing
    • retail_clothing_children - Childrens Wear
    • retail_clothing_mens - Mens Wear
    • retail_clothing_school - School Uniform
    • retail_clothing_tailor - Tailor
    • retail_clothing_womens - Ladies Wear
    • retail_crafts - Crafts & Hobbies
    • retail_curtains - Curtains & Window Dressings
    • retail_diy - DIY Related
    • retail_electrical - Electrical Appliance Retailer
    • retail_finance - Credit & Finance Company
    • retail_fishing - Fishing & Related
    • retail_fishmonger - Fishmonger
    • retail_florist - Florist
    • retail_food_specialist - Specialist Food
    • retail_garden - Garden Centre
    • retail_grocer - Grocer
    • retail_hardware - Hardware Store
    • retail_home_accessories - Home Accessories
    • retail_home_furniture - Furniture & Home Furnishing
    • retail_home_garden - Home & Garden
    • retail_home_softfurnishing - Soft Furnishing
    • retail_icecream - Ice Cream Parlour
    • retail_jeweller - Jeweller
    • retail_kitchen - Kitchen Related
    • retail_mailorder - Mail Order
    • retail_military - Military
    • retail_motorcycle - Motor Cycle Related
    • retail_office_furniture - Office Furniture
    • retail_offlicence - Liquor Store / Off Licence / Wine Merchant
    • retail_party - Party
    • retail_petrol - Petrol Service Station
    • retail_pharmacy - Drug Store / Pharmacy
    • retail_postoffice - Post Offices
    • retail_rental_video - Video / DVD Rental
    • retail_shop_antique - Antique & Art Shop
    • retail_shop_bargain - Bargain Store
    • retail_shop_bicycle - Bicycle Shop
    • retail_shop_book - Book Shop
    • retail_shop_bridalwear - Bridal Wear Shop
    • retail_shop_butcher - Butcher
    • retail_shop_convenience - Convenience Store
    • retail_shop_cosmetic - Cosmetic Store
    • retail_shop_deli - Delicatessen
    • retail_shop_gift - Card & Gift Shop
    • retail_shop_healthfood - Health Food Shop
    • retail_shop_hifi - TV, Video & Hi Fi Shop
    • retail_shop_music - Music Shops
    • retail_shop_newsagents - Newsagents
    • retail_shop_pet - Pet Shops
    • retail_shop_phone - Phone Shops
    • retail_shop_photo - TV, Audio, Video & Photographic
    • retail_shop_shoe - Shoe Shops
    • retail_shop_sports - Sports Shop
    • retail_shop_toy - Toy Shop
    • retail_shop_tv - TV & Radio
    • retail_shop_videogames - Video Games Store
    • retail_ski - Ski & Related
    • retail_supermarket - Supermarket
    • retail_swimming - Swimming Pool
    • retail_tobacconist - Tobacconist
    • retail_tyres - Tyres
    • retail_vehicle - Vehicle Accessory Shop
    • retail_wood - Furniture & Wood
    • services - Services
    • services_adult - Adult
    • services_advertising - Advertising
    • services_agency_employment - Employment Agency
    • services_agency_entertainment - Entertainment Agency
    • services_agency_estate - Estate Agent / Letting Agent
    • services_air - Air Transport
    • services_aircon - Air Conditioning
    • services_althealth - Alternative Health
    • services_aquatic - Aquatic & Marine Related
    • services_architect - Architect
    • services_auto - Auto Repair, Service & Parts
    • services_bathroom - Bathroom Related
    • services_beauty - Beauty Related Premise
    • services_bedroom - Bedroom Related
    • services_bookkeeping - Book Keeping Services
    • services_carpenter - Carpenters & Joiners
    • services_carwash - Car Wash & Valet
    • services_cattery - Cattery
    • services_chiropractor - Chiropractor
    • services_cleaning_commercial - Commercial Cleaning
    • services_cleaning_domestic - Domestic Cleaning Services
    • services_cleaning_industrial - Industrial Cleaning
    • services_drivingschool - Driving School
    • services_drycleaner - Dry Cleaner
    • services_education - Educational and School Related
    • services_electrical_repair - Electricians / Electrical Repair
    • services_electrical_services - Electrical Services
    • services_engraving - Engraving
    • services_environmental - Environmental Related
    • services_facilities - Facilities Manager
    • services_film - Film
    • services_financial - Financial
    • services_fitout - Fitout
    • services_flooring - Flooring Services
    • services_framing - Framing
    • services_freight - Road Haulage & Freight Services
    • services_funeral - Funeral Services
    • services_gardening - Gardening Services
    • services_glaziers - Glaziers
    • services_golf - Golf & Related
    • services_government - Government Related
    • services_guesthouse - Guest Houses/Bed & Breakfast
    • services_hair - Hair & Beauty Salon
    • services_health - Health Care
    • services_healthbeauty - Health & Beauty
    • services_heating - Heating Services
    • services_heavy - Heavy Machinery
    • services_hire - Hire
    • services_hire_car - Car Hire Services
    • services_hire_chauffeur - Chauffeur Hire Services
    • services_hire_dress - Dress Hire
    • services_hire_machinery - Plant & Machinery Hire
    • services_hire_tool - Tool & Equipment Hire
    • services_hire_vehicle - Commercial Vehicle Hire Services
    • services_hotel - Hotel
    • services_housebuilder - Housebuilder
    • services_importexport - Import & Export
    • services_insurance - Insurance Related
    • services_interiordesign - Interior Designer
    • services_kennel - Boarding Kennels
    • services_landscape - Landscape Gardening
    • services_laundry - Coin Op Laundry
    • services_lawyer - Lawyers/Legal
    • services_locksmith - Locksmiths
    • services_machinery - Machinery Repair & Maintenance
    • services_mailbox - Mail Box Services
    • services_maincontractor - Main Contractor
    • services_maintenance - Maintenance
    • services_management - Management Consultancy
    • services_marketing - Marketing
    • services_marquees - Marquees
    • services_mechanical - Mechanical Services
    • services_membership - Membership Organisation
    • services_network - Network
    • services_oil - Oil & Petrochemical Related
    • services_optician - Optician
    • services_other - Other
    • services_personal - Personal Services
    • services_pet - Pet
    • services_photocopying - Photocopying Business
    • services_photographic - Photographic & Video Services
    • services_plumber - Plumber
    • services_postal - Postal & Communication
    • services_professional - Professional
    • services_property - Property Services
    • services_publishing - Publishing
    • services_recycling - Recycling
    • services_removal - Removal Services
    • services_roofing - Roofing Services
    • services_sawmill - Sawmill
    • services_security - Security Related
    • services_services - Services
    • services_shipping - Shipping Services
    • services_shoe - Shoe Repair Services
    • services_signs - Sign Maker
    • services_specialist - Specialist Subcontractor
    • services_storage - Storage / Warehouse
    • services_surveyor - Surveyor
    • services_taxi - Taxi Services
    • services_translation - Translation Services
    • services_transportation - Transportation
    • services_transport_related - Transportation Related
    • services_travel - Travel Agents
    • services_vehicle_leasing - Vehicle Leasing Services
    • services_vending - Vending Related
    • services_vet - Vet
    • tech - Tech & Media
    • tech_domains - Domain Names
    • tech_ecommerce - E-Commerce
    • tech_internet - Internet
    • tech_isp - Internet Service Provider (ISP)
    • tech_it - Information Technology
    • tech_maintenance - I.T. Maintenance
    • tech_media - Media
    • tech_other - Other Technical Services
    • tech_software - Software
    • tech_telecoms - Telecommunication
    • tech_telephone - Telephone Services
    • tech_training - Computer Training
    • tech_web - Web Design / Development
    • wholesale - Wholesale & Distribution
    • wholesale_commercial_vehicle - Commercial Vehicle Dealer
    • wholesale_construction - Construction Suppliers
    • wholesale_distribution - Distribution
    • wholesale_food_distributor - Food & Drink Distributor
    • wholesale_food_wholesaler - Food & Drink Wholesaler
    • wholesale_medical - Medical Supply
    • wholesale_printing - Printing & Printing Supplies
    • wholesale_stationary - Stationery & Office Supplies
    • wholesale_vehicles - Vehicles

images
Images is a container for a list of images for the property.
It may consist of any number of the following element:

  • image
    An image is a HTTP URL for the associated image file and should be accessible over the internet
    The image supports the following attributes:

    • title - Title of the image, as text.
    • main - Sets image to be main image for this property, valid value is "main" I.e. main="main"

gps
gps is a container for a pair of coordinates for the property location.
It may consist of one of each of the following elements:

  • longitude
    Expressed either in degrees or as degrees minutes seconds. In addition negatives may be specified by prefixing with -,W or S. Positives need not be specified by may be so with +,N,E. When using minutes & seconds the seperator may be any non-numeric value. Examples...

    • N52 34 24
    • W23"32'12
    • -68.34523
    • 23.56932W
  • latitude
    Expressed either in degrees or as degrees minutes seconds. In addition negatives may be specified by prefixing with -,W or S. Positives need not be specified by may be so with +,N,E. When using minutes & seconds the seperator may be any non-numeric value. Examples...

    • N52 34 24
    • W23"32'12
    • -68.34523
    • 23.56932W

contact
contact is a container for a set of contact details for the property. If no contact is provided then the main account details are used.
It may consist of one of each of the following elements:

  • name - a string containing persons title and name

  • email - a string containing persons email address

  • phone - a string containing persons telephone number

Namespace Declarations

  • xmlns:ukbp="http://www.ukbusinessproperty.co.uk/rss/1.0/"

Model

<item> Elements:

  • <ukbp:status> ( #PCDATA )
  • <ukbp:expires> ( #PCDATA )
  • <ukbp:address> ( ukbp:no?, ukbp:street?, ukbp:district?, ukbp:town?, ukbp:county?, ukbp:country?, ukbp:postcode? )
  • <ukbp:address> Elements:

    • <ukbp:no> ( #PCDATA )
    • <ukbp:name> ( #PCDATA )
    • <ukbp:street> ( #PCDATA )
    • <ukbp:district> ( #PCDATA )
    • <ukbp:town> ( #PCDATA )
    • <ukbp:county> ( #PCDATA )
    • <ukbp:country> ( #PCDATA )
    • <ukbp:postcode> ( #PCDATA )
    • <ukbp:confidential> ( #PCDATA )
  • <ukbp:scheme> ( #PCDATA )
  • <ukbp:size> ( ukbp:total?, ukbp:minimum?, ukbp:unit? )
  • <ukbp:size> Elements:

    • <ukbp:total> ( #PCDATA )
    • <ukbp:minimum> ( #PCDATA )
    • <ukbp:unit> ( #PCDATA )
  • <ukbp:price> ( ukbp:sale?, ukbp:rent?, ukbp:currency? )
  • <ukbp:price> Elements:

    • <ukbp:sale> ( #PCDATA )
    • <ukbp:rent> ( ukbp:amount?, ukbp:unit?, ukbp:period? )
    • <ukbp:rent> Elements:

      • <ukbp:amount> ( #PCDATA )
      • <ukbp:unit> ( #PCDATA )
      • <ukbp:period> ( #PCDATA )
    • <ukbp:currency> ( #PCDATA )
  • <ukbp:yield> ( #PCDATA )
  • <ukbp:detail> ( #PCDATA )
  • <ukbp:property_status> ( #PCDATA )
  • <ukbp:tenures> ( ukbp:tenure* )
  • <ukbp:tenures> Elements:

    • <ukbp:tenure> ( #PCDATA )
  • <ukbp:categories> ( ukbp:category* )
  • <ukbp:categories> Elements:

    • <ukbp:category> ( #PCDATA )
  • <ukbp:types> ( ukbp:type* )
  • <ukbp:types> Elements:

    • <ukbp:type> ( #PCDATA )
  • <ukbp:images> ( ukbp:image* )
  • <ukbp:images> Elements:

    • <ukbp:image> ( #PCDATA )
  • <ukbp:gps> ( ukbp:latitude?, ukbp:longitude? )
  • <ukbp:gps> Elements:

    • <ukbp:latitude> ( #PCDATA )
    • <ukbp:longitude> ( #PCDATA )
  • <ukbp:contact> ( ukbp:name?, ukbp:email?, ukbp:telephone? )
  • <ukbp:contact> Elements:

    • <ukbp:name> ( #PCDATA )
    • <ukbp:email> ( #PCDATA )
    • <ukbp:phone> ( #PCDATA )

<item> Attributes:

  • <ukbp:sale> (type (region|excess|tender|auction) #IMPLIED)
  • <ukbp:yield> (type (fixed|percent) #IMPLIED)
  • <ukbp:image> (main (main) #IMPLIED)
  • <ukbp:image> (title CDATA #IMPLIED)