CLA DMS / X’GLASS

 

 

 

Projet : Portail X’Glass

Cahier de Liaison Applicative
(CLA)

Interface XAT2
V2 DMS

 

Historique des Versions

Auteur(s)

Version

Date Version

Création ou nature de la modification

Auteurs

Validation

VT 0.1

11/12/2012

Création du document

SRA

VT 0.2

19/12/2012

Ajout numéro agrément de l’assurance :

en page 25 : ajout du paragraphe 5.8.2 Dossier

en page 18 : Suppression import statut dossier

SRA

 

SOMMAIRE

1 Introduction    3

1.1 Applications concernées    3

1.2 Objectifs    3

1.3 Contraintes    3

2 Engagement des parties    3

2.1 Initialisation    3

3 Management    4

3.1 Planning    4

3.2 Modalités de réception    4

3.3 Avancement des travaux et communications    5

4 Spécification générale    5

4.1 Principes / impacts de l’interface    5

4.2 Données fonctionnelles à échanger et traitements    5

4.3 Besoins sûreté-sécurité de la liaison    6

5 Description détaillée de l’interface    7

5.1 Schéma d’ensemble des traitements    7

5.2 Caractéristiques de l’interface    11

5.3 Connexion à l’interface    12

5.4 Services    14

5.5 Structure globale des messages XAT2V2    16

5.6 Gestion des messages    17

5.7 Données échangées : DMS è Portail X’Glass    17

5.8 Données échangées : Portail X’Glass è DMS    25

 

  1. Introduction

    1. Applications concernées

      1. DMS

Définir succinctement l’application partenaire de la liaison (généralement le côté « client » de l’interface), rappeler ses objectifs et indiquer les acteurs impliqués par l’application.

Parties prenantes de DMS :

Rôle

Nom

Service

Maître d’ouvrage

Maître d’œuvre

  1. Portail X’Glass

Le Portail X’Glass est un environnement collaboratif à l’attention des réparateurs et des assureurs permettant la constitution et la validation de devis « Bris de Glace ». Sur réception de la facture via DARVA, le portail peut aussi valider automatiquement la facture sur la base du devis validé.

Parties prenantes du Portail X’Glass :

Rôle

Nom

Service

Maître d’ouvrage

Ludovic Roussin

Service MRK/GRC

Maître d’œuvre

François Hamel

Direction Informatique

  1. Objectifs

L’objectif de cette interface est de permettre une intégration entre DMS et le portail X’Glass afin d’éviter la double saisie des informations dans les deux systèmes.

  1. Contraintes

Le transport des données sera assuré par le protocole XAT2 v2 (propriété d’ETAI).

  1. Engagement des parties

Le but de l’établissement de ce cahier de liaison applicative est de garantir aux clients utilisateurs un niveau de service optimal sur la partie interface des deux applications, ceci par un engagement formel à maintenir cette interface dans un état de bon fonctionnement. Cet engagement est à prendre par les MOE et chefs de projet Informatique de ces applications.

  1. Initialisation

    1. Initialisation et mises à jour du CLA

  • C’est le Maître d’œuvre de l’application fournisseur (Portail X’Glass) qui est responsable de l’initialisation, ainsi que des mises à jour du CLA.
  • Le CLA doit être validé et signé par les différents acteurs concernés avant la mise en opérationnel de l’interface (cf. Liste des signataires en page de garde du présent document).
  • Le CLA peut être révisé à la demande de l’un des signataires, il est alors soumis à un nouveau processus complet de validation et de signature et à une rediffusion du cahier.
  • Le Maître d’œuvre de l’application fournisseur (Portail X’Glass) doit informer son homologue client de toute opération ponctuelle (mise à jour des données, modification du format d’envoi) et ceci au plus tard lorsque les spécifications détaillées sont figées.
  1. Suivi de la mise en œuvre du CLA et actions

Tout retard dans les délais prévus est signalé à l’autre projet dès lors que ce retard a une conséquence sur le projet communicant. Des solutions dégradées sont alors mises en place dans les plus brefs délais si ces dernières permettent de débloquer les tâches du projet receveur.

Application fournisseur (Portail X’Glass)

Application cliente (DMS)

Le MOA doit :

  • valider les risques sûreté et sécurité induits par l’évolution et partager les mêmes besoins sûreté sécurité
    • prévenir au plus tôt le Responsable le MOA de l’application cliente de toute évolution dans la structure du flux renvoyé
    • tenir compte des contraintes de l’application cliente pour la planification de ces modifications
  • assurer la recette fonctionnelle de toute évolution dans les délais négociés

Le MOA doit :

  • valider les risques sûreté et sécurité induits par l’évolution et partager les mêmes besoins sûreté sécurité
    • informer au plus tôt le MOA de l’application fournisseur de son intention d’utiliser de nouvelles données et à en négocier les modalités d’utilisation à l’initialisation et lors de modification de celles-ci.
    • adapter sa planification de prise en compte des modifications aux contraintes de recette et de mise en opérationnel de l’application fournisseur.
    • assurer la recette fonctionnelle des modifications dans les délais négociés
    • donner l’accord de mise en opérationnel après la recette fonctionnelle
  • informer le MOA de l’application fournisseur si l’interface devient inutile

Le MOE doit :

  • prendre en compte les besoins sûreté sécurité en décidant des mesures sûreté sécurité ad’hoc cohérentes
    • prévoir une recette technique des modifications
    • prévoir un serveur de test avec des accès pour le client afin de valider l’interface
    • assurer la coordination de la mise en opérationnel des modifications avec l’accord du MOA de l’application cliente
  • informer son homologue client de toute opération ponctuelle sur les entités communes (mise à jour de masse, purges, etc.…)

Le MOE doit :

  • prendre en compte les besoins sûreté sécurité en décidant des mesures sûreté sécurité ad hoc cohérentes
    • réaliser les modifications dans les délais négociés en accord avec le MOA
    • faire la recette technique.
    • prévoir un serveur de test avec des accès pour le fournisseur afin de valider l’interface
  • assurer la mise en opérationnel en relation avec l’application fournisseur
  1. Management

    1. Planning

Tâche

DMS

Portail X’Glass

Fin des développements

A définir

A définir

Fin 1er phase de test (application seule)

A définir

A définir

Phase de test avec DMS

A définir

Phase de pilotage

A définir

  1. Modalités de réception

Participants, responsabilités, formulaires de validation de la recette.

  1. Avancement des travaux et communications

Pour les notes et comptes-rendus d’avancement : délais de diffusion, rédacteur, destinataires, modalités de validation.

Pour les réunions : périodicité, objet, ordre du jour, participants, rédaction du CR, responsable du suivi des actions à mener.

  1. Spécification générale

    1. Principes / impacts de l’interface

Cette interface doit permettre à DMS :

  • de déléguer la constitution d’un dossier ou d’un devis rapide « Bris de Glace » au portail X’Glass ; certaines informations pourront être saisies dans DMS et transmises au portail pour faciliter la constitution du dossier et éviter la saisie en double des mêmes informations (en particulier la pop-up de création de dossier assuré pourra être pré-remplie en fonction de ce qui est envoyé) ;
  • d’accéder directement dans le portail à un dossier « Bris de Glace » précédemment créé, ou à la messagerie d’un dossier ;
  • de récupérer le contenu d’un dossier (en particulier le devis) à partir de son id DMS, en mode Web Service, c’est-à-dire, sans passer par l’IHM du portail ;
  • et, de façon moins prioritaire, de récupérer le statut d’un ou plusieurs dossiers afin de permettre la mise en place côté DMS d’un tableau de bord pour suivre les dossiers sans avoir à revenir dans le portail.

Notes :

  • Cette interface permet la création de devis « Bris de Glace » assuré ET rapide.
  • Le portail X’Glass en mode interfacé n’est pas limité au dossier à l’origine de l’ouverture : l’utilisateur pourra traiter plusieurs dossiers dans la même session.
  1. Données fonctionnelles à échanger et traitements

    1. Liste des données

DMS è Portail X’Glass
Donnée

Description / commentaire

applicationID Identifiant de l’application.
dmslogin Identifiant de l’interface.
garagesharedID Identifiant du garage.
usersharedID Identifiant de l’utilisateur.
dossier Objet contenant les informations du dossier transmises par DMS ; peut contenir l’id de dossier côté DMS, un type de dossier (assuré ou rapide), le réseau assurance, le taux de TVA, les taux de main d’œuvre (pour un devis rapide), les remises.
véhicule Objet contenant les caractéristiques du véhicule (facultatif) : marque (dictionnaire DARVA), immatriculation carte grise / carte verte, informations AAA-data pour éviter une interrogation AAA-data par le Portail X’Glass quand DMS a déjà fait l’appel à AAA-data.
client Objet contenant les informations sur le client (facultatif) : nom, prénom, raison sociale, adresse, prise en charge de la TVA, …
sinistre Objet contenant des informations sur les détails du sinistre (facultatif)

 

Portail X’Glass è DMS

Donnée

Description / commentaire

dossier Même objet qu’en entrée, mais complété des données renseignées dans le portail ou issues de traitements effectués dans le portail (ex : statut du dossier)
véhicule Idem
client Idem
sinistre Idem
devis Objet contenant tous les éléments constitutifs du dernier devis du dossier : statut du devis, la liste des pièces impliquées dans le chiffrage, la liste des opérations de temps, la liste des forfaits, la liste des ingrédients, ERD, remises pied de page, les montants du chiffrage, le n° d’accord (dans le cas d’un devis assuré)…
  1. Besoins en traitements

Les données échangées entre le portail et DMS via XAT2 v2 utilisent un système de dictionnaires et de références permettant de codifier les données selon la norme DARVA, selon la codification ETAI, ou les deux à la fois.

Pour faciliter le travail de transformation des données du dossier (issu du portail) en facture DARVA, on utilise la codification DARVA pour différents éléments tels que :

  • Les pièces et forfaits du devis
  • Les valeurs des combos des détails du sinistre (circonstance du sinistre, motif de déplacement, motif de non réparation)
  • Les marques (VW, Renault,…)

  1. Volumétrie et Fréquence – vision métier

Le tableau suivant est mis à titre indicatif. Libre au rédacteur d’ajouter ou supprimer des colonnes ou de donner la volumétrie sans tableau.

Nombre

moyen de

demandes / jour

Pic de

Demandes /
15 minutes

Taille moyenne
demande

DMS

Taille maximale
demande

DMS

Taille moyenne
réponse

Portail X’Glass

