Service Web pour l échange des données dans le cadre d annonce par des tiers

Transcription

1 Département fédéral de l'intérieur DFI Office fédéral de la statistique OFS Division Registres Registre fédéral des bâtiments et des logements Service Web pour l échange des données dans le cadre d annonce par des tiers Dossier technique pour l échange des données via le ws proxy de sedex pour les plateformes d échange Ce document contient la description et les exigences techniques pour l utilisation du service Web mis à disposition par l OFS pour l échange des données dans le cadre d annonce par des tiers avec le RegBL fédéral. Neuchâtel, le 15 janvier 2016 Version 1.0

2 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 2/14 Contrôle et historique des modifications Version Date Nom et rôle Remarques OFS RegBL Première ébauche OFS RegBL Première version officielle Documents de référence Ordonnance du 31 mai 2000 sur le Registre fédéral des bâtiments et des logements (SR ) RegBL : Catalogue des caractères, version 3.6 ; Neuchâtel 2012 Tous les documents de référence sont disponibles sur Internet, à l adresse Autres documents utiles Norme SN , Mensuration et information géographique Adresses de bâtiments. Association suisse de normalisation (SNV), ech-0014 «SAGA.CH», version 3.0 du , ech-0018 : Meilleures pratiques XML, version 3.0 du , Modèle de données 2001 de la mensuration officielle / Confédération, MD.01-MO-CH, version 24, Abréviations et concepts BAU DB Work Données ref ech EDID EGID EPROID EWID GEWO Internet MO OFS RegBL (fédéral) RFP StatBL TRIM XML Statistique annuelle de la construction et des logements de l'ofs Banque de données du RegBL Données refusées lors d'un import dans le RegBL Association suisse pour le egovernment Identificateur fédéral d entrée du RegBL Identificateur fédéral de bâtiment du RegBL Identificateur fédéral de projet de construction du RegBL Identificateur fédéral de logement du RegBL Section Bâtiments et logement de l'ofs Variante d enquête en-ligne à l aide de l application internet du RegBL Mensuration officielle Office fédéral de la statistique Registre (fédéral) des bâtiments et des logements Recensement fédéral de la population Statistique des bâtiments et des logements de l'ofs Statistique trimestrielle de la construction des logements de l'ofs extensible Markup Language (langage informatique)

3 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 3/14 Table des matières Préambule 4 1 Obligation de renseigner pour les bailleurs, les gérants d immeuble, les locataires et les logeurs 5 2 Généralités Architecture générale Identification et sécurité Identification des utilisateurs Identification de la version du logiciel Disponibilité et mise à jour Description du service Web du RegBL fédéral Statut de la transaction et gestion des erreurs Service Web thirdpartynotification Recherche étendue des bâtiments Rechercher les logements liés à un bâtiment Rechercher une rue Contrôler l autorisation d accès au RegBL... 13

