DEPRECATION WARNING

This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.

LumoNet ImmobilienScout24.de Expose

Author:Kasper Skårhøj
Created:2002-11-01T00:32:00
Changed by:Thomas Off
Changed:2006-12-15T13:57:10
Author:Thomas Off, LumoNet oHG
E-Mail:t.off@lumonet.de
Info 3:
Info 4:

LumoNet ImmobilienScout24.de Expose

Extension Key: lumophpinclude

Copyright 2006, Thomas Off, LumoNet oHG,<t.off@lumonet.de>

This document is published under the Open Content License

available from http://www.opencontent.org/opl.shtml

The content of this document is related to TYPO3

- a GNU/GPL CMS/Framework available from www.typo3.com

Content

Introduction 1

What does it do? 1

Screenshots 2

Usage 3

Requirements 3

Installation 3

Configuration 3

Known Bugs 5

ToDo 6

Changelog 7

Introduction

What does it do?

The extension shows data from a realty exposé from the known portal ImmobilienScout24.de which is obtained by their XML-based API. This way, agents are able to present information about their realties on their website without having to edit data twice: the data they enter at ImmobilienScout24.de can improve the realty descriptions on thei homepage with little effort.

Screenshots

Backend view of the plugin:

img-1

Usage

Requirements

typo3 >= 4.0 (could work on older versions of TYPO3 but this was not tested)

To actually use the extension you need two things:

An API key for developers which can be obtained at no fee from http://api.immobilienscout24.de/de/api_center/

A valid vendor ID from ImmobilienScout24.de; to get one you'll have to sign a professional product from them (for which a monthly fee is charged)

Installation

Get your API key and the vendor ID (the last one typically from your customer, the agent)

Install the plugin via Extension Manager.

Use the Constant Editor to set the API key and vendor ID.

Create a new page.

Add a new content element „ImmobilienScout24.de Exposé“ to this page.

Enter the so called „Scout-ID“ of some realty (must not be one of the vendor whose ID is used)

View your page in the frontend of the website.

Adjust the templates to fit your needs.

Configuration

The only configuration that can be done is setting the API key and the vendor ID, which is always necessary to use the plugin, and adjusting the templates.

The following configuration options are available at the moment:

api_key

Property

api_key

Data type

string

Description

The API key for developersGet one for free at http://api.immobilienscout24.de/de/api_center/.

Example:

plugin.tx_lumoscoutexpose_pi1.api_key = API_KEY

Default

vendor_id

Property

vendor_id

Data type

string

Description

Path to a template file for map, sidebar and info window;

an example can be found in the sub-directory templates of the plugin.

Example:

plugin.tx_lumoscoutexpose_pi1.vendor_id = VENDOR_ID

Default

allappartmentbuy

Property

allappartmentbuy

appartmentrent

gastronomy

housebuy

houserent

housetype

industry

investment

misc

office

site

store

waz

Data type

string

Description

Template file to be used for the different types of realties; the extension chooses the template based on the API response dynamically.

Each of the templates features a set of common markers (from the exposés base types RealEstate and GISRealEstate) and markers specific to the type of realty (e.g. the type of heating is not used for sites).

The template_all file can be used to include all templates in one big file (not recommended because of the readability of the resulting HTML code)

Example:

plugin.tx_lumoscoutexpose_pi1.template.site = fileadmin/templates/template_site.html

Default

See template analyzer for default values

Templating

Included with the extension are sample templates for all types of exposés. A description of all available properties is provided within the document „Technische Dokumentation ImmobilienScout24-API“ which can be obtained from the developer website (http://api.immobilienscout24.de/de/api_center/). The document is also provided within the extension's 'doc' directory.

The following paragraphs list the markers available to all types of exposés from their base types RealEstate and GISRealEstate.

RealEstate

###uuid###

###CreationDate###

###DeactivationDate###

###LastModificationDate###

###Heading###

###vendor###

###foreignKey###

###groupNumber###

###ContactAddress\_company1###

###ContactAddress\_company2###

###ContactAddress\_title###

###ContactAddress\_salutation###

###ContactAddress\_firstName###

###ContactAddress\_lastName###

###ContactAddress\_phone###

###ContactAddress\_mobile###

###ContactAddress\_fax###

###ContactAddress\_eMail###

###ContactAddress\_homepage###

###ContactAddress\_businessPhone###

###ContactAddress\_businessFax###

###ContactAddress\_callBeforeFax###

GISRealEstate

###Address\_street###

###Address\_houseNo###

###Address\_zip###

###Address\_city###

###showAddress###

###Continent###

###Country###

###Region###

###City###

###Quarter###

###geoX###

###geoY###

Known Bugs

No bugs known so far.

Please report any other bugs (or suggestions for improvement) to the author of the extension.

ToDo

  • Implement different types of pictures to get (currently the 'Expose' type is used).
  • Add (better) error messages (as the API sometimes fails without reason)
  • Implement session management to use resources more efficiently (currently a new session is opened for every request)
  • <Your suggestion for improvement here>

Changelog

2006-12-13 Thomas Off, LumoNet oHG <t.off@lumonet.de>

Implemented missing handling of base type GISRealEstate

2006-12-12 Thomas Off, LumoNet oHG <t.off@lumonet.de>

Initial release

img-2 LumoNet ImmobilienScout24.de Expose - 8