Taille maximale
réponse

Portail X’Glass

  1. Besoins sûreté-sécurité de la liaison

La sécurité adresse la protection face aux malveillances tandis que la sûreté constitue la protection face aux pannes. S’il est connu, décrire le dimensionnement du déploiement (nombre de sites par exemple) et d’autres critères liés à la sécurité ou à la sureté (limitation des connexions, …).

Fréquence :  à la demande

Volumétrie : xxx échanges / jour

Technologie : XAT2 v2

SI Fournisseur

SI Client

Enjeux / Commentaires

Portail X’Glass

DMS

Disponibilité du SI

OUI

OUI/NON

 Confidentialité du flux

NON

OUI/NON

Les données ne sont pas cryptées

Intégrité du flux

OUI

OUI/NON

 Traçabilité des accès

OUI

OUI/NON

 Perte de flux admise

OUI

OUI/NON

En cas de perte de flux, la demande peut être renouvelée. Les données stockées dans le portail X’Glass sont récupérables si on rouvre le même dossier.

Continuité de fonctionnement en cas de sinistre majeur flux

NON

OUI/NON

 

 

Application Client Stratégique

OUI/NON

Application Fournisseur Stratégique

OUI

  1. Description détaillée de l’interface

    1. Schéma d’ensemble des traitements

L’interface propose les 4 traitements (= services) suivants :

  • Traitement 1 (openFile) : ouverture de l’IHM
    • si le Portail X’Glass ne connaît pas l’id DMS, création d’un nouveau dossier dans le Portail X’Glass
    • si le Portail X’Glass connaît l’id DMS, réouverture d’un dossier existant dans le Portail :
      • Typiquement pour reprendre un dossier non terminé
      • Pour visualiser la messagerie associée au dossier
  • Traitement 2 (getFile) : DMS récupère le dossier créé dans le Portail X’Glass (appel Web Service, sans IHM) :
    • Typiquement après création du dossier dans le Portail, quand l’utilisateur retourne dans DMS.
    • À tout moment, en particulier quand un dossier passe au statut « Devis validé »
  • Traitement 3 (getFileStatuses) : DMS interroge le Portail X’Glass pour récupérer le statut des dossiers modifiés depuis une date donnée (appel Web Service, sans IHM)
  • Traitement 4 (deleteSession) : DMS demande la suppression de la session XAT2V2 ouverte lors du traitement 1.
  1. Étapes communes à tous les traitements : contrôle de la session et du message

Tous les traitements passent par une phase de contrôle de la session et du message en lui-même. Les parties spécifiques aux traitements sont explicitées dans les chapitres qui suivent.


  1. Étapes spécifiques au traitement 1

    1. Cas 1 : création d’un nouveau dossier

Après validation de la session et du message, le traitement consiste à retourner à DMS une URL permettant l’ouverture du Portail X’Glass (mode IHM) pour procéder à la constitution d’un dossier :


  1. Cas 2 : réouverture d’un dossier existant

Après validation de la session et du message, le traitement consiste à retourner à DMS une URL permettant l’ouverture du Portail X’Glass (mode IHM) pour accéder à un dossier  existant:


  1. Étapes spécifiques au traitement 2 : récupération d’un dossier

Après validation de la session et du message, le traitement consiste simplement à retourner le contenu du dossier (mode Web Service) :


  1. Étapes spécifiques au traitement 3 : récupération du statut des dossiers

Après validation de la session et du message, le traitement consiste simplement à retourner le statut des dossiers (mode Web Service) :


  1. Étapes spécifiques au traitement 4 : suppression de session

Après validation de la session et du message, le traitement consiste simplement à notifier de la bonne suppression de la session XAT2V2 (mode Web Service) :


  1. Caractéristiques de l’interface

    1. Type d’interface

L’interface repose sur le protocole XAT2 V2, qui permet à la fois :

  • d’accéder à l’application en mode IHM,
  • d’accéder aux données de l’application via des appels de type Web services.
  1. Condition d’appel / contexte

La seule condition d’appel des services du Portail X’Glass est d’avoir un identifiant de dossier DMS valide. Sans identifiant DMS, le portail X’Glass ne pourra pas faire le lien entre ses dossiers et les dossiers de DMS. Et sans ces liens, le Portail X’Glass ne pourra pas renvoyer les devis à DMS.

  1. Type d’exécution de l’interface

L’interface est systématiquement interrogée par DMS, que ce soit sur sollicitation explicite de l’utilisateur (ex : ouverture d’un dossier), ou par appel automatique (récupération des statuts, récupération d’un dossier après passage au statut « devis validé »).

  1. Disponibilité de l’interface

Indiquer si l’interface doit être disponible tous les jours, de quelle heure à quelle heure.

  1. Performance

Afin de favoriser une adoption la plus large possible par les utilisateurs, l’interfaçage avec le Portail doit être la plus rapide possible ; l’ouverture d’un dossier existant ne doit pas excéder les 3 secondes, ainsi que l’accès aux pages de création d’un nouveau dossier assuré / devis rapide.

  1. Gestion des anomalies

Un certain nombre d’erreurs sont communes à tous les services ; ces erreurs sont définies ci-dessous ; les erreurs spécifiques à chaque service sont détaillées au chapitre 5.4.

  1. Erreur de connexion

Les échanges peuvent échouer dans les cas suivants :

  • Les identifiants utilisateur/garage/application DMS sont invalides ou correspondent à un compte qui n’est plus actif
  • La session a expiré
  • La session a été déconnectée
  • Les droits attribués à l’utilisateur ne permettent pas d’accéder aux requêtes invoquées.

Dans chacun de ces cas, un message d’erreur adapté est retourné à l’application appelante (DMS).

  1. Erreur de format du flux

Plusieurs cas d’erreur se présentent :

  • problème de dictionnaire (utilisation d’un énuméré non répertorié)
  • problème de format du flux (XML invalide ou ne respectant pas le XSD)
  1. Fonctionnement en mode dégradé

Rappeler les dysfonctionnements potentiels jugés importants et leur impact sur le système. Définir éventuellement des indicateurs permettant de les caractériser (exemples : pourcentage de CPU, pourcentage de connexions à la base de données, etc. …).

Pour chaque dysfonctionnement identifié, détailler les procédures dégradées à mettre en œuvre pour que le processus puisse continuer (transfert des données sous forme de fichier…).

  1. Profil utilisateur

Tout utilisateur du Portail X’Glass peut utiliser le mode interfacé, sous réserve que la configuration interfaces ait été réalisée pour cet utilisateur.

Dans le cas où un utilisateur est configuré comme étant interfacé, il ne peut plus créer de dossier en dehors de l’interface DMS/Portail : les liens d’accès à la création d’un nouveau dossier assuré ou d’un devis rapide sont remplacés par un message indiquant : « Pour créer un nouveau dossier ou devis rapide, veuillez accéder au Portail à partir de votre DMS ».

  1. Volumes

Indiquer la volumétrie de l’interface (nombre de sites, d’utilisateurs, d’appels par jour, …).

  1. Connexion à l’interface

    1. Constitution des informations de connexion

Trois parties du flux XAT2V2 sont à renseigner pour la connexion à un service :

  1. Identification de l’utilisateur (obligatoire)

    L’utilisateur de DMS / Portail X’Glass est défini dans l’élément <session-context/> du flux XAT2V2.

    <session-context>

    <application-id>{application-id-value}</application-id>

    <dms-login>{dms-login-value}</dms-login>

    <user-shared-id>{user-shared-id-value}</user-shared-id>

    <garage-shared-id>{garage-shared-id-value}</garage-shared-id>

    <!– et/ou –>

    <session-id>{session-id-value}</session-id>

    </session-context>

    Si DMS n’a pas d’id de session valide, il doit remplir le quadruplet constitué de l’application-id, du dms-login, du user-shared-id et du garage-shared-id.

  • application-id : identifiant unique du logiciel DMS (DMS). Cet identifiant n’est pas un paramètre de connexion de l’utilisateur, il est identique à tous les utilisateurs. Cet identifiant permet aux sites serveurs de connaître le logiciel client.
  • dms-login : ce login identifie une instance du logiciel DMS (DMS) au sein du garage de l’utilisateur.
  • user-shared-id : Cet identifiant permet d’identifier l’utilisateur utilisant l’interface. Attention, cet identifiant est lié à un utilisateur du Portail X’Glass, donc, si un utilisateur utilise le login lié à cet identifiant, ce dernier pourra être déconnecté.
  • garage-shared-id : Cet identifiant permet d’identifier le garage de l’utilisateur.

Si DMS a un id de session XAT2V2 valide, il doit le transmettre dans l’élément <session-context/>, dans ce cas, les quatre autres éléments sont facultatifs.

  1. Identification du partenaire DMS (facultatif)

    Il est préférable d’avoir en clair le nom de l’application appelante et sa version. Cela permet des diagnostics plus rapides lors de support.

    DMS peut s’identifier dans l’élément <partner/> de l’élément <transport/> :

    <partner>

    <name>{dms-name-value}</name>

    <editor dictionary=« ETAI:editor » ref=« {editor-ref-value} »/>

    <version-code>{version-code-value}</version-code>

    </partner>

  2. Identification du service (obligatoire)

    Permet au Portail X’Glass de savoir quel service exécuter. Pour cela, DMS doit donner l’action qu’il demande au portail X’Glass. L’action demandée est un élément <action/> de la liste <action-list/> de l’élément <transport/> :

    <action-list>

    <action>

    <verb>{verb-value}</verb>

    <option-list>

    <option>{option-value}</option>

    </option-list>

    </action>

    </action-list>

    Si l’utilisateur est déjà connecté, DMS reçoit un accusé réception de connexion impossible car l’utilisateur est déjà connecté : message de type « ack » avec le message de référence « inWork » du dictionnaire « Xat2:message ». Pour forcer la connexion, il faut mettre l’option « force » à l’action désirée :

    <option>force</option>

    Cette option force la connexion de l’utilisateur en invalidant celle en cours.

    1. Connexion avec session interactive (traitement 1)

