Spécifications Techniques
du format d’export
Trans-Immo


Tables des matières


Introduction

Cette documentation décrit le protocole qui permet de renseigner automatiquement le modèle de données Simple-Immo via sa propre passerelle. Ce protocole et cette passerelle sont nommés Trans-Immo dans la suite de ce document.

Pour toute question ou support : contact@izianet.com


Révisions

Pour ce qui est des tables de valeurs (ou tables de référence) décrites dans le chapitre Description exhaustive du nœud InfosBien et des balises enfant , cette documentation est générée automatiquement. Une mise à jour des données de référence provoquera automatiquement une mise à jour de la documentation sans que le tableau ci-dessous soit affecté.

Liste des évolutions de la passerelle TransImmo et de cette présente documentation.

Date Auteur Libellé Description de l’évolution
20/09/2013 Olivier T. Création du document Création et mise en ligne de la documentation de la passerelle
22/02/2016 Geoffrey G. Ré-amenagement de champ Ajout des champs suivants :
  • Bien->SousSol
  • Bien->InsertBois
  • Bien->FacadeBien
  • Bien->SurfaceChambre1
  • Bien->SurfaceChambre2
  • Bien->SurfaceChambre3
  • Bien->SurfaceBureau
  • Bien->NbMezanine
  • Bien->SurfaceMezanine
  • Bien->NbVeranda
  • Bien->SurfaceVeranda
  • Bien->SurfaceBatimentAnnexe
  • Bien->SurfaceCuisine
  • Bien->EnergieCuisine
  • Bien->ProductionEauChaude
  • Bien->Sonnette
  • Localisation->DistanceCreche
  • Localisation->DistancePharmacie
  • Localisation->DistanceMedecin
  • Bien_Commerce->TypeLocalCommercial
  • Bien_Commerce->TaxeFonciereLocataire
Fusion des champs suivants en Bien_Sonnette :
  • Bien_Appartement->Digicode
  • Bien_Appartement->InterphoneVisiophone
Division du champ "Localisation->DistanceMaternellePrimaire" en :
  • Localisation->DistanceEcoleMaternelle
  • Localisation->DistanceEcolePrimaire
11/04/2016 Geoffrey G. Ré-amenagement de champ Ajout des champs suivants :
  • Bien->NbLot
  • Bien->PiscineLocalisation
  • Bien->NbTerasse
  • Bien->BatiementsAnnexes
  • Bien_Appartement->Cellier
  • Bien_Parking->Hauteur
  • Spec_Vente->BailsEnCours
  • Spec_Vente->TypeBail
  • Spec_Vente->DateFinBail
  • Spec_Vente->LoyerBail
  • Spec_Location->AssuranceGLI
  • Spec_Vacances->Acompte
Suppression du champ suivant :
  • Bien->Terrasse
18/04/2016 Geoffrey G. Ré-amenagement de champ Ajout des champs suivants :
  • Spec_Vacances->DateDisponibiliteDebut
  • Spec_Vacances->DateDisponibiliteFin

Format du fichier XML

Le fichier XML

On suppose que le lecteur de ce document est familier avec le format XML. En cas de besoin, reportez-vous aux spécifications de ce format http://www.w3.org/TR/REC-xml/

Le protocole Trans-Immo s'appuie sur le transfert d’un fichier au format XML. Le format XML étant un format flexible, de nouvelles balises peuvent apparaître au fur et à mesure de l’enrichissement de notre modèle de données Simple-Immo.

Principe de fonctionnement de la passerelle TransImmo

Prérequis : Pour utiliser la passerelle Trans-Immo, vous devez être adhérent au Conseil National des Agents Immobiliers. Pour vous inscrire: http://www.cnai.fr/

Le fichier d’échange Trans-Immo contiendra l’intégralité des biens du catalogue de l’agence et toutes les données nécessaires à la description des biens.

Un bien sera donc créé à sa première apparition dans votre catalogue. Il pourra ensuite être modifié autant de fois que nécessaire pour mettre à jour des données (évolution du prix, changement des photos…). Lorsque ce bien disparaît de votre fichier, il est considéré comme ne faisant plus partie de votre catalogue. Il est donc supprimé du site http://www.simple-immo.fr/

Un export n’est utile que si des données nouvelles doivent être créées ou mises à jour sur le site http://www.simple-immo.fr/. Il est donc inutile de faire des exports quotidiens si votre catalogue n’a pas évolué (changement d’une information relative à un bien, arrivée ou départ d’un bien).

Dans le cas où certaines données obligatoires ne seraient pas présentes dans votre fichier, le bien correspondant ne pourra pas être importé. (Par exemple, les bien soumis à l’obligation de fournir les informations DPE devront impérativement renseigner les informations de DPE). La liste des données obligatoires est décrite dans le chapitre Description exhaustive du nœud InfosBien et des balises enfant

Protocole de mise à disposition du fichier

Le fichier XML de votre catalogue doit être mis à disposition sur votre serveur (ou un serveur de votre choix) et l’URL du fichier ainsi créé doit être renseignée sur le site du CNAI, en ayant au préalable indiqué Transimmo comme logiciel utilisé.



