Documentazione export annunci CasaOnClick

Questo documento, i cui destinatari sono gli sviluppatori di siti web per le agenzie immobiliari, contiene le specifiche per prelevare dal server di CasaOnClick gli annunci depositati dal software installato presso l'agenzia immobiliare e poterli quindi pubblicare su un proprio sito.

Versioning

La versione di XML descritta in questo file è la numero 2.0.

Eventuali modifiche di anagrafiche (con la sola eccezione dei nodi negotiation e subnegotiation) causeranno la modifica della sola sottoversione, tutte le altre modifiche (ad es. aggiunta di nuovi campi) saranno introdotte con un cambio di numero di versione. Quindi, ad esempio, se si aggiunge un nuovo tipo di immobile, la nuova versione sarà la 1.1, se si aggiunge un campo in più la nuova versione sarà la 2.0.

Download dell'XML

All'atto dell'attivazione Noxia fornirà all'utente la URL e la password per il prelievo del file, che, a titolo di esempio, si supporranno essere http://xml.casaonclick.it/adv.xml e PASSWORD.

Per scaricare il file, qualsiasi sia la sua versione, la URL sarà quindi http://xml.casaonclick.it/adv.xml?pw=PASSWORD.

Per scaricare il file, forzando l'output in formato compatibile con la versione 1.x, la URL sarà http://xml.casaonclick.it/adv.xml?pw=PASSWORD&version=1.

Non è invece possibile richiedere l'invio di una sotto-versione specifica (es. 1.0).

Il file andrà periodicamente scaricato, via HTTP, a cura del sito dell'utente e i relativi annunci aggiornati. Il campo lastupdate può essere utile per evitare l'aggiornamento del database qualora l'utente non abbia a sua volta pubblicato gli annunci successivamente al precedente download.

Per quanto riguarda le immagini, queste saranno fornite in JPEG già ridimensionate a 800 pixel nel loro lato più lungo (quindi, ad esempio, 640x800 o 800x640), scaricabili da una URL fornita. Di tali file verranno trasmessi dimensione e CRC32: tali dati possono essere utilizzati per evitare, in seguito, il download di immagini che sono già state scaricate.

Ulteriori requisiti

Per consentire la pubblicazione degli annunci sui diversi portali, è necessario che il sito supporti due ulteriori requisiti:

Supporto

Il supporto agli sviluppatori per l'integrazione sarà fornito esclusivamente via mail all'indirizzo xml@casaonclick.it; riportare, nella mail di richiesta, gli estremi dell'agenzia per la quale si sta effettuando la richiesta.

Formato xml

<?xml version="1.0" encoding="UTF-8" ?> Intestazione del file XML, che verrà fornito con codifica UTF-8.
casaonclick Nodo radice del documento XML.
casaonclick/error In caso di errore, contiene la descrizione dell'errore (e il file XML non contiene altri nodi). Se non vi è errore, il nodo non è presente.
casaonclick/version Versione del file XML. Al momento, 2.0.
casaonclick/lastupdate Contiene la data, in formato ISO 8861 in cui l'utente ha effettuato l'ultimo aggiornamento con il software.
casaonclick/negotiation@name Nodo contenitore delle zone per ciascuna negoziazione, già ordinate come inserite nel software. Le zone sono sempre due, anche se vuote, e sono:
  • Vendesi
  • Fittasi
casaonclick/negotiation/zone@name Nodo contenitore delle sottozone per ciascuna zona, già ordinate come inserite nel software. Il valore di name è il nome della zona. Le zone sono quelle definite autonomamente dall'agenzia per ripartire i propri immobili.
casaonclick/negotiation/zone/subzone@name Nodo contenitore degli annunci per ciascuna sottozona, già ordinati come inserite nel software. Il valore di name è il nome della sottozona. Le sottozone sono quelle definite autonomamente dall'agenzia per ripartire i propri immobili.
casaonclick/negotiation/zone/subzone/adv@id Nodo contenente il singolo annuncio, del quale è sepecificato l'identificatore univoco id.
casaonclick/negotiation/zone/subzone/adv/windowno Posizione nelle vetrine
casaonclick/negotiation/zone/subzone/adv/subnegotiation Sotto-negoziazione, assume uno dei seguenti valori:
  • Residenziale
  • Commerciale