La connexion avec session interactive se fait en deux étapes :

  1. Envoi en post d’un XML XAT2V2 avec toutes les informations décrites dans le paragraphe 5.3.1.1. Si DMS reçoit l’état « inWork », il peut forcer la connexion avec l’option « force » sur l’action demandée.
  2. Si DMS ne reçoit plus d’état « inWork » ou d’erreur, il reçoit une session XAT2V2 dans l’élément <session-id/> de l’élément <session-context/> et une url d’affichage du portail X’Glass dans l’élément <uri-service/> portant l’action « Display » :

    <uri-list>

    <uri-service action=« Display »>

    <uri>{url-xglass-value}/xat2disp</uri>

    </uri-service>

    </uri-list>

    <session-context>

    <session-id>{session-id-value}</session-id>

    </session-context>

    Charge à DMS de lancer un navigateur avec cette url, enrichie de la session XAT2V2 qu’il a reçu :

    {url-xglass-value}/xat2disp?sessionid={session-id-value}

    1. Connexion en mode web-service (traitement 2 et 3)

La connexion en mode web service ne comporte que l’étape 1 du paragraphe précédent. En réponse, le portail X’Glass, renvoie les informations demandées. Le dialogue s’arrête à la réponse du portail X’Glass.

  1. Services

Les sous-chapitres qui suivent décrivent pour chaque service les données attendues en entrée, les données attendues en sortie, et les cas d’erreurs à traiter.

Note : les données non marquées comme obligatoires sont optionnelles.

  1. openFile

    1. Données attendues en entrée

  • Données de connexion (obligatoire)
  • Id DMS du dossier (obligatoire) : s’il est inconnu du Portail X’Glass, il sera associé à un nouveau dossier créé dans le Portail X’Glass. S’il est connu, il permet d’ouvrir le dossier X’Glass lié à cet id DMS.
  • Type du dossier (obligatoire) : permet de savoir s’il faut créer un dossier assuré ou un dossier non assuré. À la réouverture d’un dossier X’Glass, il doit être identique à celui fourni lors de la création : un dossier défini comme assuré à la création ne peut devenir non-assuré par la suite, et vice-versa.
  • Informations liées au lésé/client : civilité, nom, prénom, société, téléphone,… Dès qu’un devis a été transmis à l’assurance, ces informations sont figées.
  • Véhicule lésé/client :
    • Immatriculation carte verte : reprise dans le dossier (assuré uniquement)
    • Immatriculation carte grise : reprise dans le dossier
    • Marque : reprise dans le dossier assuré uniquement si les immatriculations n’ont pas été renseignées ou ne permettent pas de récupérer au moins la marque sans ambiguïté.
    • Autres identifiants (uniquement pour un dossier non-assuré) : repris si pas d’immatriculation ; prioritairement le CNIT, puis le Type Mines (VVT) puis le VIN (uniquement le plus prioritaire)
    • Le réseau d’assurance (dossier assuré uniquement)
    • Les autres informations (libellé du véhicule et autres) ne sont pas traitées par le Portail actuellement.

    Il est à noter que les informations véhicule (véhicule lésé/client et classification ETAI/AAA) ne peuvent pas changer après création du dossier. Comme le type d’assurance ne peut pas être modifié.

  • Classification véhicule ETAI et AAA (dossier non-assuré uniquement)
    • Variante (seul l’id variante est considéré) : repris prioritairement pour identifier le véhicule.
    • Informations AAA : reprises pour identifier le véhicule sans interroger AAA dans le cas où DMS a déjà interrogé AAA.
  • Taux TVA : sera appliqué au dossier. À la réouverture d’un dossier, le changement de TVA ne s’applique qu’aux nouvelles lignes ajoutées au devis courant, pas aux lignes déjà présentes.
  • Taux MO (non-assuré uniquement) : seront appliqués au dossier.
  • Remises (non-assuré uniquement) : seront appliquées au dossier. À la réouverture d’un dossier, le changement des remises ne s’applique qu’aux nouvelles lignes ajoutées au devis courant, pas aux lignes déjà présentes.
  • Détails du sinistre (dossier assuré uniquement) : repris pour remplir automatiquement la section « Détails du sinistre » du dossier. Les détails du sinistre ne peuvent plus être modifiés à partir du moment où un devis a été transmis à l’assurance.

Attention : Dans le cas où le dossier a été soumis à l’assurance, le Portail X’Glass ne prend plus en compte les modifications des données provenant de DMS.

Attention : Pour un dossier non-assuré, dans le cas où l’id variante n’est pas reconnu, le Portail reprend les données renseignées au niveau de la classification AAA si disponible ou au niveau du véhicule client ; même si une variante est a priori identifiée, il convient donc de renseigner systématiquement les données du véhicule client (immatriculation ou autres identifiants administratifs) ou les données AAA.

  1. Données en sortie

L’URL d’accès à l’application en création ou modification de dossier. À partir de cette URL, DMS peut initier le lancement de l’application, dans une fenêtre web indépendante, ou dans un ActiveX WebBrowser pour un affichage intégré dans DMS. Pour récupérer le dossier, DMS doit appeler le WS GetFile.

  1. Cas d’erreurs

  • Problèmes de connexion ou de format de flux (cf. 5.2.6)
  • Données obligatoires absentes (Identifiant DMS ou Type de dossier)
  • Identifiant DMS inconnu du Portail
  • Type de dossier incompatible avec celui indiqué à la création
  • Véhicule différent de celui indiqué à la création
  • Un dossier pour lequel un devis a déjà été transmis à l’assurance ne peut être modifié au niveau des détails du sinistre.

Note :

  • Les données non obligatoires dans le flux mais obligatoires dans l’application – typiquement dans la pop-up de création d’un devis assuré – devront être renseignées dans le Portail mais ne constituent pas un motif d’erreur.
  • Dans le cas où une information DARVA fournie par DMS est inconnue du Portail (le Portail n’a pas les tables DARVA à jour), on n’empêche pas la création du dossier, mais un message d’alerte informe l’utilisateur que certaines données n’ont pu être exploitées (soit au niveau de la pop-up assuré, soit au niveau du dossier).
  1. getFile

    1. Données attendues en entrée

  • Données de connexion (obligatoire)
  • L’id DMS du dossier (obligatoire)
  1. Données en sortie

  • Les données du dossier, y compris son statut, la date de dernière modification, les images et PDF (URL), mais sans la messagerie.
  • Le devis courant (le dernier devis en cours ou soumis à l’assurance), avec tout le détail de ce dernier (pièces, temps, etc.).
  1. Cas d’erreurs

  • Problèmes de connexion ou de format de flux (cf. 5.2.6)
  • Identifiant DMS inconnu du Portail
  1. getFileStatuses

    1. Données attendues en entrée

  • Données de connexion (obligatoire)
  • Date de dernière modification des dossiers à retourner (obligatoire)
  1. Données en sortie

  • Liste de triplets (id DMS de dossier, statut du dossier, date de modification) pour tous les dossiers modifiés depuis la date fournie en entrée
  1. Cas d’erreurs

  • Problèmes de connexion ou de format de flux (cf. 5.2.6)
  1. deleteSession

    1. Données attendues en entrée

  • Id de session XAT2V2 (obligatoire)
  1. Données en sortie

  • Accusé réception de bonne suppression de la session sur le serveur Portail X’Glass.
  1. Cas d’erreurs

  • Problèmes de connexion ou de format de flux (cf. 5.2.6)
  • Session inconnue
  1. Structure globale des messages XAT2V2

Structure globale du message XAT2V2

<?xml version= »1.0″ encoding= »UTF-8″?>

<xat2 xmlns=« http://xat2.etai.fr » version=« 2.0 »>

<date-list>

<!–
Informations sur les dates de réception de la requête et d’envoi de la réponse.
Cette partie est uniquement remplie lors de la réponse. –>

</date-list>

<message-list>

<!– Emplacement des messages d’erreur / warning / acknowledgement propres au protocole XAT2V2.
Cette partie n’est pas à remplir lors d’une demande de service,
mais elle peut contenir des informations lors de la réponse.
–>

</message-list>

<session-context>

<!–
Emplacement des identifiants de connexion.
Cette partie doit être obligatoirement remplie lors d’une demande de service.
Les identifiants utilisés sont repris dans la réponse

avec un identifiant de session XAT2V2 pour le traitement 1.
–>

</session-context>

<shuttle>

<transport>

<action-list>

<!– Description du ou des services demandés.
Cette partie doit être obligatoirement remplie lors d’une demande de service.
–>

</action-list>

<message-list>

<!–
Emplacement des messages d’erreur / warning propres au service demandé.
Cette partie n’est pas à remplir lors d’une demande de service,
mais elle peut contenir des informations lors de la réponse.
–>

</message-list>

</transport>

<!– Lors d’une demande de service, le corps du shuttle contient l’ensemble des paramètres nécessaires.
Lors de la réponse, il contient les résultats de la demande. ->

</shuttle>
</xat2>

Les encoding doivent être respectés. Si le flux XML est dit encodé en UTF-8, il doit réellement l’être dans le flux HTTP.

  1. Gestion des messages

    1. Message protocolaire

XML

Commentaires

<xat2 xmlns=« http://xat2.etai.fr » version=« 2.0 »>

<message-list>

Les messages protocolaires sont dans l’élément <message-list/> de l’élement de baset <xat2/>

<message>


<message-category>{category-value}</message-category>

<technical-description>


{technical-description-value}


</technical-description>

<classification-list>

<classification dictionary=« Xat2:message »


ref=« {message-ref-value} »/>

</classification-list>

</message>

{category-value} donne le type du message : ack, error, warning, information, …

{technical-description-value} donne le libellé du message

{message-ref-value} donne la référence du message

Pour un accusé réception de bon traitement, ça donne par exemple :

  • {category-value} = ack
  • {technical-description-value} = GetFile processing complete
  • {message-ref-value} = complete

</message-list>

</xat2>

 

 

  1. Message métier

XML

Commentaires

<transport>

<message-list>

Les messages métier sont dans l’élément <message-list/> de l’élément <transport/>

<message>


<message-category>{category-value}</message-category>

<user-description>


{user-description-value}


</user-description>

<classification-list>

<classification dictionary=« {message-dictionary-value} »


ref=« {message-ref-value} »/>

</classification-list>

</message>

{category-value} donne le type du message : error, warning, information, …

{user-description-value} donne le libellé du message affichable

{message-dictionary-value} donne le dictionnaire du message

{message-ref-value} donne la référence du message

Pour une erreur, ça peut donner :

  • {category-value} = error
  • {user-description-value} = Type de dossier inconnu
  • {message-dictionary-value} = ETAI:error
  • {message-ref-value} = fileTypeUnknown

</message-list>

</transport>

 

 

  1. Données échangées : DMS è Portail X’Glass

    1. Dossier

      1. Informations sur le dossier

XML

Commentaires

<file-list>

<file>

<admin-list>