Structure générale du fichier

La balise Trans-Immo est la racine du fichier d’échange, elle a pour nœud fils tous les biens du catalogue de l’agence.

Chaque bien crée un nœud InfosBien.

Chaque nœud InfosBien renseigne l'agence qui apporte le bien. Ainsi, il est possible pour plusieurs agences de partager le même fichier XML. (peut être utile dans le cas d'agences possédant plusieurs bureaux.)

<?xml version="1.0" encoding="utf-8"?> <TransImmo> <InfosBien> Balises XML concernant le bien n°1 </InfosBien> <InfosBien> Balises XML concernant le bien n°2 </InfosBien> <InfosBien> Balises XML concernant le bien n°3 </InfosBien> . . . </TransImmo>

Exemples de fichiers

Ci-dessous, sont présentés des exemples de fichiers XML pour chaque mode de transaction. Pour faciliter la lecture de ce document, ces exemples ne présentent que les informations obligatoires pour chaque cas présenté. Pour décrire avec plus d’informations votre catalogue, reportez- vous au chapitre "Description exhaustive du nœud InfosBien et des balises enfant".

==> Vente

Le fichier suivant présente un exemple de fichier proposant une maison à la vente : exemples\ventemaison.xml

==> Location

Le fichier suivant présente un exemple de fichier proposant un appartement à la location : exemples\locationappart.xml

==> Neuf

Le fichier suivant présente un exemple de fichier proposant un appartement en vente neuf : exemples\neufappart.xml

==> Viager

Le fichier suivant présente un exemple de fichier proposant une maison en viager : exemples\viagermaison.xml

==> Vacances

Le fichier suivant présente un exemple de fichier proposant un appartement en location de vacances : exemples\vacancesappart.xml

Description exhaustive du nœud InfosBien et des balises enfant

Ci-dessous, vous est présentée la structure exhaustive d’un nœud InfosBien. En cliquant sur les balises, vous obtenez des informations supplémentaires sur la balise sélectionnée (commentaires, valeurs). Attention le modèle ci-dessous présente l'intégralité des données utilisées dans la passerelle TransImmo.

Cela n’a pas valeur d’exemple réaliste puisqu’il présente la structure d’un bien qui est à la fois en location, en viager, en vente…

