Dossier des Interfaces - Logementsne.info.application.logement.gouv.fr/IMG/pdf/NUU... · développe...

Système national d’enregistrement de la demande de logement social

Dossier des InterfacesCahier des charges pour les Interfaces dédiées aux pièces justificatives

Organismes / Centre serveur

Document PROJET

CP2I Département Opérationnel Normandie Centre09/07/2014

Historique des versions du document

Version Date Commentaire

1.0 09/07/2014 Création

Affaire suivie par

Tél. : 02 35 68 81 51 / Fax : 02 35 68 88 41

Courriel : Farmin.Yarirad[at]developpement-durable.gouv.fr

RédacteurÉquipe klee Group

RelecteurThomas MONIN - KLEE GROUP

Référence(s) intranet

http://

SOMMAIRE

1 - INTRODUCTION..........................................................................................................6

1.1 - Présentation du document........................................................................................6

1.2 - Principe des échanges liés aux pièces justificatives.................................................7

1.3 - Les principes fondateurs...........................................................................................8

1.3.1 - Les canaux d'échanges.................................................................................................................................................................8

1.3.2 - Les fichiers :..................................................................................................................................................................................8

1.3.3 - La traçabilité :................................................................................................................................................................................8

1.3.4 - La visibilité des pièces...................................................................................................................................................................8

1.3.5 - Les métadonnées échangées avec les SI privatifs.......................................................................................................................8

2 - FONCTIONNEMENT DES INTERFACES...................................................................9

2.1 - Les certificats.............................................................................................................9

2.1.1 - Généralités....................................................................................................................................................................................9

2.1.2 - Détail de l’utilisation des certificats...............................................................................................................................................9

2.2 - Gestion des erreurs.................................................................................................10

2.3 - Gestion du mode asynchrone.................................................................................12

2.4 - Gestion du mode synchrone...................................................................................12

2.4.1 - Gestion des Web Services..........................................................................................................................................................12

2.4.2 - Gestion de la sécurité..................................................................................................................................................................13

2.4.3 - Gestion de l’authentification........................................................................................................................................................13

2.4.4 - Gestion des pièces jointes..........................................................................................................................................................14

2.4.5 - Gestion des erreurs.....................................................................................................................................................................14

2.4.6 - Rappel des fonctionnalités proposées........................................................................................................................................15

3 - STRUCTURE DES ÉCHANGES DÉDIÉS AUX PIÈCES JUSTIFICATIVES............16

3.1 - Définition..................................................................................................................16

3.2 - Détail de la structure XML dédiée à une pièce justificative (format dit PJU)..........17

3.3 - Détail de la structure XML dédiée à une liste de pièces justificatives (format dit MPJ).................................................................................................................................19

3.4 - Détail de la structure XML dédiée à la récupération du plan de classement - (format dit PCL )...............................................................................................................21

4 - CINÉMATIQUE DES ÉCHANGES............................................................................23

4.1 - Contrôles communs.................................................................................................23

4.2 - Les échanges..........................................................................................................23

4.2.1 - Lister les pièces justificatives d’une demande............................................................................................................................23

4.2.2 - Consulter les pièces justificatives d’une demande.....................................................................................................................24

4.2.3 - Ajouter une pièce justificative à une demande...........................................................................................................................26

4.2.4 - Modifier une pièce justificative d’une demande..........................................................................................................................29

Cas de la modification des métadonnées uniquement..........................................................................................................................30

Cas de la modification des métadonnées et du fichier joint...................................................................................................................30

4.2.5 - Supprimer des pièces justificatives d’une demande...................................................................................................................32

4.2.6 - Recenser les demandes ayant au moins une pièce justificative modifiée depuis une date.......................................................33

4.2.7 - Récupérer le plan de classement................................................................................................................................................35

4.3 - Règles de nommage des fichiers XML et ZIP envoyés par le « SNE »..................36

4.4 - Récapitulatif des formats des échanges.................................................................39

5 - CONTRÔLES ET MESSAGES D'ERREUR DANS LES FICHIERS D'INTERFACE.........................................................................................................................................40

5.1 - Contrôles sur le fichier réceptionné (XML ou ZIP)..................................................41

CTRL_FIC_0003 : Le code guichet doit être cohérent...........................................................................................................................41

CTRL_FIC_0004 : Le flux XML doit être valide......................................................................................................................................41

CTRL_FIC_0007 : Le fichier ZIP doit contenir un fichier XML et un fichier PDF...................................................................................42

CTRL_FIC_0008 : Le fichier ZIP doit contenir un fichier XML...............................................................................................................42

CTRL_FIC_0009 : Le nom du fichier ZIP doit être conforme.................................................................................................................42

CTRL_FIC_0010 : Le nom du fichier XML doit être conforme...............................................................................................................43

CTRL_FIC_0011 : Mauvais format de ZIP.............................................................................................................................................44



5.2 - Contrôles sur le code guichet..................................................................................47

CTRL_GUI_0001 : Le nom du certificat doit être conforme...................................................................................................................47

CTRL_GUI_0002 : Le code du guichet doit être connu du référentiel...................................................................................................47

CTRL_GUI_0003 : Le guichet associé au code guichet doit être valide...............................................................................................48

CTRL_GUI_0004 : Le certificat reçu doit être valide..............................................................................................................................48

CTRL_GUI_0005 : Le guichet doit être authentifié................................................................................................................................48

5.3 - Contrôles portant sur les pièces justificatives associées à une demande..............50

CTRL_PJU_0022 : Description des listes de codes paramétrables vérifiés à la réception du fichier...................................................50

CTRL_PJU_0001 : Un numéro unique doit être fourni en entrée..........................................................................................................51

CTRL_PJU_0002 : La demande de logement doit être connue............................................................................................................51

CTRL_PJU_0003 : Les catégories indiquées doivent être connues du système..................................................................................52

CTRL_PJU_0004 : La demande comporte au moins une pièce justificative des catégories demandées............................................52

CTRL_PJU_0005 : La demande comporte au moins une pièce justificative.........................................................................................52

CTRL_PJU_0006 : La pièce justificative indiquée doit être connue du système...................................................................................53

CTRL_PJU_0007 : Les pièces justificatives indiquées sont associées à la demande spécifiée..........................................................53

CTRL_PJU_0008 : Le numéro unique indiqué dans le fichier XML joint doit correspondre à celui indiqué en argument....................53

CTRL_PJU_0009 : L'identifiant technique de la pièce doit être non renseigné.....................................................................................54

CTRL_PJU_0010 : La catégorie indiquée doit être connue du système...............................................................................................54

CTRL_PJU_0011 : Le type indiqué doit être connu du système...........................................................................................................55

CTRL_PJU_0012 : Le champ commentaire ne doit pas dépasser la taille maximale...........................................................................55

CTRL_PJU_0013 : L'indice de pertinence doit être connu du système.................................................................................................55

CTRL_PJU_0014 : Le champ « nom fichier » doit être renseigné.........................................................................................................56

CTRL_PJU_0015 : Le nom de fichier indiqué doit correspondre au fichier transmis............................................................................56

Cahier des charges des interfaces– Gestion des pièces justificatives – 09/07/2014 4/64

CTRL_PJU_0016 : L'identifiant technique du fichier ne doit pas être renseigné...................................................................................57

CTRL_PJU_0017 : Le type et la catégorie indiqués pour la pièce justificative doivent être en accord avec le plan de classement....57

CTRL_PJU_0018 : L'identifiant de la pièce justificative doit être renseigné dans le fichier XML..........................................................57

CTRL_PJU_0019 : Le niveau de sensibilité de la pièce doit correspondre à celui de son type...........................................................58

CTRL_PJU_0020 : La valeur de l’attribut « documentInterne » de la pièce doit correspondre à celle de son type.............................58

CTRL_PJU_0021 : Le type de fichier doit être autorisé.........................................................................................................................59

5.4 - Contrôles portant sur le recensement des demandes ayant des pièces modifiées.........................................................................................................................................60

CTRL_MPJ_001 : La date Depuis doit être antérieure à la date du jour...............................................................................................60

CTRL_MPJ_002 : Aucune demande ne correspond à la de recherche...............................................................................................60

CTRL_MPJ_003 : Le nombre de demandes répondant à la recherche dépasse le seuil autorisé.......................................................60

CTRL_MPJ_004 : Le format de la date doit être correct.......................................................................................................................60

CTRL_MPJ_005 : La date Jusque doit être postérieure à la date Depuis.............................................................................................61

CTRL_MPJ_006 : La date Jusque doit être antérieure à la date du jour...............................................................................................61

6 - FONCTIONNALITÉS D'ADMINISTRATION.............................................................62

6.1 - Traçabilité des échanges........................................................................................62

7 - CONTACT..................................................................................................................63


1 - Introduction

1.1 - Présentation du document

Le présent document a pour objectif de décrire les Web services offerts par le SNE-PGP pourpermettre la gestion et le partage des pièces justificatives associées à une demande delogement social.

Ces services complémentaires sont mis en œuvre dans le contexte de la loi ALUR qui institueune plus grande transparence dans les processus d’attribution de logement sociaux et quidéveloppe la dématérialisation des dossiers.

Cela va se traduire notamment par la possibilité d’associer des pièces justificatives à undossier de demande logement et leur partage avec tous les acteurs concernés. Les nouvellesfonctionnalités de gestion des pièces justificatives intégrées à un dossier seront accessiblesaussi bien pour le demandeur de logement social que pour les acteurs du logement social(gestionnaire, enregistreurs…).

Ces éléments sont complémentaires au cahier des charges décrivant les échanges liés àgestion des demandes : 20130610_NUU__dossier_interfaces_v2.6

Ces services de gestion des pièces justificatives sont limités aux services enregistreurs et auxsystèmes privatifs individuels.


1.2 - Principe des échanges liés aux pièces justificatives


11

Import unitaire de pièces justificatives Export unitaire de pièces justificatives 22Téléchargement / Téléversementunitaire de pièces justificatives (Web) 33

Téléchargement / Téléversementunitaire de pièces justificatives (Web) 44