<classification dictionary=« ETAI:admin » ref=« fileNumber »


source=« partner »>{file-number-value}

</classification>

</admin-list>

Identifiant(s) du dossier
  • partner : identifiant du dossier dans la base de DMS

<date-list>



<explicit-date>



<breakdown-list>



<classification dictionary=« ETAI:date » ref=« fileCreation »/>

</breakdown-list>



<date format=« {format-value} »>{date-value}</date>



</explicit-date>

</date-list>

Date de création du dossier

 

La date de création du dossier fait référence à la valeur fileCreation du dictionnaire ETAI:date.

 

Le format de date suit le modèle Java décrit ici :

http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

Par exemple pour jj/mm/aaaa, le format est dd/MM/yyyy.

<classification-list>

<classification dictionary=« ETAI:fileType »


ref=« {file-type-ref-value} »/>

</classification-list>

Type du dossier

 

{file-type-ref-value} peut prendre 2 valeurs :

  • Insured : dossier avec prise en charge assurance
  • QuickEstimate : dossier sans prise en charge assurance (= devis rapide)

</file>

</file-list>

 

 

  1. Taux de main d’œuvre

S’ils sont renseignés, les taux de main d’œuvre viennent surcharger pour ce dossier les taux définis dans l’administration du site.

XML

Commentaires

<settings>


<labor-list>

<labor-cost-rate source=« partner »>

<breakdown-list>

<classification dictionary=« ETAI:sector »


ref=« {sector-ref-value} »/>


<classification dictionary=« ETAI:level »

ref=« {level-ref-value} »/>


</breakdown-list>


<value value-type=« amount »>


<amount>{amount-value}</amount>

</value>

</labor-cost-rate>

Le type de taux est caractérisé par l’élément classification faisant référence à la valeur {sector-ref-value} du dictionnaire ETAI:sector.

Essentiellement, la valeur de {sector-ref-value} est body pour carrosserie.

D’autres types de taux existent (en particulier mechanical pour les temps de mécanique), mais ceux-ci ne sont pas actuellement utilisés dans le Portail. S’ils sont renseignés (en prévision d’une extension du périmètre d’activité du Portail), ils seront ignorés.

Le taux de technicité est défini via le dictionnaire ETAI:level. Les valeurs possibles de {level-ref-value} sont : 1 (T1), 2 (T2) ou 3 (T3).

</labor-list>

</settings>

 

 

  1. Remises

DMS peut transmettre au Portail des remises à appliquer au client dans le chiffrage nouvellement créé. Il s’agit de remises en %, sur les pièces, les temps MO, et le pied de chiffrage

XML

Commentaires

<settings>

<discount-list>

<discount source=« partner »>

<breakdown-list>

<classification dictionary=« ETAI:applicability »

ref=« {applicability-ref-value} »/>

</breakdown-list>

<value
value-type=« percent »>

<amount>{amount-value}</amount>

</value>

</discount>

Remises par défaut

Toutes les remises sont exprimées en pourcentage et leur applicabilité est définie via le dictionnaire ETAI:applicability. Les références {applicability-ref-value} possibles sont :

  • part : remise par défaut pour les pièces.
  • labor-rate : remise par défaut pour les opérations de temps.
  • total : remise sur le total du chiffrage.

Note : d’autres types de remises existent dans le dictionnaire (ex : body pour les temps MO carrosserie spécifiquement, mechanical pour les temps MO de mécanique), mais ceux-ci ne sont pas utilisés dans le Portail X’Glass.

S’ils sont transmis (en prévision d’une extension du périmètre de pièces du Portail), ils seront ignorés dans l’immédiat.

</discount-list>

</settings>

 

 

  1. Tva

Si elle est renseignée, la TVA vient surcharger la valeur de TVA par défaut du Portail pour ce dossier.

XML

Commentaires

<settings>

<VAT-list>

<VAT-rate source=« partner »>

<breakdown-list>

<classification dictionary=« ETAI:applicability »



ref=« estimate »/>

</breakdown-list>


<value value-type=« percent »>


<amount>{amount-value}</amount>

</value>

</VAT-rate>

TVA par défaut

La TVA par défaut est exprimées en pourcentage et son applicabilité est définie via le dictionnaire ETAI:applicability. L’unique référence possible est estimate pour indiquer que c’est la TVA par défaut du chiffrage.


</VAT-list>

</settings>

 

 

  1. Véhicule

    1. Véhicule du lésé/client

Le véhicule du lésé correspond aux données administratives du véhicule du lésé/client, selon le DMS : immatriculation carte grise, immatriculation carte verte (pour un dossier assuré), marque du véhicule. Ces informations seront réutilisées pour pré-remplir la pop-up de création du dossier et – si toutes les données obligatoires sont bien renseignées et correctes – procéder à la soumission silencieuse de celle-ci.

Ces données peuvent être complétée par le Portail par la classification ETAI, qui identifie précisément le véhicule (la variante) dans le référentiel de véhicules ETAI (cf. chapitre suivant), données fournies par le Portail après une première identification véhicule, et qui peuvent être retransmises par la suite par DMS pour un nouveau dossier non-assuré pour le même véhicule (comme indiqué au chapitre 5.4, seul l’id variante est significatif).

De même, DMS peut aussi fournir les informations AAA dans le cas où il a interrogé préalablement AAA avec l’immatriculation du client.

Les règles d’utilisation des données véhicules en fonction du type de dossier sont indiquées au chapitre 5.4.

Le véhicule n’est pas obligatoire mais il ne peut y avoir qu’un seul élément vehicle.XML

Commentaires

<vehicle-list>

 

<vehicle source= » partner »>

  <label>

<short-label>{short-label-value}</short-label>

</label>

Libellé complet du véhicule

Exemple : AUDI Q5 BREAK 5P 10-2008-> 2.0 TFSi 211ch S Line <identification-list>  <identification>

<breakdown-list>

<classification dictionary=« ETAI:vehicle » ref=« make »/>

</breakdown-list>

<classification-list>

<classification dictionary=« DARVA:9028.002.003 »

ref=« {darva-ref-value} »/>

</classification-list>

</identification>

Marque du véhicule

La marque du véhicule est caractérisée, au sein de l’élément identification, par l’élément classification faisant référence à la valeur make du dictionnaire ETAI:vehicle.

L’identifiant de la marque est renseignée selon Darva via le dictionnaire DARVA:9028.002.003. </identification-list>  <alternative-ref-list>

<classification dictionary=« ETAI:vehicle »


ref=« {vehicle-ref-value} »>


{reference-value}


</classification>

</alternative-ref-list>

Identifiants administratif du véhicule

Ces identifiants sont caractérisés par le dictionnaire ETAI:vehicle. Les valeurs des références {vehicle-ref-value} possibles sont :

  • registration (immatriculation carte grise)
  • greenCardRegistration (immatriculation carte verte)
  • vvt (type mines / tvv)
  • cnit
  • vin

Note : les 3 dernières informations ne sont pas utilisées pour un dossier assuré. <policy>  <person-link-list>

<person-link person-internal-id=« {person-internal-id-value} »>

<classification dictionary=« ETAI:admin »


ref=« memberNumber »


source=« insurer »>


{member-number-value}


</classification>

</person-link>

</person-link-list>

Numéro de sociétaire

Dans le lien entre la police d’assurance et le sociétaire, est indiqué le numéro de sociétaire. <classification-list>

<classification dictionary=« ETAI:insurerNetwork »


ref=« {insurer-network-ref-value} »/>

</classification-list>

Réseau d’assurance du véhicule </policy>  </vehicle>

</vehicle-list>

  1. Zoom sur les classifications véhicules ETAI et AAA

XML

Commentaires

<vehicle-list>

<vehicle source= » partner »>

<vehicle-classification>

  <identification-list>  <identification>

<breakdown-list>

<classification dictionary=« ETAI:vehicle » ref=« make »/>

</breakdown-list>

<classification-list>

<classification ref=« {make-ref-value} » source=« etai »>


{make-label-value}


</classification>

</classification-list>

</identification>

Marque du véhicule

La marque du véhicule est caractérisée, au sein de l’élément identification, par l’élément classification faisant référence à la valeur make du dictionnaire ETAI:vehicle.
<identification>

<breakdown-list>

<classification dictionary=« ETAI:vehicle » ref=« model »/>

</breakdown-list>

<classification-list>

<classification ref=« {model-ref-value} » source=« etai »>


{model-label-value}

</classification>

</classification-list>

</identification>

Modèle du véhicule

Le modèle du véhicule est caractérisé, au sein de l’élément identification, par l’élément classification faisant référence à la valeur model du dictionnaire ETAI:vehicle.

Ce niveau d’identification est lié à une notion de carrosserie du véhicule (nombre de porte, forme de carrosserie, …). <identification>

<breakdown-list>

<classification dictionary=« ETAI:vehicle » ref=« variation »/>

</breakdown-list>

<classification-list>

<classification ref=« {variation-ref-value} » source=« etai »>


{variation-label-value}

</classification>

</classification-list>

</identification>

Variante du véhicule

La variante du véhicule est caractérisée, au sein de l’élément identification, par l’élément classification faisant référence à la valeur variation du dictionnaire ETAI:vehicle.

Ce niveau d’identification est lié à une notion de mécanique du véhicule (cylindrée, type de carburant, …). </identification-list>  <classification-list>

<classification dictionary=« 3A:vehicule »


ref=« {3a-ref-value} »/>


{3a-value}

</classification-list>

Classification AAA

On retrouve ici les informations relatives à la classification AAA, caractérisées par le dictionnaire 3A:vehicule. <body>

<classification dictionary=« ETAI:body »


ref=« {body-ref-etai-value} »>


{body-label-etai-value}

</classification>

<classification dictionary=« DARVA:9031.002.002 »


ref=« {body-ref-darva-value} »>


{body-label-darva-value}

</classification>

</body>

Type de carrosserie

Le type de carrosserie du véhicule est caractérisé via le dictionnaire ETAI:body. Il est également renseigné selon Darva via le dictionnaire DARVA:9031.002.002. <fuel-list>

<fuel>

<classification dictionary=« ETAI:fuel »

ref=« {fuel-ref-etai-value} »>


{fuel-label-etai-value}

</classification>

<classification dictionary=« DARVA:9021.002.002 »

ref=« {fuel-ref-darva-value} »>


{fuel-label-darva-value}

</classification>

</fuel>

</fuel-list>

Type de carburant

Le type de carburant du véhicule est caractérisé via le dictionnaire ETAI:fuel. Il est également renseigné selon Darva via le dictionnaire DARVA:9021.002.002.