<InfosBien> <Agence> <IdUniqueBien> <TypeBien> <SousTypeBien> <ModeTransaction> <DateMiseAJour> <Bien> <Description> <Disponibilite> <DateDisponibilite> <TypeConstruction> <AnneeConstruction> <Fondations> <FacadeBien> <TypeCouverture> <AssainissementCollectif> <SurfaceTerrain> <SurfaceHabitable> <SurfaceSejour> <OrientationSejour> <NbPiece> <NbChambre> <NbChambrePlainPied> <SurfaceChambre1> <SurfaceChambre2> <SurfaceChambre3> <SurfaceBureau> <TypeCuisine> <SurfaceCuisine> <AmenagementCuisine> <EnergieCuisine> <NbWC> <NbSalleDEau> <NbSalleBain> <EquipementSDB> <NbNiveauHabitable> <NbParking> <NbBalcon> <SurfaceBalcon> <NbTerrasse> <SurfaceTerrasse> <NbMezanine> <SurfaceMezanine> <NbVeranda> <SurfaceVeranda> <BatimentsAnnexes> <SurfaceBatimentAnnexe> <SousSol> <SurfaceSSol> <SSolAccesVoiture> <TypeChauffagePrincipal> <EnergiePrincipale> <PompeAChaleur> <Mitoyennete> <Decennale> <DO> <Cheminee> <InsertBois> <Etat> <AccesHandicapes> <TypeIsolation> <IsolationVitrage> <TypeFenetre> <SoumisDPE> <ConsommationEnergie> <ClassificationConsommation> <Emmissions> <ClassificationEmmision> <CoutChauffage> <Climatisation> <ProductionEauChaude> <TaxeFonciere> <TaxeHabitation> <ChargesCoproMensuelles> <Copropriete> <NbLot> <Gardien> <Sonnette> <VueImprenable> <PiscineProCopro> <PiscineTaille> <PiscineType> <PiscineLocalisation> <Filtration> <TennisProCopro> <EquipementSpecial> <CreationManuelle> </Bien> <Bien_Appartement> <Etage> <NbEtageImmeuble> <Ascenseur> <Cave> <Cellier> <NbBoxe> <NbParkingInt> <AccesCampingCarParkingInt> <NbParkingExt> <NbParkingExtCouvert> <AccesCampingCarParkingExtCouvert> <ChauffageCollectif> <Jardin> </Bien_Appartement> <Bien_Commerce> <SecteurActivite1> <SecteurActivite2> <SecteurActivite3> <SurfaceCommerciale> <SurfaceAnnexe> <LongueurVitrine> <LongueurFacade> <ChiffreAffaire> <RBE> <RevenuNet> <MasseSalariale> <BailEnCours> <Loyer> <ActiviteAutorisee> <NbCouverts> <NbCouvertsTerrasse> <Licence> <LogementFonction> <NbChambres> <CategorieHotelRestaurant> <TauxRemplissage> <FermetureHebdoEte> <FermetureHebdoHiver> <FermetureAnnuelle> <GalerieMarchande> <NbCommerceGalerie> <TypeLocalCommercial> <TaxeFonciereLocataire> </Bien_Commerce> <Bien_Maison> <SurfaceDependance> <NbParkingInt> <AccesCampingCarParkingInt> <NbParkingExt> <NbParkingExtCouvert> <AccesCampingCarParkingExtCouvert> </Bien_Maison> <Bien_Parking> <Longueur> <Largeur> <Hauteur> <Niveau> <BailEmphytheotique> <Duree> </Bien_Parking> <Bien_Terrain> <TerrainPlat> <Puit> <Cloture> <Arbore> <LongueurFacade> <Viabilise> <SurfaceTerrainConstructible> <SurfaceConstructibleSHON> <MontantTLE> <TaxeRaccordement> </Bien_Terrain> <Conseiller> <IdConseiller> <Civilite> <Nom> <Prenom> <Tel> <Mobile> <Email> </Conseiller> <Localisation> <Quartier> <Adresse> <NumeroLot> <CodePostal> <DistanceVoieRapide> <DistanceTransportCommun> <TypeTransportEnCommun> <DistanceCommerceProximite> <DistanceMoyenneSurface> <DistanceGrandeSurface> <DistanceCreche> <DistanceEcoleMaternelle> <DistanceEcolePrimaire> <DistanceLyceeCollege> <DistancePharmacie> <DistanceMedecin> <AccesInternet> <AccesCable> <Longitude> <Latitude> </Localisation> <Mandat> <NumeroMandat> <TypeMandat> <VisibleCarte> <DateMandat> <HonorairesMandat> <PrixLoyerEstime> <DateEstimation> <PrixLoyerInitialMandat> <PrixVente> <VenduLoueRetire> <DateRetrait> <PrixVenduLoyerLoue> <DateVenteLocation> <DateActeAuthentique> <HonoraireVenteLocation> <HonoraireChargeLocataire> <DateOffre> <RegimeFiscal> <InfoConfidentielleVisite> </Mandat> <Media> <Photo1> <Photo2> <Photo3> <UrlVisiteVirtuelle> <FichierPanoramique> </Media> <Proprietaire> <Societe> <TypeSociete> <Civilite> <Nom> <Prenom> <NumVoie> <TypeVoie> <NomVoie> <ComplementAdresse> <CodePostal> <Ville> <Pays> <Telephone> <Mail1> <Mail2> <Fax> </Proprietaire> <Spec_Vente> <BailEnCours> <TypeBail> <DateFinBail> <LoyerBail> </Spec_Vente> <Spec_Location> <Loyer> <Meuble> <Colocation> <OccupationBienJourActe> <DateBail> <TypeBail> <PeriodicitePaiement> <MontantCaution> <ConditionExigees> <AssuranceGLI> </Spec_Location> <Spec_Neuf> <NomProgramme> <BatimentBasseConsommation> <NbPieceAppartPetit> <NbPieceAppartGrand> <NbPieceMaisonPetite> <NbPieceMaisonGrande> <MursCommerciaux> <DateLivraisonTranche1> <DateLivraisonTranche2> <PrixBas> <PrixHaut> <Defiscalisation> <RentabiliteBrute> <DescriptifProgramme> </Spec_Neuf> <Spec_Vacances> <NbPersonnesMax> <Acompte> <TV> <LaveVaisselle> <LaveLinge> <Barbecue> <Sauna> <Jacuzzi> <LitBebe> <AnimalDomestique> <DistancePlage> <DistanceRemonteeMecanique> <DistanceCentreVille> <DistanceTerrainGolf> <DistanceLac> <VueMer> <VueMontagne> <VueLac> <DisponibiliteJour> <DisponibiliteSemaine> <DisponibiliteMois> <Ascenseur> <NonFumeur> <PrixJournee> <PrixWeekEnd> <PrixSemaine> <PrixQuinzaine> <PrixMois> <MontantDepot> <DateDisponibiliteDebut> <DateDisponibiliteFin> </Activites> <Activite> <Activite> <Activite> <...> </Activites> </Spec_Vacances> <Spec_Viager> <PrixBouquet> <RenteMensuelle> <NbTete> <AnneeNaissanceHomme> <AnneeNaissanceFemme> <PrixEstime> <VenduLibre> </Spec_Viager>

Remarques générales

Les prix (loyers, prix de vente, honoraires, taxes…) sont toujours exprimés en €, sans "." ni "," et ni le symbole "€".

Les distances sont toujours exprimées en mètres. 5km -> 5000

Les surfaces sont toujours exprimées en mètres carrés sans l'unité "m²"

Les dates sont toujours exprimées dans le format "AAAA-MM-DD", ex: 2013-09-12