4 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 4/14 Préambule Le Registre des bâtiments et des logements (RegBL) a été mis sur pied à la suite du recensement de la population de l an 2000, sur la base du relevé des bâtiments et des logements. Il répertorie au moins l ensemble des bâtiments à usage d habitation et leurs logements sur le territoire suisse. 1 A côté d identificateurs de bâtiment et de logement (EGID et EWID) univoques en Suisse, il comprend les principales données de base sur les bâtiments et les logements. Il s agit notamment de l adresse, des coordonnées, de l année de construction, du nombre d étages, ainsi que du nombre de pièces et de la surface des logements. L Office fédéral de la statistique (OFS) gère le RegBL fédéral en étroite collaboration avec les services de construction communaux, ainsi que les offices concernés de la Confédération, des cantons et des communes. Les services de construction annoncent à l OFS tous les projets de construction soumis à autorisation (nouvelles constructions, transformations/rénovations, démolitions) via Internet ou au moyen d interfaces définies. Le relevé des données est réalisé en coordination avec les statistiques de la construction de l OFS (environ 140'000 projets chaque années) et complété avec d autres sources, telles que la mensuration officielle et la Poste.Le RegBL fédéral comprend actuellement 2 millions de bâtiments et près de 4 millions de logements. Sur la base des annonces des services de construction, quelque 17'000 bâtiments nouvellement construits comptant environ 40'000 nouveaux logements sont enregistrés chaque année et à peu près autant de bâtiments transformés sont actualisés. Combiné avec les registres cantonaux et communaux des habitants, le RegBL représente un pilier important dans la nouvelle conception du recensement de la population. Il constitue en outre la base de la statistique des bâtiments et des logements de l OFS. Les services administratifs des cantons et des communes ont également accès aux données se rapportant à leur territoire pour l accomplissement des tâches assignées par la loi. De plus, la Confédération, les cantons et les communes, ainsi que les particuliers peuvent utiliser les données du RegBL fédéral à des fins de recherche ou de planification. Bases légales La gestion du RegBL fédéral se fonde sur l article 10, alinéa 3 bis de la loi sur la statistique fédérale 2, sur l ordonnance sur le RegBL 3, ainsi que sur l ordonnance concernant les relevés statistiques 4. Des informations supplémentaires sur le RegBL sont disponibles sur Internet, à l adresse Tous les documents de référence sur le RegBL peuvent également être téléchargés ou commandés sur ce site. Si vous désirez être informé automatiquement sur les documents de référence actuels et sur les nouveautés relatives au RegBL fédéral, nous vous recommandons de vous abonner à la Newsletter du RegBL fédéral sous Les propositions, indications, remarques etc. sur le Catalogue des caractères ou sur le RegBL fédéral en général sont toujours les bienvenues. Pour d autres questions et compléments d information, veuillez vous adresser à l Office fédéral de la statistique : Section Bâtiments et logements Tel / courriel : housing-stat@bfs.admin.ch 1 Les bâtiments dans usage d habitation sont en partie enregistrés et gérés dans le RegBL fédéral. Selon l ordonnance sur le RegBL, les communes n ont toutefois pas d obligation de mettre à jour de tels bâtiments. 2 Loi fédérale du 9 octobre 1992 sur la statistique fédérale (RS ) 3 Ordonnance du 31 mai 2000 sur le Registre fédéral des bâtiments et des logements (RS ) 4 Ordonnance du 30 juin 1993 concernant l exécution des relevés statistiques fédéraux (RS )

5 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 5/14 1 Obligation de renseigner pour les bailleurs, les gérants d immeuble, les locataires et les logeurs L article 12 de la Loi fédérale sur l'harmonisation des registres des habitants et d'autres registres officiels de personnes (LHR, RS ) définit l obligation de renseigner au travers des dispositions légales édictées par les cantons. Ainsi, les employeurs, les bailleurs, les locataires, les gérants d immeuble et les logeurs doivent informer de la présence de leurs employés ou de leurs locataires si ces derniers ne pas soumis à l obligation d annonce selon l article 11. Cette information peut être envoyée au contrôle de l habitant au moyen de l annoncer ech via sedex. Pour que les gérants immobiliers et les bailleurs sans interface avec sedex puissent envoyer les annonces, l Office fédéral de la statistique met à disposition un service électronique. Les administrations peuvent générer l annonce au format XML sur la page correspondante à l aide d un formulaire en ligne et, via le serveur sedex, la faire parvenir à l application métier du contrôle de l habitant ou dans la boîte aux lettres électronique de la commune. Les messages envoyés peuvent être soit traités directement dans l application métier ou dans la boîte aux lettres électronique, à l aide d un PDF contenant les informations nécessaires pour un traitement manuel. Grâce à ce développement supplémentaire des services Web, il est maintenant possible, au moyen d un fichier CSV, d obtenir les EGID à partir des adresses. Ainsi, il y a la possibilité pour les gérants immobiliers et les bailleurs de doter leurs données «adresses» des EGID et des EWID. En conséquence, ceci rend possible une communication simplifiée avec les registres et un élargissement du groupe des intéressés.

6 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 6/14 2 Généralités 2.1 Architecture générale Le service Web pour l échange des données dans le cadre d annonce par des tiers propose uniquement des méthodes en lecture sur les données du RegBL. L architecture du service Web se présente ainsi : Fig. 1 : Architecture générale du service Web

7 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 7/ Identification et sécurité Le contrôle des accès et la sécurité des données sont importants dans le cadre du service Web d annonce par des tiers Identification des utilisateurs L identification des utilisateurs du service Web se fait via le sedexid délivré par sedex. Le RegBL gère cette information dans la gestion des utilisateurs mise en place dans l application RegBL. Chaque accès au service Web se fait par l intermiédaire d un sedexid enregistré au préalable dans le RegBL fédéral. Pour le cas d affaire «Annonce par des tiers - des gérances aux communes», une identification des gérances est obligatoire dans le RegBL Identification de la version du logiciel Chaque logiciel ou plateforme qui utilise le service Web doit passer d abord par une phase de certification afin de garantir une utilisation correcte de ce dernier. Les producteurs de logiciel ou les responsables informatiques d applications certifiées reçoivent, de la part de l OFS, une certification officielle de la part du RegBL fédéral. Avant qu un producteur de logiciel ou un responsable informatique libère une nouvelle version de son application, il doit demander à l OFS une nouvelle certification. La seule exception autorisée à cette règle est que les nouveautés de la version n ont aucune conséquence pour le service Web du RegBL fédéral. Il est de la responsabilité du producteur de logiciel ou du responsable informatique de s enquérir, s il est nécessaire ou non, d obtenir une nouvelle certification pour chaque nouvelle version de son application. L OFS se garde le droit de bloquer une certification déjà délivrée dans les cas suivants : Quand une utilisation abusive de la certification est avérée. Quand l utilisation du service Web provoque des problèmes qui n auraient pas dû apparaître suite au processus de certification de la version de l application. Le blocage sera signifié au propriétaire de la certification (producteur de logiciel ou au responsable informatique) par courriel. 2.3 Disponibilité et mise à jour Le service Web est disponible du lundi au samedi de 6h00 à 18h00 à l exception du mardi et du mercredi de 17h00 à 19h00 pour les travaux d entretien. Naturellement, la mise à disposition des données via le service Web est faite selon le principe du meilleur effort et aucune garantie d exploitation n est donnée. L application RegBL dont dépend le service Web est mise à jour quatre fois par année à la mimars, mi-juin, mi-septembre et mi-décembre (mise à jour ordinaire).

8 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 8/14 3 Description du service Web du RegBL fédéral Dans le présent document, la notion de services Web est à interpréter de cette manière : «Les services Web réalisent des fonctions allant des simples requêtes aux processus métiers sophistiqués. Il s agit d applications autodescriptives, modulaires et faiblement couplées qui fournissent un modèle simple de programmation et de déploiement d application, basé sur des normes, et s exécutant au travers de l infrastructure Internet.» 5 Le service Web d échange des donnés dans le cadre d annonce par des tiers du RegBL fédéral est composé de trois méthodes. Chaque méthode du service est décrite dans un tableau selon le tableau suivant : Fig. 2 : Tableau de description d une méthode Nom Nom de la méthode. Description Description générale du travail effectué par la méthode. Paramètres d entrée La liste des paramètres à passer en entrée de la méthode afin qu elle puisse remplir son contrat. Paramètres de sortie La liste des paramètres renvoyés par la méthode. Attention : La méthode renvoie toujours un seul type complexe agrégeant tous les autres types. Afin de faciliter et de ne pas alourdir la lecture des spécifications, nous présentons pour chaque méthode la liste complète détaillée des types. Critères minimaux de recherche Au moins un des critères énuméré ici doit être passé en paramètre pour pouvoir effectuer une recherche. On peut utiliser soit un critère de recherche seul, soit plusieurs en combinaison. La recherche renvoie tous les enregistrements qui satisfont aux critères (opérateur «et»). La recherche ne tient pas compte des critères qui sont vides (null). Résultat Résultat attendu de la méthode de recherche pour le operationstatustype.operationcode = 0. Exemple d appel Exemple d un appel à la méthode. 5 Hubert Kadima, Valérie Monfort, Les Web services, Dunod, Paris, 2003, 411 pages

9 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 9/ Statut de la transaction et gestion des erreurs Les méthodes du service Web retournent un statut de la transaction dont les codes sont mentionnés à la Table 1. Table 1: Catalogue des erreurs Code Texte Explications 0 ok L opération s est déroulée correctement : veuillez tout de même consulter la suite du message afin d obtenir la liste des règles de qualité déclenchées. 8 timeout Timeout atteint. La transaction est annulée complétement dans le RegBL fédéral. Le timeout est de 5 minutes sur le serveur. 10 unknown_user Utilisateur inconnu : si vous désirez accéder au RegBL fédéral avec les services Web, veuillez préalablement prendre contact avec l OFS à l adresse suivante : housing-stat@bfs.admin.ch. 11 not_authorized Accès pas autorisé : vous n avez pas d accès à cette méthode. 51 empty_criteria Critère de recherche vide : vous n avez pas saisi assez de critères de recherche. Veuillez respecter les critères minimaux de recherche. 52 empty_result Résultat vide : aucun enregistrement n a été retourné en fonction de vos critères de sélection. 98 too_many_results La requête fournit plus de 500 enregistrements. 99 error Autre type d erreur. Veuillez prendre contact avec le RegBL fédéral (housing-stat@bfs.admin.ch)

10 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 10/ Service Web thirdpartynotification Le service thirdpartynotification permet de procéder aux opérations de lecture des données du RegBL relatives à l obligation d annonce par des tiers Recherche étendue des bâtiments Nom getbuilding Description Cette méthode permet de rechercher un ou plusieurs bâtiments dans le RegBL en utilisant plusieurs paramètres comme critères de recherche. Paramètres d entrée Type complexe tpnaddresstype Paramètres de sortie Type complexe tpnbuildinglisttype Type complexe tpnoperationstatustype Critères minimaux de recherche tpnaddresstype.municipalityid ou tpnaddresstype.postcode La valeur de recherche saisie pour le n d entrée de maison (tpnaddresstype.buildingentrancenotype) est implicitement suivie d un caractère de remplacement générique. Résultat Cette méthode donne une liste de tous les bâtiments avec GSTAT in 1001, 1003, 1004 qui : satisfont à tous les critères de recherche saisis Exemple d appel

11 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 11/14 <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:ns1=" xmlns:ns2=" <soapenv:header/> <soapenv:body> <ns:getbuildingrequest> <ns1:municipalityid></ns1:municipalityid> <ns1:streetname>rue du Parc</ns1:streetName> <ns1:buildingentranceno></ns1:buildingentranceno> <ns1:postcode> <ns2:postcodeforaddress>2300</ns2:postcodeforaddress> <ns2:extensionofpostcode></ns2:extensionofpostcode> <ns2:nameofplace>la Chaux-de-Fonds</ns2:nameOfPlace> </ns1:postcode> <ns1:cantonabbreviationtype></ns1:cantonabbreviationtype> </ns:getbuildingrequest> </soapenv:body> </soapenv:envelope> Dans cet exemple, l utilisateur obtient tous les bâtiments de la rue du Parc à 2300 La Chaux-de-Fonds Rechercher les logements liés à un bâtiment Nom getdwellingbyegid Description Cette méthode permet de rechercher tous les logements d un bâtiment dans le RegBL en utilisant comme critères l EGID. Paramètres d entrée Type simple buildingtype.federalbuildingid Paramètres de sortie Type complexe tpndwellingslisttype Type complexe tpnoperationstatustype Critères minimaux de recherche Résultat buildingtype.federalbuildingid Cette méthode permet de trouver un logement avec WSTAT in 3001, 3003, 3004 qui : satisfait à tous les critères de recherche saisis

12 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 12/14 Exemple d appel <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:getdwellingbyegidrequest>17187</ns:getdwellingbyegidrequest> </soapenv:body> </soapenv:envelope> Dans cet exemple, l utilisateur obtient tous les logements du bâtiment dont l EGID est égal à Rechercher une rue Nom getstreet Description Cette méthode permet de rechercher les informations concernant une ou plusieurs rues en définissant le type complexe addresstype comme paramètre. Paramètres d entrée Type complexe tpnaddresstype Paramètres de sortie Type complexe tpnstreettype Type complexe tpnoperationstatustype Règles d utilisation Aucune Critères minimaux de recherche La valeur de recherche saisie pour le n d entrée de maison (tpnaddresstype.buildingentrancenotype) est implicitement suivie d un caractère de remplacement générique. Résultat Cette méthode donne une liste de toutes les rues qui : satisfont à tous les critères de recherche saisis Exemple d appel

13 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 13/14 <soapenv:envelope xmlns:soapenv=" xmlns:ns=" xmlns:ns1=" xmlns:ns2=" <soapenv:header/> <soapenv:body> <ns:getstreetrequest> <ns1:municipalityid>6421</ns1:municipalityid> <ns1:streetname></ns1:streetname> <ns1:buildingentranceno></ns1:buildingentranceno> <ns1:postcode> <ns2:postcodeforaddress></ns2:postcodeforaddress> <ns2:extensionofpostcode></ns2:extensionofpostcode> <ns2:nameofplace></ns2:nameofplace> </ns1:postcode> <ns1:cantonabbreviationtype></ns1:cantonabbreviationtype> </ns:getstreetrequest> </soapenv:body> </soapenv:envelope> Dans cet exemple, l utilisateur obtient toutes les rues de la commune 6421 (La Chaux-de-Fonds) Contrôler l autorisation d accès au RegBL Nom controlauthorization Description Cette méthode permet de vérifier si un tier (gérance, etc.) a accès aux données du RegBL au travers du cas d affaire «Annonce par des tiers - des gérances aux communes». Paramètres d entrée Type simple tpnauthorizationtype.key Paramètres de sortie Résultat Type complexe tpnauthorizationtype Type complexe tpnoperationstatustype Indique si le tier est autorisé (1) ou pas (2) à accèder aux données du RegBL via le cas d affaire «Annonce par des tiers - des gérances aux communes». Exemple d appel

14 Dossier technique d échange des données dans le cadre d annonce par des tiers; version 1.0 du Page 14/14 <soapenv:envelope xmlns:soapenv=" xmlns:ns=" <soapenv:header/> <soapenv:body> <ns:controlauthorizationrequest>26589</ns:controlauthorizationrequest> </soapenv:body> </soapenv:envelope> Dans cet exemple, le système vérifie si la clé 26589, délivrée au tiers après sa demande d accès à l OFS, est autorisée à utiliser le service «Annonce par des tiers».