Pour les véhicules disposant de plusieurs sources d’énergie, il est possible de spécifier plusieurs types de carburant. <fiscal-rating>13</fiscal-rating>Puissance fiscale <capacity-list>

<value value-type=« amount »>

<amount>{capacity-amount-value}</amount>

<amount-of>

<classification dictionary=« ETAI:measure »


ref=« engineCapacity »/>

</amount-of>

<measurement>

<classification dictionary=« ETAI:unit » ref=« cm3 »/>

</measurement>

</value>

</capacity-list>

Cylindrée

La cylindrée du véhicule fait partie de la section capacity-list. Elle correspond à la valeur caractérisée par la référence engineCapacity du dictionnaire ETAI:measure. Elle est exprimée en cm3. <gearbox>

<gear>{gear-value}</gear>

<classification-list>

<classification dictionary=« ETAI:gearbox »

ref=« {gearbox-ref-value} »>


{gearbox-label-value}

</classification>

</classification-list>

</gearbox>

Boîte de vitesse

Les caractéristiques de la boîte de vitesse sont les suivantes :

  • nombre de rapports dans l’élément gear.
  • Type de boîte défini via le dictionnaire ETAI:gearbox.

<door-number>5</door-number>Nombre de portes </vehicle-classification>


</vehicle>

</vehicle-list>

  1. Sinistre

XML

Commentaires

<vehicle-list>

<vehicle
source=« partner »>

 
<accident>
  <classification-list>  <classification dictionary=« DARVA:9226.001.001 »

ref=« {darva-9226-ref-value} »>


{darva-9226-label-value}

</classification>

<classification dictionary=« DARVA:9227.001.001 »

ref=« {darva-9227-ref-value} »>


{darva-9227-label-value}

</classification>

<classification dictionary=« DARVA:9054.001.001 »

ref=« {darva-9054-ref-value} »>


{darva-9054-label-value}

</classification>

Données Darva liées au sinistre

  • Les circonstances du sinistre définies via le dictionnaire DARVA:9226.001.001.
  • Le motif de déplacement défini via le dictionnaire DARVA:9227.001.001.
  • La sous-traitance des réparations définie via le dictionnaire DARVA:9254.001.001.

 

Note : la sous-traitance n’est pas gérée par le Portail actuellement.

<classification dictionary=« DARVA:9007.003.001 »

ref=« {darva-9007-ref-value} »>


{darva-9007-label-value}

</classification>

Catastrophe naturelle

Indique si les dégâts sont dus à une catastrophe naturelle.

Le dictionnaire DARVA:9007.003.001 représente les circonstances de l’évènement, Portail X’Glass n’en utilise que deux références :

  • 7 – Catastrophe naturelle
  • 9 – Autre

<classification dictionary=« ETAI:thirdParty »

ref=« {thirdParty-ref-value} »/>

Tiers identifié

Indique si un tiers a été identifié ou pas.

{thirdParty-ref-value} peut prendre deux valeurs :

  • identified : identifié
  • unidentified : non identifié

</classification-list>  <place>

<address>{address-value}</address>

<zip-code>{zip-code-value}</zip-code>

<city>{city-value}</city>

</place>

Lieu du sinistre

 

Note : l’adresse n’est pas gérée par le Portail actuellement ; seuls la ville et le département sont pris en compte par le Portail actuellement.

<date-list>

<explicit-date>

<breakdown-list>

<classification dictionary=« ETAI:date » ref=« accident »/>

</breakdown-list>

<date format=« {format-value} »>{date-value}</date>

</explicit-date>

</date-list>

Date du sinistre

La date du sinistre fait référence à la valeur accident du dictionnaire ETAI:date.

 

Le format de date suit le modèle Java décrit ici :

http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

Par exemple pour jj/mm/aaaa, le format est dd/MM/yyyy.

</accident>  <evaluation>

<vehicle-state>

<repairable>

<element-list>

<element repairable=« {repairable-value} »>

<classification dictionary=« ETAI:defectElement »


ref=« windshield »/>

<classification-list>

<classification dictionary=« ETAI:DARVA:9320.001.001 »


ref=« {darva-ref-value} »>


{darva-9320-label-value}

</classification>

</classification-list>

<status>

<classification dictionary=« ETAI:elementStatus »


ref=« {status-ref-value} »/>

</status>

</element>

</element-list>

</repairable>

</vehicle-state>

</evaluation>

Pare-brise réparable

Indique si le pare-brise est réparable ou non, et si la réponse est non, le motif de non réparation, défini via le dictionnaire DARVA:9230.001.001

{repairable-value} prend les valeurs « true » ou « false ».

 

Pare-brise déjà réparé

Indique si le pare-brise a déjà été réparé.

La valeur est indiquée dans le statut de l’élément réparé par le dictionnaire ETAI:elementStatus :

  • alreadyRepaired : déjà réparé
  • neverRepaired : jamais réparé

</vehicle>

</vehicle-list>

 

  1. Lésé / client

    1. Informations sur le lésé/client

L’intervenant décrivant le lésé ou le client n’est pas obligatoire mais il ne peut y avoir qu’un seul élément person ayant la classification injured ou client du dictionnaire ETAI:person.
XML

Commentaires

<person
source=« partner » internal-id=« {internal-id-value} »>
<breakdown-list>

<classification dictionary=« ETAI:person »


ref=« {person-ref-value} »/>

</breakdown-list>

Qualité de l’intervenant
Lésé (injured) ou simple client (client). Dans le cas où il y aurait à la fois un lésé et un client, on ne conserve que le lésé (l’assuré) pour un dossier assuré et le client (celui qui paye) pour un devis rapide.
<classification-list>


<classification dictionary=« {ETAI:admin} » ref=« personNumber »

source=« partner »>


{person-number-value}

</classification-list>

Identifiant de l’intervenant
Il s’agit de l’identifiant du lésé/client dans la base DMS

 

Note : dans l’immédiat, il n’y a pas de base client dans le Portail. Ces informations ne sont donc utilisées que pour remplir le dossier et la section client du devis. Ces identifiants sont donc optionnels (l’id du Portail ne sera d’ailleurs jamais fournis à court terme). A terme, une base de client sera intégrée dans le Portail ; l’identifiant du lésé/client dans la base DMS sera alors obligatoire pour que le lésé/client soit rattaché à un lésé/client dans la base du Portail.

 

Il est donc conseillé de renseigner cet identifiant, même si les données ne sont pas stockées dans le Portail actuellement.

<title>


<classification dictionary=« ETAI:personTitle »


ref=« {title-ref-value} »>

{title-label-value}

</classification>

</title>

<name>{name-value}</name>

<firstname>{firstname-value}</firstname>

Nom du lésé/client
La civilité est renseignée via le dictionnaire ETAI:personTitle et peut identifier soit une personne, soit une société. Dans le cas où la civilité précise « société », la valeur de « name » est utilisée pour renseigner le champ « Société » de la pop-up assuré ou du devis (pour un dossier non-assuré) ; la valeur de « firstName » est ignorée.

 

Si la civilité n’est pas renseignée, ni le nom, ni le prénom ne sont pris en compte.

<place
>


<address number=« number-value »
>


{injured-address-value}


</address>


<zip-code>{zip-code-value}</zip-code>


<city>{city-value}</city>


<country>

<classification dictionary=« ETAI:country »


ref=« {country-ref-value} »>


{country-label-value}


</classification>


<classification dictionary=« DARVA:9109.001.001 »


ref=« {darva-9109-ref-value} »>


{darva-9109-label-value}


</classification>


</country>

</place>

Adresse du lésé/client
Le pays de l’adresse peut être défini selon le référentiel XAT2V2 et/ou le référentiel Darva.

 

Note :

La plupart des adresses seront françaises, dans les dictionnaires ETAI:country et DARVA:9109.001.001, la référence est « FR » pour la France.

<contact-list>


<contact>


<contact-category>{category-value}</contact-category>


<contact-value>{contact-value}</contact-value>


<classification-list>


<classification dictionary=« ETAI:contact »


ref=« {contact-ref-value} »/>


</classification-list>


</contact>

</contact-list>

Moyens de contact du lésé / client
{category-value} peut prendre les valeurs suivantes :

  • localPhone : Téléphone
  • localMobile : Téléphone mobile
  • localFax : Fax
  • mail : Adresse email
  • web : Site internet

 

Il est possible de préciser si les contacts sont professionnels ou privés par la classification portant le dictionnaire ETAI:contact. {contact-ref-value} peut prendre deux valeurs :

  • business : professionnel
  • private : privé

Note : le Portail ne gère pas la notion de moyen de contact professionnel ou privé. Cette information est donc ignorée actuellement.

<agreement-list>


<agreement>


<classification dictionary=« ETAI:agreement »
ref=« tvaIntra »>


{tvaIntra-value}

</classification>


</agreement>

</agreement-list>

Numéros d’agréments du lésé/client

  • TVA intracommunautaire (tvaIntra)
</person>
  1. Zoom sur les données du lésé/client relatives au véhicule

XML

Commentaires

<vehicle-list>


<vehicle
source=« calculating »>

<evaluation>


<VAT-status>


<recover-VAT
person-internal-id=« {person-int.-id-value} »/>


<reason>


<classification-list>


<classification
dictionary=« DARVA:9030.003.001 »


ref=« {darva-9030-ref-value} »>

{darva-9030-label-value}


</classification>


</classification-list>


</reason>


</VAT-status>

</evaluation>

Récupérabilité de la TVA
La récupérabilité de la TVA est définie dans l’évaluation du véhicule, dans l’élément recover-VAT. Le person-internal-id doit faire référence à l’internal-id de l’élément person contenant le lésé.

 

Le motif de récupérabilité de la TVA est renseigné selon Darva dans l’élément classification avec le dictionnaire DARVA95 :9030.003.001.

</vehicle>

</vehicle-list>

  1. Demande de statuts de dossiers

XML

Commentaires

<transport>

<date-list>

<explicit-date>



<breakdown-list>



<classification dictionary=« ETAI:date » ref=« fileUpdate »/>

</breakdown-list>

<date format=« {format-value} »>{date-value}</date>

</explicit-date>

</date-list>

</transport>

Date de modification
Le service GetFileStatuses retourne les statuts des dossiers ayant fait l’objet d’une modification après cette date (borne exclue).

 

Le format de date suit le modèle Java décrit ici :

http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