casaonclick/negotiation/zone/subzone/adv/municipality@code Nome del comune dove è ubicato l'immobile; code è il codice catastale (es. F839).
casaonclick/negotiation/zone/subzone/adv/quarter Nome del quartiere dove è ubicato l'immobile. I quartieri (e i comuni) sono quelli della geografia interna di CasaOnClick, utilizzata per la pubblicazione dei portali.
Per la ripartizione degli annunci sul sito, si consiglia l'utilizzo delle zone e delle sottozone, che sono invece definite dall'utente.
casaonclick/negotiation/zone/subzone/adv/latitude Latitudine dell'immobile.
casaonclick/negotiation/zone/subzone/adv/longitude Longitudine dell'immobile.
casaonclick/negotiation/zone/subzone/adv/address Indirizzo dell'immobile.
casaonclick/negotiation/zone/subzone/adv/description Descrizione dell'immobile.
casaonclick/negotiation/zone/subzone/adv/type Tipo immobile, assume uno dei seguenti valori:
  • Appartamento
  • Attico
  • Attività
  • Attività
  • Bar/Ristorante
  • Box
  • Cantinola
  • Capannone
  • Casa indipendente
  • Deposito
  • Laboratorio
  • Locale commerciale
  • Loft
  • Magazzino
  • Mansarda
  • Monolocale
  • Negozio
  • Open Space
  • Palazzina
  • Rustico
  • Studio professionale
  • Terreno
  • Ufficio
  • Villa
  • Villetta a schiera
casaonclick/negotiation/zone/subzone/adv/rentalstatus Stato locativo, può assumere uno dei seguenti valori:
  • Libero
  • Locato
  • Nuda proprietà
casaonclick/negotiation/zone/subzone/adv/flatstatus Condizioni immobile, può assumere uno dei seguenti valori:
  • Ottime
  • Buone
  • Discrete
  • Da ristrutturare
casaonclick/negotiation/zone/subzone/adv/price Prezzo in euro dell'immobile; stringa vuota è da interpretarsi come Trattativa riservata o, più genericamente, Non specificato.
casaonclick/negotiation/zone/subzone/adv/surface Quadratura, in metri quadri, dell'immobile.
casaonclick/negotiation/zone/subzone/adv/rooms Numero vani dell'immobile.
casaonclick/negotiation/zone/subzone/adv/bathrooms Numero bagni dell'immobile.
casaonclick/negotiation/zone/subzone/adv/heating Riscaldamento dell'immobile, può assumere uno dei seguenti valori:
  • No
  • Centralizzato
  • Autonomo
casaonclick/negotiation/zone/subzone/adv/car_parking Posto auto, può assumere uno dei seguenti valori:
  • No
  • Scoperto
  • Coperto
  • Condomin. scop.
  • Condomin. cop.
  • Box
  • Box singolo+posto auto
  • Box singolo+2 posti auto
  • Box doppio
  • Box doppio+posto auto
  • Box doppio+2 posti auto
casaonclick/negotiation/zone/subzone/adv/lift Ascensore; se specificato può essere true o false.
casaonclick/negotiation/zone/subzone/adv/terrace Terrazzo; se specificato può essere true o false.
casaonclick/negotiation/zone/subzone/adv/balcony Numero balconi dell'immobile.
casaonclick/negotiation/zone/subzone/adv/garden Giardino, può assumere uno dei seguenti valori:
  • No
  • Privato
  • Comune
casaonclick/negotiation/zone/subzone/adv/floor Piano dell'immobile (testo libero).
casaonclick/negotiation/zone/subzone/adv/condominial_expenses Spese condominiali mensili (numero intero).
casaonclick/negotiation/zone/subzone/adv/energy_class Classe energetica, se non vuoto assume uno dei seguenti valori:
  • Esente
  • A+
  • A
  • B
  • C
  • D
  • E
  • F
  • G
casaonclick/negotiation/zone/subzone/adv/energy_ipe@unit Indice di prestazione energetica, se specificato (float con max 2 decimali e il punto come separatore); unit è m2 se l'indice è espresso in kWh/anno/m², m3 se l'indice è espresso in kWh/anno/m³, può invece non essere presente se l'indice è vuoto o pari a zero.
casaonclick/negotiation/zone/subzone/adv/vtour Codice Virtual Tour (testo libero come inserito dall'utente, se è impostato il Virtual Tour HTML).
casaonclick/negotiation/zone/subzone/adv/images Nodo contenitore delle foto dell'immobile.
casaonclick/negotiation/zone/subzone/adv/images/image@type, @size, @crc32 Nodo contenitore della singola foto dell'immobile; type è impostato a map se la foto è una piantina, a vtour se la foto è un virtual tour, a photo altrimenti. I campi size e crc32 contengono la dimensione e il crc32 del file di immagine e possono essere utilizzati per stabilire se una foto va scaricata o meno.
casaonclick/negotiation/zone/subzone/adv/images/image/description Descrizione della foto.
casaonclick/negotiation/zone/subzone/adv/images/image/url Url da cui scaricare la foto.

Esempio

Segue un XML di esempio, scaricabile anche alla URL http://xml.casaonclick.it/xml/sample.xml. Le foto presenti nel file di esempio sono effettivamente pubblicate, per cui il file può essere utilizzato a fini di sviluppo.