SNESNE

PGPPGP

Système Territorial Partagé

Système Territorial Partagé

Service enregistreur avec système privatif




22

33

44

11Pas d’échange /accès aux piècesjustificatives

Demandeurs

Guichet enregistreur

Pièces justificatives (PJ)

Circulation des PJ

Saisie des données

Flux asynchrone

Flux synchrone

Téléchargement synchrone55

55

Téléservice local hors périmètre SNE

1.3 - Les principes fondateurs

1.3.1 - Les canaux d’échanges

Les échanges dédiés aux pièces justificatives sont limités aux Web services.

Les territoires en fichiers partagés ne sont pas autorisés à exploiter les web services dédiésaux pièces justificatives.

1.3.2 - Les fichiers :

Une pièce justificative est composée :

• d’un fichier PDF

• de métadonnées (échangées au format XMl)

La taille maximale (via le SNE) d’un fichier PDF est de 1 Mo

1.3.3 - La traçabilité :

• Toutes les actions sur les pièces justificatives sont historisées sur le SNE.

• Seule la dernière action effectuée sur une pièce justificative est transmise dans lecadre des web-services (Le type d'action, la date et l'acteur)

1.3.4 - La visibilité des pièces

Une pièce justificative peut être d'un type dit « sensible ». La pièce sera alors visible par :

• le demandeur,

• les intervenants ayant un profil autorisé.

Une pièce justificative peut être d’un type ou d’une catégorie qualifiée de « documentinterne ».

• La pièce sera alors visible par les intervenants connectés sur le SNE,

• La pièce ne sera alors pas visible par le demandeur.

Ces deux qualités sont cumulables.

1.3.5 - Les métadonnées échangées avec les SI privatifs

• Identifiant de la pièce justificative (généré lors de la création) ;

• Catégorie, Type de document (liste dépendante de la catégorie) ;


• Numéro unique de la demande associée (déduit lors de la création) ;

• Date (présence et signification dépendantes du type) ;

• Commentaires du demandeur (texte libre) ;

• Indice de pertinence (choix parmi [ –, acceptable, inexploitable, hors périmètre]) ;

• Sensibilité (déduite du type) ;

• Document interne (déduite du type) ;

• Date et auteur du dépôt de fichier (déduits lors de la création) ;