Par exemple pour jj/mm/aaaa, le format est dd/MM/yyyy.

 

  1. Données échangées : Portail X’Glass è DMS

    1. Ensemble des données importées

Toutes les données du chapitre 5.5 sont exportées par le Portail en suivant les mêmes règles.

  1. Dossier

    1. Informations sur le dossier

XML

Commentaires

<file-list>

<file>

<breakdown-list>


<classification dictionary=« ETAI:breakdown »


ref=« {breakdown-ref-value} »/>

</breakdown-list>

État du dossier

 

{breakdown-ref-value} identifie l’état du dossier :

  • estimate : devis
  • invoice : facture

<admin-list>


<classification dictionary=« ETAI:agreement » ref=« insurer »>


{agreement-number-value}

</classification>

</admin-list>

Numéro d’agrément de l’assurance

<status>

<classification dictionary=« ETAI:status »


ref=« {status-ref-value} »/>

</status>

Statut du dossier

 

 

{status-ref-value} peut prendre les valeurs suivantes :

  • new : nouveau
  • submitted : soumis à l’assurance
  • inProgress : en cours
  • canceled : annulé
  • validated : validé
  • rejected : rejeté

</file>

</file-list>

 

  1. Liste des pièces du chiffrage

    1. Exemple commenté


 

Les pièces du Portail X’Glass peuvent être des pièces du catalogue (pièces OE ou AM), des pièces non présentes dans le catalogue (référence et désignation saisies à la main), ou des pièces issues de la base locales, donc créées par l’utilisateur.

XML

Commentaires

<calculating-list>


<calculating>

<part-list>


<part
internal-id=« {internal-id-value} »


number=« {number-value} »>

<breakdown-list>


<classification
dictionary=« ETAI:breakdown »
ref=« part »/>


<classification
dictionary=« ETAI:partIdentification »


ref=« {part-identification-ref-value} »/>

</breakdown-list>

Catégorie de l’élément
Il s’agit d’une pièce (OE ou AM, du catalogue, hors catalogue, ou issue de la base locale).

{part-identification-ref-value} identifie le type de la pièce :

  • elementOE : OE, pièce constructeur
  • elementAM : AM, pièce équipementier
  • local : pièce dans la base locale
<label>

<short-label>{part-label-value}</short-label>

</label>

Libellé de la pièce
<reference-list>

<classification
ref=« {reference-value} »


source=« {source-value} »/>

</reference-list>

Référence de la pièce
En fonction de l’origine de la pièce, sa référence est renseignée selon plusieurs sources :

  • catalog : référence de la pièce « équipementier ».
  • make : référence de la pièce « constructeur ».
  • clean : référence de la pièce sans caractères spéciaux.
  • calculating : référence propre à l’outil de chiffrage (pièces de la base locale ou pièce inconnue).
<supplier>

<abbreviation>{abbreviation-value}<abbreviation>

<label>

<short-label>{supplier-short-label-value}</short-label>

<long-label>{supplier-long-label-value}</long-label>

</label>

<classification-list>

<classification
dictionary=« {supplier-dictionary-value} »


ref=« {supplier-ref-value} »/>

<classification
dictionary=« DARVA:9028.002.003 »


ref=« {darva-9028-ref-value} »/>

</classification-list>

</supplier>

Équipementier de la pièce (OE ou AM)
S’ils sont connus, les fournisseurs de pièces sont définis dans deux dictionnaires :

  • ETAI:make : pour les constructeurs
  • ETAI:supplier : pour les équipementiers

Les constructeurs sont également référencés par la table DARVA 9028.

L’élément short-label présente le libellé de l’équipementier sur 4 caractères au maximum.

L’élément long-label présente le libellé complet de l’équipementier.

 

À noter : l’élément abbreviation permet la gestion commune entre DMS et le Portail X’Glass de codes fournisseurs communs. Cette possibilité n’est pas encore implémentée au sein du portail X’Glass.


<classification-list>


<classification
ref=« {arcauto-value} » source=« arcauto »/>


</classification-list>

Code arcauto
Précise le code arcauto DARVA de la pièce si celui-ci est identifié. A défaut, aucun id n’est transmis, charge à DMS d’interroger l’utilisateur
<quantity value-type=« amount »>


<amount>{quantity-value}</amount>

</quantity>

Quantité de la pièce

</part>

</part-list>

</calculating>

</calculating-list>

  1. Zoom sur le prix

XML

Commentaires

<part-list>


<part
internal-id=« {internal-id-value} »


number=« {number-value} »>

Cas d’une pièce sans remise

<price-list>


<price>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« unit »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{unit-price-value}</amount></value>


</value-list>


</price>


<price
VAT-internal-id=« {VAT-internal-id-value} »>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>


<value
value-type=« inclTaxes »>

<amount>{packet-price-with-taxes-value}</amount>

</value>


</value-list>


</price>

</price-list>

Le prix unitaire de la pièce est caractérisé par l’élément classification faisant référence à la valeur unit du dictionnaire ETAI:unit.
Sa valeur est renseignée en HT.

 

Le prix final de la pièce est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie globalement à tout le chiffrage (voir chapitre
5.7.1.4
) ou propre à la ligne du devis.

 

Par rapport à la ligne exemple :


{unit-price-value} = 100.00 (Prix U.)


{packet-price-value} = 100.00 (Qté * Prix U.)


{packet-price-with-taxes-value} = 119.60 ( + ( * TVA%)

Cas d’une pièce avec remise

<price-list>


<price>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« unit »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{unit-price-value}</amount></value>


</value-list>


</price>


<price
VAT-internal-id=« {VAT-internal-id-value} »


discount-internal-id=« {discount-internal-id-value} »>


<breakdown-list>


<classification dictionary=« ETAI:unit »
ref=« packet »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>


<value
value-type=« exclTaxes »>

<amount>{packet-discount-price-value}</amount>


<include-deduction>


<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


<value
value-type=« inclTaxes »>

<amount>


{packet-discount-price-with-taxes-value}


</amount>


<include-deduction>


<classification dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


</value-list>


</price>


</price-list>

Le prix unitaire de la pièce est caractérisé par l’élément classification faisant référence à la valeur unit du dictionnaire ETAI:unit.
Sa valeur est renseignée en HT.

 

Le prix final de la pièce est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT sans remise et HT et TTC avec remise.

 

Le discount-internal-id fait référence à l’internal-id d’une remise définie dans l’élément settings (voir chapitre 5.7.1.4). Cette remise peut être globale à toutes les pièces/ingrédients ou propre à la ligne du devis.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie globalement à tout le chiffrage (voir chapitre
5.7.1.4
) ou propre à la ligne du devis.

 

Par rapport à la ligne exemple :


{unit-price-value} = 125.00 (Prix U.)


{packet-price-value} = 125.00 (Qté * Prix U.)

{packet-discount-price-value} = 100.00 ( – ( * Remise%)


{packet-discount-price-with-taxes-value} = 119.60 ( + ( * TVA%)

</part>

</part-list>

  1. Liste des ingrédients du chiffrage

    1. Exemple commenté


 

Les ingrédients du Portail X’Glass sont tous issus de la base locale, donc créés par l’utilisateur.

XML

Commentaires

<calculating-list>


<calculating>

<part-list>



<part
internal-id=« {internal-id-value} »




number=« {number-value} »>

<breakdown-list>

<classification
dictionary=« ETAI:breakdown »


ref=« ingredient »/>

</breakdown-list>

Catégorie de l’élément
Ingrédient issu de la base locale.
<label>




<short-label>{ingredient-label-value}</short-label>

</label>

Libellé de l’ingrédient
<reference-list>



<classification
ref=« {reference-value} »


source=« calculating »/>

</reference-list>

Référence de l’ingrédient
Les références des ingrédients de la base locale ont toujours une source calculating.
<supplier>

<abbreviation>{abbreviation-value}<abbreviation>

<label>

<short-label>{supplier-short-label-value}</short-label>

<long-label>{supplier-long-label-value}</long-label>

</label>

<classification-list>

<classification
dictionary=« {supplier-dictionary-value} »


ref=« {supplier-ref-value} »/>

</classification-list>

</supplier>

Équipementier de l’ingrédient
S’il est connu, l’équipementier de l’ingrédient est défini dans le dictionnaire ETAI:supplier.

L’élément short-label présente le libellé de l’équipementier sur 4 caractères au maximum.

L’élément long-label présente le libellé complet de l’équipementier.

 

À noter : l’élément abbreviation permet la gestion commune entre DMS et le Portail X’Glass de codes fournisseurs communs. Cette possibilité n’est pas encore implémentée au sein du portail X’Glass.

<packaging-list>



<packaging>




<value
value-type=« amount »>




<amount>{packaging-value}</amount>



<amount-of>




<classification dictionary=« ETAI:unit »


ref=« {unit-ref-value} »>



{unit-label-value}




</classification>



</amount-of>




</value>

</packaging>

</packaging-list>

Conditionnement de l’ingrédient
Dans le Portail X’Glass, cette information est renseignée dans la base locale mais n’apparait pas explicitement sur le chiffrage.

 


Dans le cas d’unité non définie, l’amount-of sera de source calculating :



<amount-of>

<classification ref=« =« {unit-ref-value} »
source=« calculating »/>



</amount-of>

<quantity value-type=« amount »>



<amount>{quantity-value}</amount>

</quantity>

Quantité de l’ingrédient
</part>

</part-list>

</calculating>

</calculating-list>

  1. Zoom sur le prix

XML

Commentaires

<part-list>


<part
internal-id=« {internal-id-value} »


number=« {number-value} »>

Cas d’un ingrédient sans remise

<price-list>


<price>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« unit »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{unit-price-value}</amount></value>


</value-list>


</price>


<price
VAT-internal-id=« {VAT-internal-id-value} »>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>


<value
value-type=« inclTaxes »>

<amount>{packet-price-with-taxes-value}</amount>

</value>


</value-list>


</price>

</price-list>

Le prix unitaire de l’ingrédient est caractérisé par l’élément classification faisant référence à la valeur unit du dictionnaire ETAI:unit.
Sa valeur est renseignée en HT.

 

Le prix final de l’ingrédient est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie globalement à tout le chiffrage (voir chapitre
5.7.1.4
) ou propre à l’ingrédient.

 

Par rapport à la ligne exemple :


{unit-price-value} = 5.00 (Prix U.)


{packet-price-value} = 10.00 (Qté * Prix U.)


{packet-price-with-taxes-value} = 11.96 ( + ( * TVA%)

Cas d’un ingrédient avec remise

<price-list>


<price>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« unit »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{unit-price-value}</amount></value>


</value-list>


</price>


<price
VAT-internal-id=« {VAT-internal-id-value} »


discount-internal-id=« {discount-internal-id-value} »>


<breakdown-list>


<classification dictionary=« ETAI:unit »
ref=« packet »/>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>


<value
value-type=« exclTaxes »>

<amount>{packet-discount-price-value}</amount>


<include-deduction>


<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


<value
value-type=« inclTaxes »>

<amount>


{packet-discount-price-with-taxes-value}


</amount>


<include-deduction>


<classification dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


</value-list>


</price>


</price-list>

Le prix unitaire de l’ingrédient est caractérisé par l’élément classification faisant référence à la valeur unit du dictionnaire ETAI:unit.
Sa valeur est renseignée en HT.

 

Le prix final de l’ingrédient est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC sans remise et HT et TTC avec remise.

 

Le discount-internal-id fait référence à l’internal-id d’une remise définie dans l’élément settings (voir chapitre 5.7.1.4). Cette remise peut être globale à toutes les pièces/ingrédients ou propre à la ligne du devis.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie dans l’élément settings (voir chapitre
5.7.1.4
). Cette TVA peut être globale à tout le chiffrage ou propre à la ligne du devis.

 

Par rapport à la ligne exemple :


{unit-price-value} = 5.00 (Prix U.)


{packet-price-value} = 10.00 (Qté * Prix U.)

{packet-discount-price-value} = 9.00 ( – ( * Remise%)


{packet-discount-price-with-taxes-value} = 10.76 ( + ( * TVA%)


</part>

</part-list>

  1. Liste des opérations de temps du chiffrage (mécanique / carrosserie)

    1. Exemple commenté


 

Les temps de carrosserie et mécanique peuvent être des opérations de temps « constructeur » ou des temps issus de la base locale, donc créés par l’utilisateur.

Le Portail ne gérant que des temps de remplacement (dit « principaux »), les temps éclatés ne sont pas couverts par ce CLA.

XML

Commentaires

<calculating-list>

<calculating>


<operation-list>


<operation>


<breakdown-list>


<classification
dictionary=« ETAI:breakdown »
ref=« labor »/>

<classification
dictionary=« ETAI:operationType »



ref=« main »/>


</breakdown-list>

Catégorie de l’élément
Opération de temps.

 

L’élément classification avec le dictionnaire ETAI:operationType indique la catégorie à laquelle appartient l’opération de temps : main uniquement pour le Portail X’Glass (on ne gère que les temps principaux)


<label>


<short-label>{operation-label-value}</short-label>


</label>

Libellé de l’opération de temps
<reference-list>

<classification
ref=« {reference-value} »


source=« {source-value} »/>

</reference-list>

Code de l’opération de temps
En fonction de l’origine de l’opération de temps, sa référence est renseignée selon plusieurs sources :

  • make : code « constructeur » de l’opération.
  • etai : code E-T-A-I de l’opération
  • calculating : code propre à l’outil de chiffrage (temps de la base locale).
<intervention-list>

<classification
dictionary=« ETAI:intervention »


ref=« {intervention-ref-value} »>


{intervention-label-value}

</classification>

</intervention-list>

Intervention de l’opération de temps
<part-link-list>

<part-link
part-internal-id=« {part-internal-id-value} »/>

</part-link-list>

Liens avec les pièces
Les part-internal-id font références aux internal-id des éléments part contenant les pièces de l’opération de temps.
<classification-list>

<classification
dictionary=« ETAI:sector »
ref=« body »/>

</classification-list>

Données annexes
L’élément classification avec le dictionnaire ETAI:sector indique le type d’opération de temps Valeur possible : body (carrosserie) uniquement actuellement dans le Portail.
</operation>

</operation-list>

</calculating>

</calculating-list>

  1. Zoom sur les coûts et temps de main d’œuvre

XML

Commentaires

<operation-list>

<operation>

Cas d’une opération de temps principal sans remise
<time-list>


<time
labor-internal-id=« {labor-internal-id-value} »>


<value
value-type=« time »>


<amount>{time-value}</amount>


<amount-of>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


</amount-of>


</value>


<activity-list>


<classification
dictionary=« ETAI:sector »

ref=« {sector-ref-value} »>

{sector-label-value}


</classification>


</activity-list>


</time>

</time-list>

Temps
Le temps total de l’opération est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit. Sa valeur est renseignée en heure.

 

Le labor-internal-id fait référence à un taux de main d’œuvre défini dans l’élément settings (voir chapitre 5.7.1.2)

 

L’activité liée au temps est définie via le dictionnaire ETAI:sector. Valeurs possibles :

  • bodywork (tôlerie)
  • mechanical (mécanique)

 

Note : les autres valeurs ne sont pas utilisées dans le Portail X’Glass :

  • electricity (électricité)
  • upholstery (sellerie)
<price-list>


<price
VAT-internal-id=« {VAT-internal-id-value} »


labor-internal-id=« {labor-internal-id-value} »>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


<classification
dictionary=« ETAI:sector »

ref=« {sector-ref-value} »>

{sector-label-value}


</classification>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>>{packet-price-value}</amount>

</value>


<value
value-type=« inclTaxes »>

<amount>>{packet-price-with-taxes-value}</amount>

</value>


</value-list>


</price>

</price-list>

Coût de main d’œuvre
Le coût de main d’œuvre total de l’opération est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie dans l’élément settings (voir chapitre
5.7.1.4
). Cette TVA peut être globale à tout le chiffrage ou propre à l’opération de temps.

 

Le labor-internal-id fait référence à un taux de main d’œuvre défini dans l’élément settings (voir chapitre 5.7.1.2)

 

L’activité liée au coût de main d’œuvre est définie via le dictionnaire ETAI:sector. Valeurs possibles :

  • bodywork (tôlerie)
  • mechanical (mécanique)

 

Par rapport à la ligne exemple :


{packet-price-value} = 52.50 (Durée * Taux)


{packet-price-with-taxes-value} = 62.79 ( + ( * TVA%)


Cas d’une opération de temps principal avec remise
<time-list>


<time
labor-internal-id=« {labor-internal-id-value} »>


<value
value-type=« time »>


<amount>{time-value}</amount>


<amount-of>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


</amount-of>


</value>


<activity-list>


<classification
dictionary=« ETAI:sector »

ref=« {sector-ref-value} »>

{sector-label-value}


</classification>


</activity-list>


</time>

</time-list>

Temps
Le temps total de l’opération est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit. Sa valeur est renseignée en heure.

Le labor-internal-id fait référence à un taux de main d’œuvre défini dans l’élément settings (voir chapitre 5.7.1.2)

L’activité de l’opération est définie via le dictionnaire ETAI:sector. Valeurs possibles :

  • bodywork (tôlerie)
  • mechanical (mécanique)
<price-list>


<price
VAT-internal-id=« {VAT-internal-id-value} »


labor-internal-id=« {labor-internal-id-value} »

discount-internal-id=« {discount-internal-id-value} »>


<breakdown-list>


<classification
dictionary=« ETAI:unit »
ref=« packet »/>


<classification
dictionary=« ETAI:sector »

ref=« {sector-ref-value} »>

{sector-label-value}


</classification>


</breakdown-list>


<value-list>


<value
value-type=« exclTaxes »>

<amount>>{packet-price-value}</amount>

</value>


<value
value-type=« inclTaxes »>

<amount>>{packet-price-with-taxes-value}</amount>

</value>


<value
value-type=« exclTaxes »>


<amount>{packet-discount-price-value}</amount>


<include-deduction>


<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


<value
value-type=« inclTaxes »>


<amount>


{packet-discount-price-with-taxes-value}


</amount>


<include-deduction>


<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>


</value-list>


</price>

</price-list>

Coût de main d’œuvre
Le coût de main d’œuvre total de l’opération est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC sans remise et HT et TTC avec remise.

 

Le discount-internal-id fait référence à l’internal-id d’une remise définie dans l’élément settings (voir chapitre 5.7.1.4). Cette remise peut être globale à toutes les opérations de temps MO ou propre à la ligne.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie dans l’élément settings (voir chapitre
5.7.1.4
). Cette TVA peut être globale à tout le chiffrage ou propre à la ligne.

 

Le labor-internal-id fait référence à un taux de main d’œuvre défini dans l’élément settings (voir chapitre 5.7.1.2)

 

L’activité liée au coût de main d’œuvre est définie via le dictionnaire ETAI:sector. Valeurs possibles :

  • bodywork (tôlerie)
  • mechanical (mécanique)

 

Par rapport à la ligne exemple :


{packet-price-value} = 52.50 (Durée * Taux)


{packet-price-with-taxes-value} = 62.79 ( + ( * TVA%)

{packet-discount-price-value} = 47.25 ( – ( * Remise%)


{packet-discount-price-with-taxes-value} = 56.51 ( + ( * TVA%)

</operation>

</operation-list>

 

  1. Liste des forfaits du chiffrage


 

Les forfaits du Portail X’Glass sont issus soit de la base locale, donc créés par l’utilisateur, soit d’un agrément avec l’assurance.XML

Commentaires

<calculating-list>

 

<calculating>

<operation-list>

<operation>

 

<breakdown-list>

<classification
dictionary=« ETAI:breakdown »


ref=« {breakdown-ref-value} »/>

</breakdown-list>

Catégorie de l’élément

Forfait issu de la base locale (packageDeal) ou d’un agrément (agreementPackageDeal)

<label>

<short-label>{package-deal-label-value}</short-label>

</label>

Libellé du forfait <reference-list>

<classification
ref=« {reference-value} »


source=« calculating »/>

</reference-list>

Référence du forfait

Les références des forfaits de la base locale ont toujours une source calculating.

<price-list>

<price
VAT-internal-id=« {VAT-internal-id-value} »>

<breakdown-list>

<classification
dictionary=« ETAI:unit »
ref=« packet »/>

</breakdown-list>

<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>

<value
value-type=« inclTaxes »>

<amount>{packet-price-with-taxes-value}</amount>

</value>

</value-list>

</price>

</price-list>

Prix du forfait (cas sans remise)

Le prix final du forfait est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie dans l’élément settings (voir chapitre
5.7.1.4
). Cette TVA peut être globale à tout le chiffrage ou propre au forfait.

 

Par rapport à la ligne exemple :


{packet-price-value} = 31.00 (Prix U.)


{packet-price-with-taxes-value} = 37.08 ( + ( * TVA%)

<price-list>

<price
VAT-internal-id=« {VAT-internal-id-value} »


discount-internal-id=« {discount-internal-id-value} »>

<breakdown-list>

<classification dictionary=« ETAI:unit »
ref=« packet »/>

</breakdown-list>

<value-list>

<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>


<value
value-type=« inclTaxes »>

<amount>{packet-price-with-taxes-value}</amount>

</value>


<value
value-type=« exclTaxes »>

<amount>{packet-discount-price-value}</amount>

<include-deduction>

<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>

</include-deduction>


</value>


<value
value-type=« inclTaxes »>

<amount>

{packet-discount-price-with-taxes-value}


</amount>

<include-deduction>

<classification dictionary=« ETAI:deductionType »


ref=« discount »/>

</include-deduction>

</value>

</value-list>

</price>

</price-list>

Prix du forfait (cas avec remise)

 

Le prix du forfait est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC sans remise et HT et TTC avec remise.

 

Le discount-internal-id fait référence à l’internal-id d’une remise définie dans l’élément settings (voir chapitre 5.7.1.4). Cette remise peut être globale à toutes les pièces/ingrédients ou propre à la pièce.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie globalement à tout le chiffrage (voir chapitre
5.7.1.4
) ou propre à la pièce.

 

Par rapport à la ligne exemple (si remise de 10%) :


{packet-price-value} = 31.00 (Prix U.)


{packet-price-with-taxes-value} = 37.08 ( + ( * TVA%)

{packet-discount-price-value} = 27.90 ( – ( * Remise%)


{packet-discount-price-with-taxes-value} = 33.37 ( + ( * TVA%)

<classification-list>

<classification
dictionary=« {DARVA:9282.001.001} »


ref=« {reference-darva-value} »/>

<classification
dictionary=« ETAI:sector »


ref=« {sector-ref-value} »/>

</classification-list>

Données annexes

Pour les forfaits agréés, on indique le code DARVA associé à chaque type de forfait, selon la table DARVA des types de forfaits.

Les types de forfaits possibles, {reference-darva-value}, sont :

  • 51 : Forfait 1er impact
  • 52 : Forfait 2ème impact
  • 53 : Forfait félure
  • 54 : Forfait impact ou félure supplémentaire
  • 55 : Forfait multi-impact
  • 58 : Forfait MO optique

 

L’élément classification avec le dictionnaire ETAI:sector indique le type de forfait (mécanique, ou carrosserie). Valeurs possibles : mechanical ou body.

</operation>

</operation-list>

</calculating>

</calculating-list>

 

  1. Retraitement des déchets

XML

Commentaires

<calculating-list>

<calculating>

<operation-list>

<operation>

<breakdown-list>

<classification
dictionary=« ETAI:breakdown »


ref=« wasteTreatment »/>

</breakdown-list>

Catégorie de l’élément
Retraitement des déchets.

<label>

<short-label>{waste-treatment-value}</short-label>

</label>

Libellé du retraitement des déchets

<price-list>

<price
VAT-internal-id=« {VAT-internal-id-value} »>

<breakdown-list>

<classification
dictionary=« ETAI:unit »
ref=« packet »/>

</breakdown-list>

<value-list>


<value
value-type=« exclTaxes »>

<amount>{packet-price-value}</amount>

</value>

<value
value-type=« inclTaxes »>

<amount>{packet-price-with-taxes-value}</amount>

</value>

</value-list>

</price>

</price-list>

Prix du retraitement des déchets
Le prix final du retraitement des déchets est caractérisé par l’élément classification faisant référence à la valeur packet du dictionnaire ETAI:unit.

Sa valeur est renseignée en HT et TTC.

 

Le VAT-internal-id fait référence à l’internal-id d’une TVA définie dans l’élément settings (voir chapitre
5.7.1.4
). Cette TVA peut être globale à tout le chiffrage ou propre au retraitement des déchets.

 

Par rapport à la ligne exemple :


{packet-price-value} = 20.00 (Prix HT)


{packet-price-with-taxes-value} = 23.92 ( + ( * TVA%)


</operation>


</operation-list>


</calculating>

</calculating-list>

 

  1. Totaux du chiffrage

Dans le cadre du Portail, on se contente de transmettre les totaux globaux, en précisant les montants HT avant remise & ERD, remise pied de devis, ERD, TTC, franchise et part assuré / part assurance.

XML

Commentaires

<calculating-list>


<calculating>


<price-list>

 


<price VAT-internal-id=« {VAT-internal-id-value} »

discount-internal-id=« {discount-internal-id-value} »>


<breakdown-list>


<classification
dictionary=« ETAI:breakdown »
ref=« total »/>


</breakdown-list>


<value-list>

Totaux du chiffrage

Les totaux du chiffrage sont caractériséq par l’élément classification faisant référence à la référence total du dictionnaire ETAI:breakdown.

Le lien avec la remise est pour la remise pied de page.


<value
value-type=« exclTaxes »>


<amount>{total-price-value}</amount>

</value>

Montant HT du chiffrage (sans remise pied de chiffrage)

Le montant total du chiffrage HT est caractérisé par l’élément value de type « exclTaxes ».

Ce montant est hors retraitement des déchets.

 

Par rapport à l’exemple :


{total-price-value} = 187.25


<value
value-type=« amount »>

<amount>{discount-amount-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« discount »/>

</amount-of>


</value>

Montant de la remise pied de page

Le montant de la remise, lorsqu’il y en a une, est caractérisé par l’élément value de type « amount » ayant un amount-of de référence « discount » du dictionnaire ETAI:amountOf.

 

Ce montant s’applique sur le montant HT du chiffrage, hors retraitement des déchets.

 

Par rapport à l’exemple :


{discount-amount-value} = 18.73 ( * Remise Pied%)


<value
value-type=« exclTaxes »>


<amount>{total-discount-price-value}</amount>


<include-deduction>


<classification
dictionary=« ETAI:deductionType »


ref=« discount »/>


</include-deduction>


</value>

Montant remisé HT du chiffrage (avec remise pied de chiffrage)

Le montant total remisé du chiffrage HT est caractérisé par l’élément value de type « exclTaxes » possédant un élément include-deduction avec la référence « discount » du dictionnaire ETAI:deductionType.

 

Ce montant est hors retraitement des déchets.

Par rapport à l’exemple :


{total-discount-price-value} = 168.53 ( – ( * Remise%))


<value
value-type=« amount »>

<amount>{waste-treatment-amount-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« wasteTreatment »/>

</amount-of>


</value>

Montant du retraitement des déchets (ERD)

S’il y en a un, le montant du retraitement des déchets est caractérisé par l’élément value de type « amount » ayant un amount-of de référence « wasteTreatment » du dictionnaire ETAI:amountOf.

 

Par rapport à l’exemple :


{waste-treatment-amount-value} = 20.00


<value
value-type=« taxes »>

<amount>{vat-amount-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« VAT »/>

</amount-of>


</value>

Montant de la TVA

Le montant de la tva est caractérisé par l’élément value de type « taxes » ayant un amount-of de référence « VAT » du dictionnaire ETAI:amountOf.

 

Par rapport à l’exemple :


{vat-amount-value} = 36.95 (( + ) * TVA%)


<value
value-type=« inclTaxes »>


<amount>{total-price-with-taxes-value}</amount>

</value>

Montant TTC du chiffrage

Le montant total du chiffrage TTC est caractérisé par l’élément value de type « inclTaxes ».

Par rapport à l’exemple :


{total-price-with-taxes-value} = 225.48 (( + ) + (( + ) * TVA%))


<value
value-type=« amount »>

<amount>{excess-amount-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« excess »/>

</amount-of>


</value>

Montant de la franchise (Pour un dossier assuré)

Le montant de la franchise est caractérisé par l’élément value de type « amount » ayant un amount-of de référence « excess » du dictionnaire ETAI:amountOf.

 

Par rapport à l’exemple :


{excess-amount-value} = 50.00


<value
value-type=« inclTaxes »>

<amount>{insurer-part-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« insurerPart »/>

</amount-of>


</value>

Montant de la part assurance (Pour un dossier assuré)

Le montant de part assurance est caractérisé par l’élément value de type « inclTaxes » ayant un amount-of de référence « insurerPart » du dictionnaire ETAI:amountOf.

 

Par rapport à l’exemple :


{insurer-part-value} = 175.48


<value
value-type=« inclTaxes »>

<amount>{insured-part-value}</amount>

<amount-of>

<classification dictionary=« ETAI:amountOf »


ref=« insuredPart »/>

</amount-of>


</value>

Montant de la part assuré (Pour un dossier assuré)

Le montant de part assuré est caractérisé par l’élément value de type « inclTaxes » ayant un amount-of de référence « insuredPart » du dictionnaire ETAI:amountOf.

 

Par rapport à l’exemple :


{insured-part-value} = 50.00


</value-list>

</price>

  </price-list>

</calculating>

</calculating-list>

 

 

  1. Réponse à la demande de statuts de dossiers

Statuts des dossiers modifiés

Indique pour chaque dossier modifié (identifié par un l’id DMS du dossier) le statut du dossier.

XML

Commentaires

<file-list>

<file>

 

<admin-list>


<classification dictionary=« ETAI:admin » ref=« fileNumber »


source=« partner »>{file-number-value}

</classification>

</admin-list>

Identifiant(s) du dossier

 

  • partner : identifiant du dossier dans la base DMS

<date-list>



<explicit-date>



<breakdown-list>



<classification dictionary=« ETAI:date » ref=« fileUpdate »/>

</breakdown-list>



<date format=« {format-value} »>{date-value}</date>



</explicit-date>

</date-list>

Date de modification du dossier

La date de modification du dossier fait référence à la valeur fileUpdate du dictionnaire ETAI:date.

 

Le format de date suit le modèle Java décrit ici :

http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html.

Par exemple pour jj/mm/aaaa, le format est dd/MM/yyyy.

<status>

<classification dictionary=« ETAI:status » ref=« {status-ref-value} »/>

</status>

Statut du dossier

</file>

</file-list>

 

  1. Réponse à la demande de suppression de session

XML

Commentaires

<xat2 xmlns=« http://xat2.etai.fr » version=« 2.0 »>

<message-list>

<message>


<message-category>ack</message-category>

<user-description dictionary=« Xat2:message » ref=« complete »/>

<technical-description>session delete OK</technical-description>

</message>

Accusé réception de la suppression de la session

</message-list>

</xat2>

Publié dans Documentation technique