• Date, auteur et type de la dernière action (déduits lors de l'action).

2 - Fonctionnement des interfaces

2.1 - Les certificats

2.1.1 - Généralités

Les techniques de sécurisation mises en place dans le cadre des interfaces synchrone etasynchrone de l’application « SNE » s’appuient majoritairement sur des mécanismes designature et chiffrement à partir d’une paire de clés asymétriques :

• Clé privée

• Clé publique diffusée au sein d’un certificat

Les certificats utilisés sont des certificats conformes à la norme RGS (Référentiel Général deSécurité). Ces certificats utilisent le format défini par la norme de cryptographie X.509.

2.1.2 - Détail de l’utilisation des certificats

Les certificats et paires de clés utilisés dans le cadre de l’application « SNE » sont lessuivants :

• Une paire de clés associée à l’application SNE fournie par le ministère :

• Clé privée Numéro Unique

• Clé publique Numéro Unique diffusée au sein d’un certificat

• Une paire de clés pour chaque système enregistreur / guichet :

• Clé privée du système enregistreur

• Clé publique du système enregistreur diffusée au sein d’un certificat

Dans le cadre de l’application « SNE », une phase de vérification de la validité des certificatsdes systèmes enregistreurs est effectuée. Ceci consiste à vérifier que :

• Le certificat a un format valide.


• Le certificat a été délivré par une autorité de certification (CA) reconnue par le MINEFI

• Le certificat n’est pas périmé

• Le certificat n’est pas révoqué

L’application « SNE » est quant à elle chargée de réaliser l’authentification du guichetenregistreur à partir de son certificat :

le certificat doit être défini avec un numéro de SIREN correspondant aux 9 premiers chiffresdu numéro de SIRET du guichet enregistreur. Le numéro de SIREN doit être précisé dans lecertificat après la chaîne de caractères « OU = 0002 » (soit OU = 0002 XXXXXXXXXYYYYYavec XXXXXXXXX le numéro SIREN et éventuellement le complément YYYYY servant àspécifier le numéro de SIRET).

Elle vérifie également les autorisations d’accès au système national auxquelles le certificatdonne droit.

2.2 - Gestion des erreurs

Les anomalies en provenance du SNE véhiculent les informations suivantes :

• Le code de l’anomalie,

• La propriété ciblant la donnée en erreur, ce champ étant optionnel,

• Un (ou plusieurs) élément complément, ce champ étant optionnel,

• Un complément est constitué de 2 informations :

• un nom pour identifier la donnée concernée par le message

• la valeur correspondant à la donnée

• Le message indiquant l’information (erreur ou remarque).

Les codes sont catégorisés en deux grandes classes, afin d’identifier une erreur bloquante ouune remarque. Les codes seront préfixés comme suit :

• ERR : Pour les messages spécifiant une erreur bloquante.

• REM : Pour les messages indiquant une remarque.

Ce préfixe est suivi d’un code permettant de cibler plus précisément l’origine du messaged’erreur ou de la remarque. Ces codes sont les suivants :

• FIC : En relation avec le fichier ZIP ou XML.

• GUI : Origine du problème guichet/certificat.

• DEM : Données spécifiques à la demande de logement.

• RAD : Données spécifiques aux informations de radiation.

• REN : Données spécifiques aux informations de renouvellement.


• PJU : Données spécifiques à une pièce justificative.

• MPJ : Données spécifiques aux suivis des modifications de pièces justificatives

Chaque code est ensuite suffixé d’un numéro chrono.

• Exemple de codification du code Anomalie :

Code ERRREN0123

L 'exemple ci-dessus codifié ERRREN0123, indique une erreur (ERR) sur la partierenouvellement (REN). Cette erreur est référencée sous le numéro « 123 ».

Les messages d’erreur ou remarques indiqués dans ce dossier d’interface sont codifiés enprenant compte de cette nouvelle codification. Les messages pouvant intervenir par la suite,provenant de nouveaux contrôles ou conditions viendront s’y ajouter, ils suivront la mêmedésignation, leur numéro chrono sera incrémenté.

Exemple de message d’anomalie sans complément :

Détail de l’erreur

Code ERRREN0003

Propriété XXXXX.YYYY.ZZZZavec XXXXX.YYYY le nom de la propriété dansl’arborescence XML.

Message «Informations «XXXXX.YYYY» : Cerenouvellement de demande ne peut êtreaccepté. Cette demande est «Etat de lademande».»

Exemple de message d’anomalie avec compléments :

Code ERRDEM0003

Propriété recommandation

Complément

dateXML Valeur fournie dans le fichier XML del’échange

dateEnCours Valeur connue par l’application

Message Le fichier « XX.XML » en modification ne peut être pris encompte avec une modification de la date de dépôt de la demande de logement : date XML XX date en cours XX

Codification du message au niveau du fichier XML :

<ns1:listeAnomalie>

<ns1:anomalie code="ERRDEM0003" propriete="dateCreationDemande"><ns1:complementnom="dateXML">XX</ns1:complement><ns1:complement


nom="dateEnCours">XX</ns1:complement><ns1:message>Informations«dateCreationDemande» : Le fichier « XX.XML » en modification ne peut être pris en compteavec une modification de la date de dépôt de la demande de logement : date XML XX date encours XX</ns1:message></ns1:anomalie>

</ns1:listeAnomalie>

Remarques :

- Le libellé du message d'erreur (Message) est à destination de l'utilisateur final. Il estsusceptible d'être modifié (selon les retours terrain). Aussi, aucun contrôle ne doit être opérésur ce libellé.

- Le code de l'erreur et le nom des compléments peuvent être utilisés par les utilisateurs pourautomatiser le traitement des erreurs en provenance de l'application NUU.

2.3 - Gestion du mode asynchrone

Le mode d'échange asynchrone mis en place dans le cadre du système SNE n'est pasexploité par la fonctionnalité de gestion des pièces justificatives.

2.4 - Gestion du mode synchrone

L’application « SNE » nécessite la mise à disposition de fonctionnalités accessibles en modesynchrone, pour des systèmes hétérogènes.

Pour répondre à ce besoin, l’application fournit des Services Web.

2.4.1 - Gestion des Web Services

Les Web Services réalisés vont être utilisés par des systèmes divers et variés. Afin de faciliterl’interfaçage et l'accès aux Web Services mis à disposition, nous nous sommes attachés àrespecter les standards en termes de développement de Web Services.

Dans le cadre de l’application « SNE » nous avons donc choisi de mettre en place des WebServices avec :

• Une définition du contrat de service respectant WSDL 1.1

• Des messages au format SOAP 1.2

• Une combinaison de type et d’encodage fixée à Document/Litera.

• Une gestion des pièces jointes via XOP/MTOM

Un fichier WSDL 1.1 de description des services fournis est mis à disposition des servicesenregistreurs souhaitant les utiliser. Ce fichier permettra aux systèmes appelants d’utiliser leWeb Service.


2.4.2 - Gestion de la sécurité

La sécurisation des échanges Web Services est effectuée par la mise en place d'uneconnexion sécurisée HTTPS entre le système enregistreur et le serveur HTTP Apacheassocié à l'application «SNE». La sécurisation des échanges est donc assurée par leprotocole d'échange (HTTPS) et non par le Web Service (WS/Security).

La mise en place d’une connexion HTTPS avec authentification client peut schématiquementêtre décrite de la manière suivante :

• Le client demande au serveur l’ouverture d’une connexion HTTPS.

• Le serveur lui retourne son certificat. Ce certificat serveur permet au client de validerl’identité du serveur.

• Le client génère une clé symétrique qu’il chiffre avec la clé publique du certificat duserveur.

• Le client envoie la clé symétrique chiffrée au serveur accompagnée de son certificat client.

• Le serveur vérifie l’identité du client.

• Le client et le serveur peuvent maintenant échanger des données chiffrées avec la clésymétrique échangée précédemment.

Ce mécanisme permet donc de garantir :

• l’intégrité du message

• l’identité de l’expéditeur

• la non-répudiation de l’échange

• la confidentialité des données

2.4.3 - Gestion de l’authentification

Afin de permettre l’authentification des systèmes enregistreurs sollicitant les Web Servicesmis à disposition par l’application, chacun des services requiert la fourniture d’un certificat enpièce jointe.

L’application va utiliser ce certificat afin de vérifier l’identité de l’expéditeur par comparaisonavec les informations stockées au sein de la base de données.

Une fois l’identité de l’expéditeur validée, ses droits d’accès au système national sont vérifiés.

➢ Le nom des certificats en réception devra être composé de :

Zone Taille Commentaires

Préfixe de fichier Caractères (3) Constantes « CER»

Guichet Enregistreur Caractères (5) Numéro de guichet de l’émetteur



Date-heure d’émission du fichier

Caractères(12) AAAAMMDDHHMM1

Chaque zone devra être complétée par des zéros à gauche et séparée par un tiret.

Ex :

Guichet enregistreur : 125

Date-heure d’émission : 01/02/2010 03:04

Numéro d’ordre : 1

Résultat :

CER00125-201002010304.XXX

Sinon, le système génère l’anomalie CTRL_GUI_0001.

2.4.4 - Gestion des pièces jointes

Les pièces jointes sont échangées via les Web Services sur la norme SOAP MTOM.

SOAP MTOM (SOAP Message Transmission Optimization Mechanism) est un mécanisme detransmission optimisé des pièces jointes au sein d'un Web Service. Ce mode de transmissions'appuie sur XOP (XML-binary Optimized Packaging) qui permet d'intégrer des pièces jointesau sein d'un fichier XML de manière efficace.

MTOM et XOP sont des recommandations du W3C (World Wide Web Consortium) pour letransfert de pièces jointes au sein de Web Services SOAP.

Le choix de XOP/MTOM pour le transfert de pièces jointes permet de :

• Réduire le volume des flux transférés lors de l’envoi d’une pièce jointe

• Réduire les temps de traitement en sérialisation/dé-sérialisation

2.4.5 - Gestion des erreurs

Lorsqu’une erreur survient au cours du traitement d’une demande synchrone les mécanismessuivants sont proposés :

• Si l’erreur est liée à un contrôle fonctionnel et que le fichier XML de demande ou de piècejustificative en entrée a un format valide, alors les anomalies sont insérées à la listed’anomalies liste anomalie du fichier XML reçu et ce fichier est retourné à l’expéditeur.

• Sinon en cas d’erreur sur le flux, l’erreur est retournée au sein du message SOAP deréponse en suivant le formalisme défini dans le fichier WSDL.

1 Cet horodatage n’utilise pas la notion de fuseau horaire. En effet cette structure de date permet de vérifier qu’un fichier n'est pas envoyé plusieurs fois.


2.4.6 - Rappel des fonctionnalités proposées

• Mode d’échange synchrone individuel

Les fonctionnalités proposées pour ce mode d’échange utilisé en configuration 1bis (systèmeindividuel), afin d’interagir en temps réel avec le système national sont :

• De permettre de créer une demande de logement social avec attribution d’un numérounique,

• De permettre de modifier une demande de logement social,

• De permettre de renouveler une demande de logement social,

• De permettre de radier une demande de logement social pour différents motifs,

• De permettre de réactiver une demande de logement social ayant été radiée (souscertaines conditions).

• Mais il offre aussi la possibilité de récupérer une demande de logement existante à partir deson numéro unique,

• Et enfin, une recherche des demandes potentiellement en doublon à partir d’une demandede logement partielle.

En complément de ces fonctionnalités de gestion des demandes, s’ajoutent les fonctionnalitésde gestion des pièces justificatives. Elles sont notamment :

• De permettre de lister les pièces justificatives associées à une demande,

• De permettre de récupérer les pièces justificatives associées à une demande,

• De permettre d’ajouter ou modifier les pièces justificatives associées à une demande,

• De permettre de supprimer les pièces justificatives associées à une demande,

• De permettre de recenser les demandes ayant subi une modification/ajout/suppression d’aumoins l’une de ses pièces justificatives,

• De permettre d’obtenir la description du plan de classement des pièces justificativesacceptables par le système.

Potentiellement, des envois d’attestations font partie des retours d’enregistrement desdemandes.

• En création : Attestation d’enregistrement

• En renouvellement : Attestation de renouvellement

• Mode d’échange synchrone partagé

Pour les systèmes partagés (configuration 2), les Web-services permettent de faire les actionssuivantes en temps réel :

• Enregistrer la création d’une demande de logement social,


• Modifier une demande de logement social,

• Renouveler une demande de logement social,

• Radier une demande de logement social pour différents motifs,

• Réactiver une demande de logement social ayant été radiée.

• Supprimer une demande de logement social

• Fournir une demande de logement existante à partir de son numéro unique,

• Rechercher des demandes potentiellement en doublon à partir d’une demande de logementpartielle,

• Récupérer les demandes de logement social dont les informations DALO ont été modifiéesdepuis une date / heure paramétrée.

Pour les systèmes partagés, le système SNE-PGP ne propose pas de Web-services degestion des pièces justificatives.

3 - Structure des échanges dédiés aux pièces justificatives

3.1 - Définition

Les informations échangées par l’application « SNE» avec les systèmes enregistreurs sonttransmises au sein de fichiers XML (eXtensible Markup Language).

Ces fichiers XML respectent la version 1.0 de XML et sont encodés en UTF-8.

Le format des fichiers XML échangés est décrit au sein de fichiers XML schéma. Ces fichierspermettent de définir la structuration des documents ainsi que le type et le format desdonnées.

Les fichiers XML schéma sont également utilisés pour vérifier la conformité des fichiers reçus.

Pour information, les schémas fournis dans le cadre des services pemettant lagestion des pièces justificatives sont :• InterfaceNuuPiece_v0200.xsd : Schéma de l’interface pour l’échange de métadonnées

descriptives d'une pièce justificative .

• InterfaceNuuRecensementPiece_v0200.xsd : Schéma de l’interface pour l’échanged'information sur des listes de pièces justificatives

• InterfaceNuuPlanClassement_v0200.xsd : Schéma de l’interface pour la récupération duplan de classement


Un fichier XML supporte les informations descriptives :

• soit d’une seule pièce justificative,

• soit du plan de classement en vigueur

• soit d’une liste de pièces justificatives.

3.2 - Détail de la structure XML dédiée à une pièce justificative (format dit PJU)

Sa structure est identique en entrée et en sortie.

Dans le cas du flux sortant de retour (type de fichier « RET »), le fichier XML transmis peutcomporter en plus la zone d’informations « Anomalies » dans le cas où des erreurs ou desremarques ont été relevées.

Ce format est exploité pour les fichiers des types suivants :

• PJA et RET correspondant

• PJM et RET correspondant

• RET correspondant à une demande de consultation (PJC)

• RET correspondant à une demande de récupération de la liste des pièces d'unedemande (PJL)


Champs Obliga. Type Format/liste de valeurs

possibles

Balise XML AttributXML

Card.

Zone d’informations : interfaceNUU interfaceNuu 1

Version de l’interface Oui Caractères(5) XX.XX2 versionInterface

URL du namespace Oui Caractères "http://nuu.application.i2/" xmlns

Zone d’informations : Demande demande 1

Numéro unique de la demande Oui Caractères (18) numunique

Code guichet Oui Caractères (5) numGuichet

Zone d’informations : Entête entete 1

Type de fichier Oui Caractères (3) ListeTypeFichier typeFichier

Date de création ou de dernière modification de la demande

Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateFichier

Zone d’informations : Pièce piece 1-n

Identifiant technique de la pièce Non numérique idPiece

Catégorie de la pièce (code) Oui Caractères (10) categorie

Type de la pièce (code) Oui Caractères (10) type

Date fonctionnelle Non date aaaa-mm-jj dateFonctionnelle

Commentaire Non Caractères (1024)

commentaire

Indice de pertinence Non Caractère(10) ListeIndicePertinence indicePertinence

sensibilité Non Booléen sensibilite

DocumentInterne Non Booléen documentInterne

Zone d’informations : Pièce - Création creation 0-1

Date de création Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateCreation

Auteur (nom et prénom du demandeur ou nom de l’organisme enregistreur)

Oui Caractères (255) auteurCreation

Zone d’informations : Pièce – Dernière action derniereAction 0-1

Date dernière action Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateAction


Oui Caractères (255) acteurAction

Type dernière action Oui Caractères (4) ListeTypeAction typeAction

Zone d’informations : Pièce - Fichier fichier 0-1

Identifiant technique du fichier Non numérique idFichier

Nom du fichier Oui Caractères (100) nomFichier

Zone d’informations : Pièce – Fichier - Dépôt depot 0-1

2 La version de l’interface ne peut contenir que la valeur 02.00


Date dépôt du fichier Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateFichier


Oui Caractères (255) auteurFichier

Zone d’informations contenant la liste des anomalies : listeAnomalie listeAnomalie 0-1

Zone d’informations : listeAnomalie - Anomalie anomalie 1-n

Code de l'anomalie Oui Caractères (10) code

propriété Oui Caractères (255) propriété

Complément Non Caractères (10) Information complémentaire à l’anomalie

complement 0-n

Message Oui Caractères (512) Message de l’anomalie message

3.3 - Détail de la structure XML dédiée à une liste de pièces justificatives (format dit MPJ)

Ce format est exploité en sortie du SNE pour les fichiers de types suivants :

• PJS (demande de suppression) et RET correspondant,

• PJL (demande de récupération de la liste des pièces d'une demande),

• PJC (demande de consultation),

• MPJ (demande de recensement des demandes ayant des pièces modifiées, ajoutéesou supprimées) et RET correspondant



possibles


Card.




Zone d’informations : Demande 1

Numéro unique de la demande Oui Caractères (18) numunique


Zone d’informations : Entête 1




dateFichier

Zone d’informations : Pièces 0-1

Zone d’informations : Pièces - Pièce 1-n

Identifiant technique de la pièce Non numérique idPiece

Zone d’informations : Pièces - Pièce – Dernière action 0-1

Date dernière action Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateAction


Oui Caractères (255) auteurAction

Type dernière Action Oui Caractères (4) ListeTypeAction typeAction

Zone d’informations : recensement 0-1

Zone d’informations : recensement - dates 0-1

Date Depuisle Oui dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateDepuisLe

Date jusqu'au Non dateTime aaaa-mm-jjTHH:MM:SS.s+hh:mm

dateJusquAu

Zone d’informations : recensement - catégories 0-1

Zone d’informations : recensement - catégories - catégorie 1-nCatégorie de la pièce (code) Oui Caractères (10) codeCategorie


Zone d’informations : listeAnomalie - anomalie anomalie 1-n


proprièté Oui Caractères (255) propriété


complement nom 0-n


3 La version de l’interface ne peut contenir que la valeur 02.00


3.4 - Détail de la structure XML dédiée à la récupération du plan de classement – (format dit PCL)

Ce format est exploité en sortie du SNE pour le fichier de type suivant :

• PCL (demande de récupération du plan de classement) et RET correspondant.



possibles


Card.




Zone d’informations : Demande demande 1


Zone d’informations : Entête entete 1




dateFichier

Zone d’informations : PlanDeClassement planDeClassement 0-1

version Oui Caractères(5) XX.XX5 versionClassement 1

Zone d’informations : PlanDeClassement - catégorie categorie 1-n

Catégorie de la pièce (code) Oui Caractères (10) codeCategorie

Catégorie de la pièce (libellé) Oui Caractères (50) libelleCategorie

DocumentInterne Oui Booléen documentInterne

Zone d’informations : PlanDeClassement – catégorie – listeType listeType 0-1

Zone d’informations : PlanDeClassement - catégorie – listeType - type type 1-n

type de la pièce (code) Oui Caractères (10) codePiece

type de la pièce (libelle) Oui Caractères (50) libellePiece

obligatoire Oui Booléen obligatoire

documentinterne Oui Booléen documentInterne

sensibilité Oui Booléen sensibilite

Date Fonctionnelle apparente Oui Booléen afficherDate

Libelle de la date fonctionnelle Non Caractères (50) libelleDate

Maximum d’occurrence Oui numérique occurrenceMax


Zone d’informations : listeAnomalie - anomalie anomalie 1-n


proprièté Oui Caractères (255) propriété


complement nom 0-n


4 La version de l’interface ne peut contenir que la valeur 02.005 La version de l’interface ne peut contenir que la valeur 02.00


4 - Cinématique des échanges

4.1 - Contrôles communs

La consommation des web services dédiés à la gestion des pièces justificativesentraîne l’application systématique des contrôles suivants :

Nom du contrôle Signification

CTRL_GUI_0001 Nom du certificat non conforme,

CTRL_GUI_0002 Le code du guichet doit être connu duréférentiel,

CTRL_GUI_0003 Le guichet associé par le codeguichet doit être valide,

CTRL_GUI_0004 Le certificat reçu doit être valide,

CTRL_GUI_0005 Le guichet doit être authentifié,

4.2 - Les échanges

4.2.1 - Lister les pièces justificatives d’une demande

Description :

L’objectif de ce service est de transmettre la liste des pièces justificatives asso-ciées à une demande de logement social.

Données d’entrée :

L’application appelante transmet :– un fichier XML respectant le format MPJ renseigné, contenant les zones d'infor-

mations suivantes :• InterfaceNUU,• Entête avec le type de fichier valorisé à « PJL »,


• La zone d'information Demande complétée par le code guichet de l'appli-cation appelante et le numéro unique de la demande concernée par la re-cherche

• « recensement », optionnellement :◦ la zone d'information Categories complétée par la liste des codes ca-

tégorie pour lesquelles l'appelant souhaite recevoir la liste des piècesprésentes. L'absence de la zone catégories conduira au recensementde l'ensemble des pièces justificatives associées à la demande.

Contrôles :Tous les contrôles communs avec, en plus, les contrôles suivants :


CTRL_PJU_0001 Un numéro unique doit être fourni enentrée.

CTRL_PJU_0002 Le numéro unique doit être connu dusystème et porter sur une demandeinclus dans le périmètre de visibilitédu guichet,

CTRL_PJU_0003 Les catégories indiquées doivent êtreconnues du système,

CTRL_PJU_0004 La demande comporte au moins unepièce justificative des catégoriesdemandées.

CTRL_PJU_0005 La demande comporte au moins unepièce justificative.

Données de sortie :

L’application nationale retourne un fichier archive comprenant autant de fichiersXML au format PJU que de pièces justificatives. Chaque fichier XML, contient leszones d'informations suivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à « RET »,• Demande,• Piece :

◦ selon le type de la pièce justificative, le champ Date fonctionnelle pourraêtre absent

◦ l’ensemble des autres champs est renseigné.

4.2.2 - Consulter les pièces justificatives d’une demande

Description :

L’objectif de ce service est de permettre la récupération des pièces justificativesd’une demande.



L’application appelante transmet :– un fichier XML respectant le format MPJ renseigné, contenant les zones d'infor-mations suivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à « PJC »,• La zone d'information Demande complété par le code guichet de l'applica-

tion appelante et le numéro unique de la demande concernée par la re-cherche.

• Optionnellement : la zone d'information « pieces » complétée par la listedes identifiants techniques des pièces justificatives qu'il souhaite consulter.L'absence de la zone pièces conduira à la récupération de l'ensemble despièces justificatives associées à la demande.

Contrôles :

Tous les contrôles communs avec, en plus, les contrôles suivants :


CTRL_PJU_0001 Un numéro unique correct doit êtrefourni en entrée.


CTRL_PJU_0005 La demande ne comporte pas depièces justificative.

CTRL_PJU_0006 La pièce justificative indiquée estconnue du système.

CTRL_PJU_0007 Les pièces justificatives indiquéessont associées à la demandespécifiée.



L’application nationale retourne un fichier archive comprenant :– Autant de fichiers archives que de pièces justificatives répondant aux critères de

la recherche. Pour chaque pièce justificative, le fichier archive contient :• un XML au format PJU.• un fichier PDF

Chaque fichier XML, contient les zones d’informations suivantes :• InterfaceNUU,• Entête avec le type de fichier valorisé à « RET »,• Demande,• Pièce :

◦ selon le type de la pièce justificative, le champ Date fonctionnelle pourraêtre absent

◦ l’ensemble des autres champs est renseigné.

4.2.3 - Ajouter une pièce justificative à une demande

Description :

L’objectif de ce service est de permettre d’ajouter une pièce justificative à une de-mande.


L’application appelante transmet :– un fichier archive contenant :

– le fichier XML au format PJU décrivant les métadonnées– le fichier PDF constituant la pièce

Le fichier XML de pièce justificative transmis doit contenir les zones d’informationssuivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à « PJA »,• La zone d'information Demande complétée par le code guichet de l'applica-

tion appelante et le numéro unique de la demande concernée par la re-cherche


• Pièce :◦ le champ identifiant technique de la pièce ne doit pas être renseigné,◦ le champ « dateFonctionnelle » pourra être absent ou vide◦ le champ « commentaires » pourra être absent ou vide◦ les champs « sensibilité » et « documentinterne » :

▪ peuvent être absents▪ seront testés s'ils sont présents. Le retour est non bloquant.

◦ les autres champs doivent être présents et renseignés,◦ la zone d’informations « Création » ne sera pas exploitée,◦ la zone d’informations « Dernière Action » ne sera pas exploitée,◦ Fichier :

▪ le champ l’identifiant technique du fichier ne doit pas être rensei-gnée,

▪ le champ nom du fichier doit être complété et doit correspondre à unfichier existant dans l’archive,

▪ la zone d’information Dépôt ne sera pas exploitée.

Contrôles :



CTRL_FIC_0009 Le nom du fichier ZIP est conforme,

CTRL_FIC_0010 Le nom du fichier XML est conforme,

CTRL_FIC_0003 Le code guichet est cohérent,

CTRL_FIC_0004 Le flux XML est valide,

CTRL_FIC_0011 Le format du fichier ZIP doit êtrecorrect,

CTRL_FIC_0007 Le fichier ZIP doit contenir un fichierXML et un fichier PDF,



CTRL_PJU_0008 Le numéro unique indiqué dans lefichier XML correspond à celuiindiqué en paramètre.

CTRL_PJU_0009 L’identifiant technique de la pièce nedoit pas être renseigné,

CTRL_PJU_0010 La catégorie indiquée doit êtreconnue du système,

CTRL_PJU_0011 Le type indiqué doit être connu dusystème,

CTRL_PJU_0012 Le champ commentaire ne doit pascontenir plus de 1024 caractères,


CTRL_PJU_0013 L’indice de pertinence doit être connudu système,

CTRL_PJU_0014 Le champ « nom de fichier » doit êtrerenseigné.

CTRL_PJU_0015 Le contenu du champ « nom defichier » doit correspondre au nom dufichier PDF inclus dans l’archive,

CTRL_PJU_0016 L’identifiant technique du fichier nedoit pas être renseigné,

CTRL_PJU_0017 Dans le système, le type indiqué doitêtre associé à la catégorie indiquée,

CTRL_PJU_0019 La sensibilité indiquée pour la piècejustificative correspond à son type,

CTRL_PJU_0020 La valeur de l’attribut « documentinterne » indiqué pour la piècejustificative doit correspondre à cellede son type,


L’application nationale retourne un fichier archive comprenant :– le fichier XML au format PJU décrivant les métadonnées modifiées.

Le fichier XML, contient les zones d’informations suivantes :• InterfaceNUU,• Entête avec le type de fichier valorisé à « RET »,• Demande• Pièce :

◦ le champ identifiant technique de la pièce est renseigné,◦ le champ sensibilité a été mis à jour si nécessaire,◦ les autres champs de la zone contiennent les valeurs transmises à l’ap-

pel,◦ la zone d’information « Création » a été mise à jour,◦ la zone d’information « Dernière action » a été mise à jour,◦ Fichier :

▪ le champ identifiant technique a été mis à jour,▪ le champ nom du fichier a été mis à jour,▪ la zone d’information « Dépôt « a été mise à jour.

4.2.4 - Modifier une pièce justificative d’une demande

Description :

L’objectif de ce service est de permettre de modifier une pièce justificative exis-tante ; cela implique de pouvoir modifier les métadonnées seules ou les métadon-nées et le fichier associé.



L’application appelante transmet :– un fichier archive contenant :

– le fichier XML au format PJU décrivant les métadonnées– le fichier PDF à associer à la pièce en remplacement de celui en place si né-

cessaire

Le fichier XML de pièce justificative transmis doit contenir les zones d’informationssuivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à « PJM »,• La zone d'information Demande complétée par le code guichet de l'applica-

tion appelante et le numéro unique de la demande concernée par la re-cherche

• Pièce :◦ le champ identifiant technique de la pièce doit être renseigné et être as-

socié à la demande citée,◦ le champ « dateFonctionnelle » pourra être absent ou vide◦ le champ « commentaires » pourra être absent ou vide◦ les champs « sensibilité » et « documentinterne » :

▪ peuvent être absents▪ seront testés s'ils sont présents. Le retour est non bloquant.

◦ les autres champs doivent être présents et renseignés,◦ la zone d’informations « Création » ne sera pas exploitée,◦ la zone d’informations « Dernière Action » ne sera pas exploitée,◦ Fichier :

▪ le champ identifiant technique du fichier ne doit pas être renseigné,▪ le champ nom du fichier peut être complété (ou non). Il doit alors cor-

respondre à un fichier existant dans l’archive,▪ la zone d’information Dépôt ne sera pas exploitée

Cas de la modification des métadonnées uniquement

La zone d’information fichier ne doit pas être renseignée dans le fichier en entrée.


Cas de la modification des métadonnées et du fichier joint

Le champ nom du fichier de la zone d’information fichier doit être renseigné dansle fichier en entrée.L’archive doit contenir un fichier PDF nommé selon la valeur contenue dans le champ nom dufichier de la zone d’information fichier.

Contrôles :



CTRL_FIC_0009 Le nom du fichier ZIP est conforme,

CTRL_FIC_0010 Le nom du fichier XML est conforme,

CTRL_FIC_0003 Le code guichet est cohérent,

CTRL_FIC_0004 Le flux XML est valide,

CTRL_FIC_0011 Le format du fichier ZIP doit êtrecorrect,

CTRL_FIC_0008 Le fichier ZIP doit contenir un fichierXML,



CTRL_PJU_0008 Le numéro unique indiqué dans lefichier XML correspond à celuiindiqué en paramètre.

CTRL_PJU_0006. La pièce justificative indiquée doitêtre connue du système.

CTRL_PJU_0010 La catégorie indiquée doit êtreconnue du système,

CTRL_PJU_0011 Le type indiqué doit être connu dusystème,

CTRL_PJU_0012 Le champ commentaire ne doit pascontenir plus de 1024 caractères,

CTRL_PJU_0013 L’indice de pertinence doit être connudu système,

CTRL_PJU_0014 Le champ « nom de fichier » doit êtrerenseigné.

CTRL_PJU_0015 Le contenu du champ « nom defichier » doit correspondre au nom du


fichier PDF inclus dans l’archive,

CTRL_PJU_0016 L’identifiant technique du fichier nedoit pas être renseigné,

CTRL_PJU_0017 Dans le système, le type indiqué doitêtre associé à la catégorie indiquée,

CTRL_PJU_0018 L’identifiant technique de la pièce doitêtre renseigné,

CTRL_PJU_0019 La sensibilité indiquée pour la piècejustificative doit correspondre à sontype,

CTRL_PJU_0020 La valeur de l’attribut « documentinterne » indiqué pour la piècejustificative doit correspondre à cellede son type,


L’application nationale retourne un fichier archive comprenant :– le fichier XML au format PJU décrivant les métadonnées modifiées.

Le fichier XML, contient les zones d’informations suivantes :• InterfaceNUU,• Entête avec le type de fichier valorisé à «RET»,• Demande,• Pièce :

◦ le champ identifiant technique de la pièce est renseigné,◦

◦ les autres champs de la zone contiennent les valeurs transmises à l’ap-pel,

◦ la zone d’information « Création » a été mise à jour, (en accord avec lesinformations stockées dans le SNE)

◦ la zone d’information « Dernière Action » a été mise à jour,◦ Fichier :

▪ le champ identifiant technique a été mis à jour,▪ le champ nom du fichier a été mis à jour,▪ la zone d’information « Dépôt » a été mise à jour.

4.2.5 - Supprimer des pièces justificatives d’une demande

Description :

Ce service permet à l’application consommatrice de supprimer des pièces justifi-catives associées à une demande.



L’application appelante transmet :• un fichier XML respectant le format MPJ renseigné, contenant les zones

d'informations suivantes :◦ InterfaceNUU,◦ Entête avec le type de fichier valorisé à « PJS »,◦ La zone d'information Demande complété par le code guichet de l'appli-

cation appelante et le numéro unique de la demande concernée par larecherche.

◦ la zone d'information « pieces » complétée par la liste des identifiantstechniques des pièces justificatives qu'il souhaite supprimer.

Contrôles :





CTRL_PJU_0005 La demande ne comporte pas depièces justificative.

CTRL_PJU_0006 La pièce justificative indiquée doitêtre connue du système.

CTRL_PJU_0007 Les pièces justificatives indiquéessont associées à la demandespécifiée.



L’application nationale confirme la réussite de l’opération.

L'application nationale retourne un fichier XML au format MPJ contenant les zonesd'informations suivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à «RET»,• Demande,• Pieces :

◦ la zone d'information « piece » de chaque piece supprimée est modifiéeafin de mettre à jour la zone d'information « dernière action » (date de lasuppression, type d'action = SUPP, acteur déduit du code guichet).

4.2.6 - Recenser les demandes ayant au moins une pièce justificative modifiée depuis une date

Description :

Ce service permet à l’application consommatrice de recenser l’ensemble des de-mandes ayant au moins une pièce justificative modifiée/ajoutée/supprimée depuisla date spécifiée.



d'informations suivantes :◦ InterfaceNUU,◦ Entête avec le type de fichier valorisé à « MPJ »,◦ La zone d'information Demande complété par le code guichet de l'appli-

cation appelante.◦ « Recensement » :

▪ le champ date « depuisle » renseigné▪ optionnellement, le champ date « jusqu’au » renseigné.


Contrôles :



CTRL_MPJ_0001 La date seuil doit être antérieure à ladate du jour.

CTRL_MPJ_0002 Aucune demande ne correspond à larecherche.

CTRL_MPJ_0003 Le nombre de demandes répondantà la recherche dépasse le seuilautorisé.

CTRL_MPJ_0004 Le format de la date doit être correct.

CTRL_MPJ_0005 La date Jusqu’à doit être postérieureà la date depuis.

CTRL_MPJ_0006 La date Jusqu’à doit être antérieure àla date du jour.


L’application nationale retourne un fichier archive comprenant :– pour chaque demande, un fichier XML reprenant la liste de l’ensemble de ses

pièces justificatives modifiées, ajoutée ou supprimée.

Le fichier XML, au format MPJ, contient les zones d’informations suivantes :• InterfaceNUU,• Entête avec le type de fichier valorisé à « RET »,• Demande• « Recensement » :

▪ le champ date « depuisle » renseigné avec la date indiquée à l'appel▪ le champ date « jusqu'au » renseigné avec la date d'exécution.

• Pièce (autant d’itération que de pièces concernées) :◦ le champ identifiant technique de la pièce est renseigné,◦ les autres champs de la zone sont absents◦ la zone d’information « Dernière Action » a été mise à jour,

4.2.7 - Récupérer le plan de classement

Description :

Ce service permet à l’application consommatrice de récupérer la description duplan de classement en vigueur dans le SNE afin de lui permettre d’exploiter les ca-tégories et types de pièces justificatives valides.



Le service n’attend pas d’attribut autre que ceux nécessaires à l’authentification.


d'informations suivantes :◦ InterfaceNUU,◦ Entête avec le type de fichier valorisé à « PCL ».◦ La zone d'information Demande complétée par le code guichet de l'ap-

plication appelante

Contrôles :

Tous les contrôles communs.


Un fichier archive comprenant le fichier XML au format MPJ, contient les zonesd’informations suivantes :

• InterfaceNUU,• Entête avec le type de fichier valorisé à « RET »,• PlanDeClassement et ses sous zones,

4.3 - Règles de nommage des fichiers XML et ZIP envoyés par le « SNE »

➢ Le nom du ou des fichiers ZIP contenant l’ensemble des réponses à une demandedédiée aux pièces justificatives, en émission de « SNE », suite à une demande deconsultation ou de recensement sera composé de :



Type de fichier Caractères (3) Constantes « ZLP »


Date-heure d’émission du fichier ZIP

Caractères(12)

AAAAMMDDHHMM identique à ladate et heure présente sur le fichier transmis à l'appel du service

Numéro d’ordre Numérique (6)

Numéro incrémental d’un ensemble de fichiers

Chaque zone devra être complétée par des zéros à gauche et séparée par untiret.

Exemple :

Guichet enregistreur : 00 125



Résultat :

ZLP00125-201002010304-000001.ZIP

Le certificat associé aura le nom suivant :

CER00125-201002010304.XXX

Un fichier ZIP donné peut regrouper des fichiers archives de type ZPJ (au formatZIP) ou des fichiers XML de type « MPJ » de recensements des pièces modifiéespar demande (au format XML) et/ou des réponses d’erreur (au format XML).

➢ Le nom du ou des fichiers ZIP contenant le descriptif d’une pièce justificative enémission du « SNE » sera composé de :


Type de fichier Caractères (3) Constantes « ZPJ »



Caractères(12)

AAAAMMDDHHMMidentique à la date et heure présente sur le fichier transmis à l'appel du service



Chaque zone devra être complétée par des zéros à gauche et séparée parun tiret.

Exemple :





Résultat :

ZPJ00125-201002010304-000001.ZIP


CER00125-201002010304.XXX

Un fichier ZIP donné peut regrouper des descriptifs de pièces justificatives(au format XML) et/ou des fichiers justificatifs (au format PDF) et/ou desréponses d’erreur (au format XML).

➢ Le nom des fichiers XML de description d'une pièce justificative en émission de« SNE » sera composé de :


Préfixe de fichier Caractères (3) Constantes selon le service consommé : « PJA», « PJM»,« PJC»,


Date-heure d’émissiondu fichier XML

Caractères(12) AAAAMMDDHHMM identique à la date et heure présente sur le fichier transmis à l'appel du service

Numéro d’ordre Numérique (6) Numéro incrémental


Exemple :




Résultat :

PJU00125-201002010304-000020.XML

Le nom du fichier XML de retour est le même que le nom du fichier XMLreçu.

➢ Le nom du fichier XML contenant la liste des pièces justificativesmodifiées/ajoutées/supprimées pour une demande suite à la consommation duservice de recensement des demandes de logement ayant au moins une piècejustificative modifiée en émission de « SNE » sera composé de :



Préfixe de fichier Caractères (3)

Constantes « MPJ»

Guichet Enregistreur Caractères (5)

Numéro de guichet identiqueau numéro présent sur le fichier de la demande

Date-heure d’émission du fichier XML

Caractères(12)

AAAAMMDDHHMM identique à la date et heure présente sur le fichier de la demande


Numéro incrémental identique au numéro présentsur le fichier de la demande

Exemple :

Guichet enregistreur présent sur le fichier de la demande : 00125

Date-heure d’émission sur le fichier de la demande : 01/02/2010 03:04


Résultat : MPJ00125-201002010304-000020.XML

Ce fichier est spécifique au web service de recensement des demandesayant des pièces justificatives modifiée depuis la date seuil spécifiée.

➢ Le nom du fichier XML contenant le résultat de la demande de suppression depièces justificatives d'une demande de logement social en émission de « SNE »sera composé de :


Préfixe de fichier Caractères (3) Constantes « PJS »

Guichet Enregistreur Caractères (5) Numéro de guichet identiqueau numéro présent sur le fichier de la demande



Numéro d’ordre Numérique (6) Numéro incrémental identique au numéro présentsur le fichier de la demande

Exemple :




Résultat : PJS00125-201002010304-000020.XML

Ce fichier est spécifique au web service de recensement des demandes


ayant des pièces justificatives modifiée depuis la date seuil spécifiée.

➢ Le nom du fichier XML contenant le résultat de la demande de récupération du plande classement sera composé de :


Préfixe de fichier Caractères (3) Constantes « PCL»

Guichet Enregistreur Caractères (5) Numéro de guichet identiqueau numéro présent sur le fichier de la demande



Exemple :



Résultat : PCL00125-201002010304.XML

4.4 - Récapitulatif des formats des échanges

Service EntréeType (Format)

Zip SortieType (Format)

Zip

Ajout de PJ PJA ( PJU) Oui RET (PJU) Oui

Modification de PJ PJM (PJU) Oui RET (PJU) Oui

Suppression de PJ PJS (MPJ) Non RET (MPJ) Non

Liste les PJ d'une demande PJL (MPJ) Non RET (PJU) Oui

Consultation des PJ d'une demande PJC (MPJ) Non RET (PJU) Oui

Recenser les demandes ayant des PJmodifiées

MPJ (MPJ) Non RET (MPJ) Oui

Plan de classement PCL (PCL) Non RET (PCL) Oui

5 - Contrôles et messages d’erreur dans les fichiers d’interface

➢ Les messages d'anomalies contiendront le nom de la zone d’informations oùl'anomalie a été identifiée. Certains contrôles sont non bloquants (ils sont précisésau cas par cas) et le message associé débute par « REMARQUE ».


Message : « Informations « Nom de la zone d’informations » : messaged'anomalie »

➢ Les noms des zones d’informations sont précisées dans la description de lastructure du fichier XML. (ex : « Zone d’informations : Pièce – Dernière Action »).

➢ Les anomalies identifiées seront indiquées dans le fichier XML si celui-ci estaccessible.

➢ Si le fichier n’est pas accessible :

◦ dans le cas du traitement synchrone, l’enveloppe SOAP supportera lesinformations de l’erreur


5.1 - Contrôles sur le fichier réceptionné (XML ou ZIP)

CTRL_FIC_0003 : Le code guichet doit être cohérent

Le code du guichet présent dans le fichier XML doit être identique à celui indiquédans le nom du fichier XML. Dans le cas contraire un message d’erreur est généré.

Détail de l'erreur

Code ERRFIC0003

Propriété

Message Le code guichet contenu dans le fichier diffère de celuiprésent dans le nom du fichier

Comportement attendu du système privatif

réémettre le flux après avoir vérifié le code guichet contenu dansle nom du fichier XML et celui contenu dans le fichier XML.

NB : Ce cas ne devrait arriver qu'en phase de mise au point.

CTRL_FIC_0004 : Le flux XML doit être valide

Les informations de structure XML seront vérifiées au travers du fichier XSD. Lescontrôles se limitent au respect des balises (cardinalité) et des types des données(caractère, numérique, booléen et date). Dans le cas contraire, l'application génèrele message d'anomalie suivant :

Détail de l'erreur

Code ERRFIC0004

Propriété

Message Votre fichier XML « xxxxxxxxxxx » ne respecte pas ladéfinition de l’interface. Veuillez SVP contrôler votrefichier avec le XSD pour obtenir des informations surla ou les corrections à apporter.


réémettre le flux après avoir corrigé le fichier XML de la piècejustificative.


Dans le cas d'un échange synchrone, l'anomalie est retournée dans l'enveloppeSOAP.


CTRL_FIC_0007 : Le fichier ZIP doit contenir un fichier XML et unfichier PDF

Le contenu du fichier archive de type ZPJ chargé de décrire une pièce justificativetransmise et de son fichier attaché devra contenir les éléments attendus à savoir :

– un fichier XML de description d'une pièce justificative– un fichier PDF

Détail de l'erreur

Code ERRFIC0007

Propriété

Message L'archive ne contient pas le fichier XML et le fichierPDF attendus.


réémettre le flux après avoir corrigé le contenu du fichier ZIP dela demande.


CTRL_FIC_0008 : Le fichier ZIP doit contenir un fichier XML

Le contenu du fichier archive de type ZPJ chargé de décrire une pièce justificativetransmise sans son fichier attaché devra contenir les éléments attendus à savoir :

– un fichier XML de description d'une pièce justificative

Détail de l'erreur

Code ERRFIC0008

Propriété

Message L'archive ne contient pas le fichier XML attendu.


réémettre le flux après avoir corrigé le contenu du fichier ZIP dela demande.


CTRL_FIC_0009 : Le nom du fichier ZIP doit être conforme


➢ Le nom du ou des fichiers ZIP contenant le descriptif de la pièce justificative enréception de « SNE » devra être composé de :


Type de fichier Caractères (3) Constantes« ZPJ »



Caractères(12)

AAAAMMDDHHMM



Chaque zone devra être complétée par des zéros à gauche et séparée par untiret.

Exemple :




Résultat :

ZPJ00125-201002010304-000001.ZIP


CER00125-201002010304.XXX

Sinon, le système génère le message d’anomalie suivant :

Détail de l'erreur

Code ERRFIC0009

Propriété

Message Le nom du fichier ZIP des pièces justificatives« XXXXXXXXXXX.ZIP» n’est pas conforme


réémettre le flux après avoir respecté le nom du fichier.


CTRL_FIC_0010 : Le nom du fichier XML doit être conforme

Le nom des fichiers XML de description d'une pièce justificative en réception de« SNE » devra être composé de :



Préfixe de fichier Caractères (3)

Constantes , selon le service consommé : « PJA», « PJM»

Guichet Enregistreur Caractères (5)

Numéro de guichet de l’émetteur

Date-heure d’émission du fichier XML

Caractères(12)

AAAAMMDDHHMM


Numéro incrémental


Exemple :




Résultat :

PJA00125-201002010304-000020.XML

Le nom du fichier XML de retour est le même que le nom du fichier XML reçu

Sinon, l'application génère le message d’anomalie suivant :

Détail de l'erreur

Code ERRFIC00010

Propriété

Message Le nom du fichier XML descriptif d'une piècejustificative « XXXXXXXXXXXX.XML» n’est pasconforme


réémettre le flux après avoir respecté le nom du fichier XML.

NB : Ce cas ne devrait arriver qu’en phase de mise au point.

CTRL_FIC_0011 : Mauvais format de ZIP

Si le format du fichier ZIP (ou de l'un des fichiers provenant de la même émission)n'est pas bon, alors le fichier (ou l'émission dans sa totalité) est ignoré.À savoir :

– si l'archive n'est pas au format ZIP– si l'archive contient des répertoires


–

– si une erreur a lieu lors de la décompression de l'archive

Détail de l'erreur

Code ERRFIC0011

Propriété

Message Le format du fichier ZIP des pièces justificatives« XXXXXXXXXXXXXXX.zip » n'est pas conforme.


réémettre le flux après avoir corrigé le fichier ZIP de la demande.


Dans le cas d'un échange synchrone, l'anomalie est retournée dans l'enveloppeSOAP.


Le nom des fichiers XML de demande de recensement, de suppression ou derécupération des pièces justificatives d'une demande en réception de « SNE »devra être composé de :


Préfixe de fichier Caractères (3) Constantes, selon le service consommé : « PJL », « MPJ », « PJS »



Caractères(12) AAAAMMDDHHMM



Exemple :




Résultat :

PJL00125-201002010304-000020.XML




Détail de l'erreur

Code ERRFIC00012

Propriété

Message Le nom du fichier XML descriptif d'une piècejustificative « XXXXXXXXXXXX.XML» n’est pasconforme





Le nom des fichiers XML de demande de récupération du plan de classement enréception de « SNE » devra être composé de :


Préfixe de fichier Caractères (3) Constantes, selon le service consommé : « PCL»



Caractères(12) AAAAMMDDHHMM



Exemple :




Résultat :

PCL00125-201002010304-000020.XML



Détail de l'erreur


Code ERRFIC00013

Propriété

Message Le nom du fichier XML descriptif d'une piècejustificative « XXXXXXXXXXXX.XML » n’est pasconforme




5.2 - Contrôles sur le code guichet

CTRL_GUI_0001 : Le nom du certificat doit être conforme

Le nom du certificat doit être conforme (cf 3.4.3 Gestion de l'authentification).

Détail de l'erreur

Code ERRGUI0001

Propriété

Message Le nom du certificat associé« XXXXXXXXXXXX.XXX » n’est pas conforme

CTRL_GUI_0002 : Le code du guichet doit être connu du référentiel

Le code du guichet doit être connu du référentiel.

Détail de l'erreur

Code ERRGUI0002

Propriété

Message Le code guichet est inconnu du référentiel


Vérifier le code guichet contenu dans le nom du certificattransmis en flux synchrone et/ou le code guichet transmis dansle fichier XML de la demande (balise XML numGuichet).


Contacter le gestionnaire territorial pour vérification duparamétrage de votre code guichet.

CTRL_GUI_0003 : Le guichet associé au code guichet doit êtrevalide

Le guichet associé au Code guichet doit être valide au moment du traitement de lademande (début / fin de validité).

Détail de l'erreur

Code ERRGUI0003

Propriété

Message Le guichet n’est plus actif. Contactez votregestionnaire territorial


Contacter le gestionnaire territorial pour la mise à jour duparamétrage du guichet dans l'application SNE, car celle-ciconsidère que le guichet n'est plus ou pas encore actif.

CTRL_GUI_0004 : Le certificat reçu doit être valide

Le certificat reçu doit être valide, c'est-à-dire que la date de début de validité ducertificat doit être antérieure ou égale à la date du jour et que la date de fin devalidité doit être postérieure ou égale à la date du jour. Dans le cas contraire, unmessage d’erreur est généré.

Détail de l'erreur

Code ERRGUI0004

Propriété

Message Le certificat fourni n’est pas valide (dates de validités).


Renouveler votre certificat.

L'application nationale envoie un message d'alerte de fin de viedu certificat 2 mois avant la date de fin de validité du certificat, àl'adresse électronique utilisée pour les échanges asynchrones.

CTRL_GUI_0005 : Le guichet doit être authentifié

Le certificat fourni est comparé à celui associé au guichet enregistreur. En cas de


correspondance, le guichet enregistreur est authentifié. Dans le cas contraire, unmessage d’erreur est généré.

Détail de l'erreur

Code ERRGUI0005

Propriété

Message Le certificat fourni n’est pas compatible avec lecertificat connu par l’application pour ce guichetenregistreur.


Vérifier le certificat transmis et le code guichet utilisé.

Si le message d'erreur persiste, contacter le gestionnaireterritorial pour vérifier le certificat paramétré sur l'applicationnationale.


5.3 - Contrôles portant sur les pièces justificatives associées à une demande

CTRL_PJU_0022 : Description des listes de codes paramétrablesvérifiés à la réception du fichier

Code (Max: 6c) Libellé (Max: 125c). CommentairesListeTypeAction

CREA Création

MOD Modification

DEPOT Dépôt de fichier

SUPPR Suppression de PJ

ListeTypeFichier

CRE Création

MOD Modification

RAD Radiation

REN Renouvellement

SUP Suppression

DIS Dispatching

RET Retour

COP Copie numérique

MPJ Liste de pièces justificative

PCL Plan de classement

PJA Ajout d'une pièce justificative

PJC Consultation de pièces justificatives

PJM Modification d'une pièce justificative

PJL Recensement de pièces justificatives

PJS Suppression de pièces justificatives

ListeIndicePertinence

ACC Acceptable

INE Inexploitable

HP Hors Périmètre

NA --

Remarque : Les noms associés à chaque liste de valeurs sont utilisésdans la définition de la structure du fichier XML de l’interface.

Pour les champs dont les valeurs possibles sont définies dans une liste paramé-trable, le message d’anomalie comprendra la liste des valeurs attendues si lechamp est obligatoire. Le message généré est le suivant :

Détail de l'erreur

Code ERRPJU0022


Propriété XXXXX.YYYY[i].ZZZZavec XXXXX.YYYY.ZZZZ le nom de la propriétédans l’arborescence XML et 'i' le numérod’occurrence.

Message « Informations « XXXXX.YYYY » (Occurrence : [i] s’ily a n enregistrements dans cette zone): La valeur dechamp « ZZZZ » ne correspond pas une des valeursde la liste « Nom de la liste ».Les valeurs possiblessont (Val1; Val2; Val3)»


Vous devez modifier le code de la valeur et réémettre le flux.

CTRL_PJU_0001 : Un numéro unique doit être fourni en entrée

Le consommateur du service doit transmettre en entrée un numéro unique correctementformaté à savoir 18 caractères :

Détail de l'erreur

Code ERRPJU0001

Propriété

Message Le numéro unique fourni en entrée est videou mal formaté.


Vérifier le numéro unique;

CTRL_PJU_0002 : La demande de logement doit être connue

La demande de logement doit être connue au sein de l'application, et être affectée au territoirede visibilité du guichet connecté. Dans le cas contraire, l'application génère le messaged'anomalie suivant :

Détail de l'erreur

Code ERRPJU0002

Propriété XXXX : numéro unique fourni en entrée

Message « Information XXXX : La demande delogement « XXXXX » n’existe pas dans lesystème ».



Vérifier le numéro unique ;vérifier que cette demande n'a pas été supprimée : flux « SUP »reçu en dispatching

CTRL_PJU_0003 : Les catégories indiquées doivent être connues dusystème

Les catégories indiquées lors de l'appel doivent être connues du système. Dans le cascontraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU0003

Propriété XXXX,YYYY : Codes des Catégories fournis enentrée

Message « Informations « XXXXX» : Le code decatégorie n’existe pas dans le système ».


Vérifier les catégories indiquées.

CTRL_PJU_0004 : La demande comporte au moins une piècejustificative des catégories demandées

Si la demande de logement ne comporte pas de pièces justificatives des catégories indiquéeslors de l'appel du service, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code MESSPJU0004

Propriété ZZZZ : numéro uniqueXXXX,YYYY : Codes des Catégories fournis enentrée

Message « La demande ZZZZ ne comporte aucunepièce justificative des catégoriesXXXX,YYYY ».

CTRL_PJU_0005 : La demande comporte au moins une piècejustificative

Si la demande de logement ne comporte pas de pièces justificatives, l'application génère lemessage d'anomalie suivant :


Détail de l'erreur

Code MESSPJU0005

Propriété ZZZZ : numéro uniqueXXXX, YYYY : Codes des Catégories fournis enentrée

Message « La demande ZZZZ ne comporte aucunepièce justificative ».

CTRL_PJU_0006 : La pièce justificative indiquée doit être connue dusystème

La pièce justificative indiquée doit être connue au sein de l'application. Dans le cas contraire,l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU0006

Propriété XXXX : identifiant technique de la pièce justificative

Message « Informations « XXXXX» : La piècejustificative n'est pas connue du système ».


Vérifier l'identifiant de la pièce justificative.

CTRL_PJU_0007 : Les pièces justificatives indiquées sont associées àla demande spécifiée.

Toutes les pièces justificatives indiquées doivent être associées à la demande spécifiée. Dansle cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU007

Propriété ZZZZ : numéro uniqueXXXX, YYYY : identifiants techniques des piècesjustificatives

Message « Informations « XXXX,YYYY» : Au moinsune de ces pièces justificatives n'est pasassociée à la demande « ZZZZ ». »


Vérifier l'identifiant de la pièce justificative.


CTRL_PJU_0008 : Le numéro unique indiqué dans le fichier XML jointdoit correspondre à celui indiqué en argument.

Le numéro unique précisé dans le fichier descriptif de la pièce justificative doit correspondre àcelui transmis en argument d'appel du service. Dans le cas contraire, l'application génère lemessage d'anomalie suivant :

Détail de l'erreur

Code ERRPJU008

Propriété ZZZZ : numéro unique en argumentXXXX : numéro unique contenu dans le fichierdescriptif de la pièce YYYY : identifiant technique de la pièce

Message « Informations « ZZZZ » : le numéro uniquene correspond pas au numéro unique XXXXindiqué pour la pièce YYYY »


Vérifier la cohérence de la demande (accord entre le numéro dedemande indiqué et le fichier XML transmis.

CTRL_PJU_0009 : L'identifiant technique de la pièce doit être nonrenseigné

Lors de l'ajout d'une pièce justificative à une demande, l'identifiant technique ne doit pas êtrerenseigné. Dans le cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU009

Propriété YYYY : identifiant technique de la pièce

Message « Informations « YYYY » : Dans le cas d'unajout de nouvelle pièce justificative,l'identifiant technique ne doit pas êtreinitialisé.


Supprimer l'information interdite

CTRL_PJU_0010 : La catégorie indiquée doit être connue du système

Lors de l'ajout ou la modification d'une pièce justificative, la catégorie indiquée pour celle-ci doitêtre connue du système. Dans le cas contraire, l'application génère le message d'anomaliesuivant :


Détail de l'erreur

Code ERRPJU010

Propriété YYYY : Catégorie de la pièce

Message « Informations « YYYY » : La catégorieindiquée est inconnue du système.


Modifier la catégorie afin d'utiliser une catégorie connue du SNEÉventuellement faire appel au web-service d'obtention du plan declassement pour connaître les catégories valides.

CTRL_PJU_0011 : Le type indiqué doit être connu du système

Lors de l'ajout ou la modification d'une pièce justificative, le type indiqué pour celle-ci doit êtreconnu du système. Dans le cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU011

Propriété YYYY : Type de la pièce

Message « Informations « YYYY » : Le type indiqué estinconnu du système.


Modifier le type afin d'utiliser un type connu du SNEÉventuellement faire appel au web-service d'obtention du plan declassement pour connaître les types valides.

CTRL_PJU_0012 : Le champ commentaire ne doit pas dépasser lataille maximale

Lors de l'ajout ou la modification d'une pièce justificative, le commentaire associé à la pièce nedoit pas excéder 1024 caractères. Dans le cas contraire, l'application génère le messaged'anomalie suivant :

Détail de l'erreur

Code ERRPJU012

Propriété commentaire

Message « Le commentaire associé à la pièce ne doitpas excéder 1024 caractères. »



Modifier le commentaire.

CTRL_PJU_0013 : L'indice de pertinence doit être connu du système

Lors de l'ajout ou la modification d'une pièce justificative, la valeur de l'indice de pertinence doitêtre connu du système. Dans le cas contraire, l'application génère le message d'anomaliesuivant :

Détail de l'erreur

Code ERRPJU013

Propriété « XXX" indicePertinence

Message « L'indice de pertinence indiqué n'est pasconnu du système. »


Modifier le code de l'indice de pertinence à affecter.Éventuellement faire appel au web-service d'obtention du plan declassement pour connaître les codes valides.

CTRL_PJU_0014 : Le champ « nom fichier » doit être renseigné

Lors de l'ajout d'une pièce modificative, le fichier XML transmis doit contenir la section fichier,avec le nom du fichier PDF à associer à la pièce justificative. Dans le cas contraire, l'applicationgénère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU014

Propriété

Message « Le nom du fichier à associer à la pièce estobligatoire. »


Compléter le fichier XML transmis

CTRL_PJU_0015 : Le nom de fichier indiqué doit correspondre aufichier transmis.

Lors de l'ajout ou la modification d'une pièce justificative, impliquant une action sur le fichierPDF, le nom de fichier indiqué dans le XML doit correspondre au fichier PDF inclus dans lefichier archive. Dans le cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur


Code ERRPJU015

Propriété « XXXX » : nomFichier« YYYY » : nom du fichier PDF joint dans l'archive

Message « information XXXX : Le nom du fichierindiqué ne correspond pas au fichier jointYYYY. »


Compléter le fichier transmis ou modifier l'archive.

CTRL_PJU_0016 : L'identifiant technique du fichier ne doit pas êtrerenseigné.

Lors de l'ajout ou la modification d'une pièce justificative, impliquant une action sur le fichierPDF, l'identifiant technique du fichier ne doit pas être renseigné, il sera complété par le SNE etindiqué en retour. Dans le cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU016

Propriété

Message « L'identifiant technique du fichier joint ne doitpas être renseigné. »


Modifier le fichier XML

CTRL_PJU_0017 : Le type et la catégorie indiqués pour la piècejustificative doivent être en accord avec le plan de classement.

Lors de l'ajout ou la modification d'une pièce justificative, le type et la catégorie indiqués doiventêtre en accord avec le plan de classement en place. Dans le cas contraire, l'application génèrele message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU017

Propriété « XXXX » : Type de la pièce« YYYY » : catégorie de la pièce

Message « information XXX » : Ce type ne correspondpas à un type de la catégorie YYYY »




Éventuellement faire appel au web-service d'obtention du plan declassement pour connaître les codes valides.

CTRL_PJU_0018 : L'identifiant de la pièce justificative doit êtrerenseigné dans le fichier XML.

Lors de la modification d'une pièce justificative, l'identifiant de la pièce à modifier doit êtrerenseigné. Dans le cas contraire, l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU018

Propriété

Message « L'identifiant technique de la pièce doit êtrerenseigné. »



CTRL_PJU_0019 : Le niveau de sensibilité de la pièce doitcorrespondre à celui de son type.

Lors de l'ajout ou de la modification d'une pièce justificative, le niveau de sensibilité indiqué doitcorrespondre à celui affecté par le SNE au type indiqué. Dans le cas contraire, l'applicationgénère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU018

Propriété « XXXX » : sensibilité« YYYY » : type

Message « information XXXX » : ce niveau desensibilité ne correspond à la sensibilité desdocuments du type YYYY. »


Modifier le fichier XMLÉventuellement faire appel au web-service d'obtention du plan declassement pour connaître le niveau de sensibilité des typesdéfinis.

CTRL_PJU_0020 : La valeur de l’attribut « documentInterne » de lapièce doit correspondre à celle de son type.

Lors de l'ajout ou de la modification d'une pièce justificative, l'attribut « Document interne » doitcorrespondre à celui affecté par le SNE au type de document indiqué. Dans le cas contraire,


l'application génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU020

Propriété « XXXX » : documentInterne« YYYY » : type

Message « information XXXX » : la valeur de l'attributdocumentInterne ne correspond pas à celleattendue pour des documents du type YYYY.»


Modifier le fichier XMLÉventuellement faire appel au web-service d'obtention du plan declassement pour connaître la valeur acceptable de cet attributpour les types définis.

CTRL_PJU_0021 : Le type de fichier doit être autorisé

La réception de fichier XML est autorisée seulement pour les types de fichier : PJU.Dans le cas contraire, le système génère le message d'anomalie suivant :

Détail de l'erreur

Code ERRPJU0021

Propriété typeFichier

Message Le type de fichier XXX est incompatible en réceptionde fichiers. Le type de fichier autorisé en réceptionpour la gestion des pièces justificative est PJU.


réémettre le flux après avoir mis à jour le type de fichier.



5.4 - Contrôles portant sur le recensement des demandes ayant des pièces modifiées

CTRL_MPJ_001 : La date Depuis doit être antérieure à la date du jour.

Détail de l'erreur

Code ERRPMPJ0001

Propriété XXXX : dateDepuis.

Message « Informations « XXXXX » La date depuis indiquéeen paramètre doit être antérieure à la date du jour »


Modifier le paramètre et réémettre le flux.

CTRL_MPJ_002 : Aucune demande ne correspond à la de recherche.

Détail de l'erreur

Code MESSMPJ0002

Propriété

Message « Aucune demande ne correspond à la recherche »

CTRL_MPJ_003 : Le nombre de demandes répondant à la recherchedépasse le seuil autorisé.

Détail de l'erreur

Code ERRPMPJ0003

Propriété XXXX : dateDepuis.YYYY : dateJusque. (Si indiqué)

Message « Informations « XXXXX (à YYYY) » La périodecorrespond à un nombre de demandes trop élevé »


Réduire la période de la demande et réémettre le flux.

CTRL_MPJ_004 : Le format de la date doit être correct.


Détail de l'erreur

Code ERRPMPJ0004


Message « Informations « XXXXX, (YYYY) » Le format de ladate est erroné. »


Corriger la date et réémettre le flux.

CTRL_MPJ_005 : La date Jusque doit être postérieure à la date Depuis.

Détail de l'erreur

Code ERRPMPJ0005


Message « Informations « XXXXX, (YYYY) » La date Jusquedoit être postérieure à la date Depuis. »



CTRL_MPJ_006 : La date Jusque doit être antérieure à la date du jour.

Détail de l'erreur

Code ERRPMPJ0005


Message « Informations « XXXXX, (YYYY) » La date Jusquedoit être antérieure à la date du jour. »




6 - Fonctionnalités d'administration

Ces fonctionnalités de l'outil ne sont pas directement accessibles aux partenaires.Cependant, les gestionnaires territoriaux en charge de la relation avec les parte-naires possèdent des outils permettant de s'assurer du bon fonctionnement del'application « SNE ».

6.1 - Traçabilité des échanges

Permet de tracer les échanges avec les guichets enregistreurs. Si le guichetenregistreur n’est pas identifié, les anomalies seront tracées dans un fichier delog et non en base.

Tracer un échange suite à une entrée : depuis l’appel de service modesynchrone.

Tracer un échange suite à une sortie : depuis l’appel de service modesynchrone.

Description d'une trace

Champs Type Description ou liste de valeurs

Code guichet Caractères (5)SIREN/SIRET Caractères (14)Type de mouvement Caractère (1) ListeEntreeSortie:

- E: Entrant- S: Sortant

Nature de l’échange Caractères (3) ListeTypeFichier :• CRE : Créer une demande• MOD : Modifier une demande• REN : Renouveler une demande• RAD : Radier une demande• SUP : Supprimer une demande• ATT : Attestation• RET : Fichier retour• PRE : Préavis de renouvellement• COP : Copie numérique• MPJ : Recensement des demandes avec

PJ modifiée• PCL : Plan de classement• PJC : Demande consultation de PJ• PJS : Demande suppression de PJ• PJA : Ajout d'une PJ• PJM : Modification d'une PJ

Date de création de la trace Date-HeureNom du fichier Caractères (50) Nom du fichier réceptionné ou émisAnomalie de traitement Booléen Valeur par défaut ‘NON’typeEchange Caractères (3) ListeTypeEchange :

- WEB : Application WEB (WebApp)- WS : WebService- AS1 : Dépôt asynchrone en configuration 1

bis- AS2 : Dépôt asynchrone en configuration 2- BAT : Batch


7 - Contact

Maîtrise d'œuvre / Assistance nationale SNE: assistance-nationale-nuu-editeur[at]developpement-durable.gouv.fr


Ministère de l’Égalitédes territoires et du Logement

Secrétariat généralTour Pascal A

92055 La Défense cedex

Tél.01 40 81 21 22

www.territoires.gouv.fr

Dossier des Interfaces - Logementsne.info.application.logement.gouv.fr/IMG/pdf/NUU... · développe...

Documents

Transcript of Dossier des Interfaces - Logementsne.info.application.logement.gouv.fr/IMG/pdf/NUU... · développe...