Annexe
Annexe 1 point 1 quater - Interfacage rapports avec GMAO HBT.pdf · 37 833 mots · du marché « Vérifications réglementaires des installations techniques du CHU de Montpellier et de son groupement hospitalier de… », dossier de consultation officiel.
CARL Source 7.3
Web Services standard
TABLE DES MATIÈRES
1. Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.1. Authentification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.2. Web Services et personnalisation CARL Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3. Paramètres d’entrée. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3.1. Méthodes de création / mise à jour . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
1.3.2. Méthodes de recherche retournant une liste . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.3.3. « className » et autres attributs non-obligatoires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.4. Paramètres de sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5. Impact de l’internationalisation sur les Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5.1. Dates en entrée des Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.5.2. Dates en sortie des Web Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.6. Nombre maximum de résultats retournés par une recherche . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.7. Gestion des erreurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.7.1. Format des erreurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.7.2. Correspondances « Symptôme - Cause » (FDC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
1.8. Types de donnée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2. Exemples d’utilisation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1. Méthode retournant une liste simplifiée : searchWO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.1.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.2. Méthode retournant le détail d’un objet : getMRDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.2.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
2.3. Méthode de création : createMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.3.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
2.4. Méthode de mise à jour : updateMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.4.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.4.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
2.5. Suppression : removeMR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.5.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6. Recherche des transitions sur intervention : findTransitionWO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.6.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
2.7. Transition sur intervention : applyTransitionWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.7.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.7.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
2.8. Export : exportSynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.8.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.8.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
2.9. Import : processSynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.9.1. Utilisation du format XML : Entrée. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.9.2. Utilisation du format XML : Sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.9.3. Utilisation du format CSV : Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2.9.4. Utilisation du format CSV : Sortie . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10. Import de liens : importLinkEquipmentO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.1. Entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.2. Sortie. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.3. Erreurs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.3.1. Code existant (exemple : createWO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.3.2. Date incorrecte (exemple : createMeasureReading) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
2.10.3.3. Contrôle des données obligatoires (exemple : createWO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
2.10.3.4. Contrôle de cohérence des données (exemple : applyTransitionMR) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
3. Demande d’intervention (DI): MRWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.1.1. MRSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.1.2. MRHeaderVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
3.1.3. MRVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2. Recherche DI : searchMR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
3.2.1. Paramètres d’entrée (MRSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.2.2. Informations retournées (MRHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3. Détail DI : getMRDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.3.2. Informations retournées (MRVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.4. Création DI : createMR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.4.1. Paramètres d’entrée (MRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.4.2. Paramètres de sortie (MRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.5. Mise à jour DI : updateMR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.5.1. Paramètres d’entrée (MRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
3.5.2. Informations retournées (MRVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.6. Suppression DI : removeMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.6.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.6.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.7. Transitions permises : findTransitionMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.7.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.7.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.8. Changement d’état : applyTransitionMR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.8.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
3.8.2. Informations retournées (MRVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4. Intervention : WOWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.1.1. WOSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.1.2. WOHeaderVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23
4.1.3. WOVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.2. Recherche d’interventions : searchWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.2.1. Paramètres d’entrée (WOSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.2.2. Informations retournées (WOHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3. Détail intervention : getWODetail. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.3.2. Informations retournées (wovo). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
4.4. Creation d’intervention : createWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.4.1. Paramètres d’entrée (wovo) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.4.2. Informations retournées (wovo). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.5. Mise à jour Intervention : updateWO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.5.1. Paramètres d’entrée (wovo) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.5.2. Informations retournées (wovo). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.6. Suppression d’une intervention : removeWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.6.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.6.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.7. Recherche transitions : findTransitionWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26
4.7.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.7.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.8. Changement d’état WO : applyTransitionWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.8.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
4.8.2. Informations retournées (wovo). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5. Point de structure : BOX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.1.1. BoxSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.1.2. BoxHeaderVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28
5.2. Recherche points de structures : getBoxList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.2.1. Paramètres d’entrée (BoxSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
5.2.2. Informations retournées (BoxHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6. Matériel : Material . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.1.1. MaterialSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.1.2. MaterialHeaderVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.2. Recherche matériel : getMaterialList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.2.1. Paramètres d’entrée (MaterialSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.2.2. Informations retournées (MaterialHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
7. Lien équipements : LinkEquipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.1.1. LinkEquipmentSearchVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.1.2. LinkEquipmentVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.2. Recherche de liens : getLinkEquipmentList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.2.1. Paramètres d’entrée (LinkEquipmentSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
7.2.2. Informations retournées (LinkEquipmentVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
7.3. Import de liens : importLinkEquipmentO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
7.3.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
7.3.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
8. Relevés de mesure : MeasureReading . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
8.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
8.1.1. MeasurePointDetailVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
8.1.2. MeasureSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.1.3. MeasureToReadVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.1.4. MeasureReadingVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
8.2. Détail d’un point de mesure : getMesurePointDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.2.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.2.2. Informations retournées (MeasurePointDetailVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.3. Relevés en attente : getMeasureToRead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.3.1. Paramètres d’entrée (MeasureSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.3.2. Informations retournées (MeasureToReadVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.4. Relevé de mesure : createMeasureReading. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.4.1. Paramètres d’entrée (MeasureReadingVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8.4.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
9. Evènement sur équipement : Event . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.1. Objets VO Principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.1.1. EventSearchVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.1.2. EventVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.2. Recherche évènement : getEventList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.2.1. Paramètres d’entrée (EventSearchVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.2.2. Informations retournées (EventVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.3. Création évenement : createEvent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
9.3.1. Paramètres d’entrée (EventVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
9.3.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
10. Demande d’achat : PR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
10.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
10.1.1. PRSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
10.1.2. PRHeaderVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
10.1.3. PRVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
10.2. Changement d’etat : ApplyTransitionPR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.2.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.2.2. Informations retournées (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.3. Creation DA : createPR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.3.1. Paramètres d’entrée (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.3.2. Informations retournées (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.4. Détail DA : getPRDetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.4.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
10.4.2. Informations retournées (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.5. Mise à jour DA : updatePR. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.5.1. Paramètres d’entrée (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.5.2. Informations retournées (PRVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.6. Recherche de DA : searchPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.6.1. Paramètres d’entrée (PRSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.6.2. Informations retournées (PRHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.7. Suppression DA : removePR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.7.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.7.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
10.8. Transition permises : findTransitionPR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
10.8.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
10.8.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
11. Commande : PO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
11.1. Objets VO principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
11.1.1. POSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
11.1.2. POHeaderVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
11.1.3. POVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
11.2. Changement d’état : applyTransitionPO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.2.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.2.2. Informations retournées (POVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.3. Création Commande : createPO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.3.1. Paramètres d’entrée (POVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.3.2. Informations retournées (POVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
11.4. Détail commande : getPODetail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.4.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.4.2. Informations retournées (POVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.5. Mise à jour Commande : updatePO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.5.1. Paramètres d’entrée (POVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.5.2. Informations retournées (POVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.6. Recherche commande : searchPO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.6.1. Paramètres d’entrée (POSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.6.2. Informations retournées (POHeaderVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.7. Suppression Commande : removePO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
11.7.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
11.7.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
11.8. Transitions permises : findTransitionPO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
11.8.1. Paramètres d’entrée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
11.8.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
12. Ligne de réception : DeliveryLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1. Objet VO principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.1.1. DeliveryLineVO. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.2. Creation ligne de réception : createDeliveryLine. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.2.1. Paramètres d’entrée (DeliveryLineVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
12.2.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
13. Ligne de retour : ReturnLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.1. Objet VO principal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.1.1. returnLineVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.2. Creation ligne de retour : createReturnLine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.2.1. Paramètres d’entrée (returnLineVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
13.2.2. Informations retournées . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
14. Mouvement de stock : StockMovement. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
14.1. Objets VO Principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
14.1.1. StockMovementSearchVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
14.1.2. StockMovementVO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
14.2. Recherche de mouvements de stock : getMovementStockList . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
14.2.1. Paramètres d’entrée(StockMovementSearchVO) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
14.2.2. Informations retournées (StockMovementVO). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
15. Web Service d’échange de données . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
15.1. Principes d’utilisation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
15.2. Modes d’import/export : particularités . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
15.2.1. Export de données – Comparatif des approches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
15.2.2. Import de données – Comparatif des approches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
15.3. Import de données asynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
15.3.1. processAsynchronousImport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
15.3.2. process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58
15.4. Import de données synchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.4.1. processSynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.5. Export de données synchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.5.1. exportSynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.6. Objets principaux . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.6.1. Process, processAsynchronousImport, processSynchrone. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
15.6.2. exportSynchrone . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
16. Web Services spécifiques. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
17. Annexes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
17.1. MRWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
17.1.1. Objet WOVO : Intervention liée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
17.1.2. Transitions autorisées pour une DI. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
17.1.3. MRAddressVO : Adresses de la demande d’intervention. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
17.2. WOWebService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
17.2.1. Détails des objets complémentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
17.2.1.1. habilitationVO : Habilitation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
17.2.1.2. MRLinkVO : DIWO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
17.2.1.3. OccupationVO : Occupation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
17.2.1.4. ProcessVO : Opération . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
17.2.1.5. PurchaseElementVO : Ligne d’achat . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64
17.2.1.6. ResourceVO : Ressource . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
17.2.1.7. WORiskVO : Risque . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
17.2.1.8. WOStockMovementVO : Mouvement de stock . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
17.2.1.9. woLinkVO : Lien Intervention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
17.2.1.10. woMeasureReadingVO : Relevé WO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
17.2.1.11. ReserveVO : Reservation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
17.2.1.12. toolOccupationVO : Temps d’utilisation d’un moyen matériel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66
17.2.1.13. woToolVO : Moyen matériel planifié à une intervention validée . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
17.2.1.14. expWOToolVO : Moyen matériel prévu sur une intervention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
17.2.1.15. WOAddressVO : Adresses de l’intervention . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
17.3. LinkWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.3.1. Détail des objets complémentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.3.1.1. equipmentVO : Équipement du lien . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.3.1.2. junctionVO : Jonction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.4. PRWebService. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.4.1. Objets complémentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.4.1.1. extraCostPRLineVO : Frais annexe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.4.1.2. taxVO : Taxe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
17.4.1.3. PRLineVO : Ligne DA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
17.4.1.4. DeliveryLineHeaderVO : Ligne de réception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
17.5. POWebService . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
17.5.1. Objets complémentaires . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
17.5.1.1. DeliveryLineHeaderVO : Ligne de réception . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
17.5.1.2. ExtraCostPOLineVO : Frais annexe global . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
17.5.1.3. taxVO : Taxe . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
17.5.1.4. POLineVO : Ligne de commande . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
17.5.1.5. POAddressVO : Adresse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
17.5.1.6. AddressVO : Bloc adresse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
17.5.1.7. POContactVO : Contact. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Web Services standard
Avis de marques déposées
Nous avons apporté tous nos efforts pour garantir l’exactitude des informations au moment de la publication de ce document.
CARL Source étant en constante évolution, CARL Berger-Levrault ne peut être tenu responsable des éventuels manques ou erreurs de ce
document.
Si vous relevez une incohérence ou une erreur, merci de contacter le service support de CARL Berger-Levrault.
Toute reproduction, en tout ou en partie, sous quelque forme que ce soit, est formellement interdite sans l’autorisation préalable de
CARL Berger-Levrault.
Toutes les marques et noms de produits mentionnés dans ce document sont les propriétés de leurs détenteurs respectifs telles que
répertoriées ci-dessous :
• Android™ et Google Chrome® sont des marques déposées de Google LLC
• ArcGIS® est une marque déposée d’Environmental Systems Research Institute.
• Elasticsearch® est une marque déposée d’Elasticsearch B.V. aux États-Unis et dans d’autres pays.
• Firefox® est une marque déposée de Mozilla Foundation.
• Java™ et Oracle® sont des marques déposées d’Oracle Corporation.
• PostgreSQL® est une marque déposée de The PostgreSQL Community Association of Canada.
• Safari® est une marque d’Apple Inc., déposée aux États-Unis et dans d’autres pays.
• Azure®, SQL Server®, Microsoft Edge® et Windows® sont des marques déposées de Microsoft Corporation.
• Tomcat® est une marque déposée de l’Apache Software Foundation aux États-Unis et dans d’autres pays.
CARL INTERNATIONAL SAS, au capital de 514 276 €, RCS LYON 384 841 250
Siège social : 361 Allée des noisetiers, 69760 Limonest, France - © CARL Berger-Levrault 2025
E-mail : info@carl.eu – Web : www.carl-software.fr
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 1 / 73
Web Services standard
1. INTRODUCTION
Ce document décrit les Web Services (SOAP) fournis en standard avec CARL Source 7.3.3.
Dans un environnement CARL Source, la liste des WebServices (SOAP) disponibles (format WSDL associés) se trouve à l’adresse suivante :
http://[host]:[port]/[context]/ws
Les paramètres [host], [port] et [context] correspondent au nom de la machine, au port et au chemin où est installé l’application CARL
Source.
1.1. Authentification
L’utilisation des WebServices nécessite une authentification : l’appel à un Web Service doit donc être réalisé en transmettant un couple
« utilisateur / mot de passe » valide.
Cette authentification peut être réalisée à différents niveaux :
• Authentification via CARL Source : le couple « utilisateur/mot de passe » transmis à l’appel du Web Service doit être déclaré dans
CARL Source, que ce soit par le biais d’une authentification interne ou externe (LDAP).
• Authentification via Apache : la requête faisant appel au Web Service est préalablement authentifiée par Apache.
Même si l’authentification est déléguée par Apache, l’utilisateur doit exister au sein de CARL Source (à moins qu’il
soit automatiquement créé par CARL Source, comme cela peut être le cas lorsqu’un LDAP est utilisé).
Particularités du Web Service d’échange de données (ExchangeGatewayService)
Sur les méthodes de ce Web Service, la balise <actorCode> doit toujours être renseignée avec un code utilisateur de
CARL Source.
=> Cet utilisateur sera alors utilisé pour effectuer l’import ou l’export.
S’il est différent de celui utilisé pour l’authentification « http », il sera nécessaire de préciser son mot de passe via la
balise <auth> en commençant :
• soit par simple: dans le cas d’un mot de passe en clair,
• soit par crypt: si le mot de passe saisi est crypté.
1.2. Web Services et personnalisation CARL Source
Il est nécessaire de distinguer deux cas de figure :
Les attributs personnalisés livrés en « Standard » (c-à-d. champs « xtra ») :
• sont accessibles (c-à-d. initialisables) via les méthodes de création d’objets,
• mais ne sont pas accessibles via les méthodes de recherche.
Les attributs non-livrés en « Standard » (c-à-d. ajoutés par vos soins ou par le Service Adaptation de CARL Berger-Levrault) ne sont pas
pris en compte dans les Web Services.
Néanmoins, par le biais d’une interface spécifique, ces valeurs peuvent être lues ou modifiées via l’utilisation des WebServices
d’Import/Export.
1.3. Paramètres d’entrée
Les paramètres d’entrée suivis d’un astérisque (*) sont obligatoires pour le bon fonctionnement du Web Service.
1.3.1. Méthodes de création / mise à jour
• L’attribut id dans les méthodes de création ne sera pas pris en compte : l’identifiant est automatiquement généré par
l’application.
2 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
• Les paramètres d’entrée vides ne doivent pas figurer dans la requête.
• Lors de la création d’un objet, si l’état renseigné en entrée est incorrect, le Web Service crée l’objet dans l’état de création par
défaut.
• Si un paramètre d’entrée est un objet, il suffit généralement de renseigner son code.
Par exemple
<createdBy>
<code>MARTIN</code>
</createdBy>
1.3.2. Méthodes de recherche retournant une liste
• Le caractère * est un caractère joker, qui remplace un ou plusieurs caractères.
• Le caractère ? est un caractère joker, qui remplace un unique caractère.
• Les caractères jokers sont configurables dans la rubrique Recherches de la fonctionnalité Configuration du système.
• La chaine de caractère '' permet de spécifier un champ vide, par exemple pour une requête de recherche où l’on souhaite des
éléments dont un attribut est vide.
1.3.3. « className » et autres attributs non-obligatoires
L’attribut className peut être fourni en paramètre à l’appel de différentes méthodes référencées au sein de ce document.
Cet attribut constitue une information technique dont la valeur n’évolue que lors d’un changement de version.
Par ailleurs, et comme c’est le cas pour la totalité des attributs référencés plus bas, il conviendra de renseigner une valeur pour className
uniquement si celui-ci est indiqué comme obligatoire (c-à-d. suivi d’un astérisque ‘*') à l’appel d’une méthode.
=> Il est donc inutile de renseigner systématiquement une valeur pour cet attribut (ou pour tout autre attribut non-obligatoire) – cf.
exemple n°1 ci-dessous.
Cas particulier : le passage d’une valeur pour className peut s’avérer nécessaire dans un cas particulier lié aux équipements – cf.
exemple N°2 ci-dessous.
Exemple n°1 – Création d’un lien
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.equipment.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:importLinkEquipmentO>
<junction>
<id>MAINMATERIAL</id>
</junction>
<parent>
<code>CENTRALE</code>
</parent>
<child>
<code>MA-000011</code>
</child>
<linkBegin>2016-12-18T10:15:01+01:00</linkBegin>
</web:importLinkEquipmentO>
</soapenv:Body>
</soapenv:Envelope>
Bien que l’attribut className apparaisse dans la signature des objets « VO » attendus par la méthode
importLinkEquipmentO (cf. Import de liens : importLinkEquipmentO), sa présence à l’appel de la méthode n’est pas
obligatoire.
Exemple n°2 – Cas particulier nécessitant le passage d’une valeur pour className
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.equipment.xnet.carl.com/">
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 3 / 73
Web Services standard
<soapenv:Header/>
<soapenv:Body>
<web:importLinkEquipmentO>
<junction>
<id>MAINMATERIAL</id>
</junction>
<parent>
<code>LIGNE_PROD11</code>
</parent>
<child>
<className>com.carl.xnet.equipment.backend.bean.MaterialBean</className>
<code>VANNE3VOIES</code>
</child>
<linkBegin>2016-12-18T10:15:01+01:00</linkBegin>
</web:importLinkEquipmentO>
</soapenv:Body>
</soapenv:Envelope>
Dans l’exemple ci-dessus, le matériel « VANNE3VOIES » porte le même code que son modèle.
Ici, si l’on ne précise pas la classe du matériel, CARL Source ne sait pas déterminer si l’on souhaite placer le modèle
ou le matériel.
=> Dans ce cas particulier, la spécification d’un className est donc nécessaire.
1.4. Paramètres de sortie
Les paramètres de sortie nuls (sans valeurs) ne sont pas présents dans la réponse des WebServices.
1.5. Impact de l’internationalisation sur les Web Services
En entrée ou en sortie des Web Services, la gestion des dates s’appuie sur les informations relatives à l’utilisateur connecté : fuseau
horaire, calendrier et localisation (notion de "Contexte temporel").
1.5.1. Dates en entrée des Web Services
• Toute date passée en entrée aux Web Services sera convertie dans le fuseau horaire de l’utilisateur connecté.
• Si la date transmise aux Web Services ne spécifie aucun fuseau horaire, CARL Source considère que celle-ci est exprimée dans le
fuseau horaire de l’utilisateur connecté.
Dans tous les cas de figure, cette date sera stockée dans le fuseau horaire de l’utilisateur connecté, ainsi que dans le calendrier et la
localisation par défaut de l’application.
1.5.2. Dates en sortie des Web Services
• Toute date en sortie du Web Service sera exprimée (au format UTC ISO 8601) avec le fuseau horaire de l’utilisateur connecté.
1.6. Nombre maximum de résultats retournés par une recherche
Plusieurs méthodes de recherche ("search") sont disponibles – quelques exemples :
• searchMR (Recherche de DI)
• searchWO (Recherche d’interventions)
• searchPR (Recherche de DA)
• etc.
Pour des raisons de performance, ces différentes méthodes "search" renvoient un maximum de 500
enregistrements.
Cette limite n’est pas éditable via la configuration de CARL Source.
Pour rappel, les champs « xtra » ne sont pas accessibles via les méthodes de recherche (cf. Web Services et
personnalisation CARL Source).
4 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
1.7. Gestion des erreurs
1.7.1. Format des erreurs
Les erreurs en retour des requêtes sont générées de la façon suivante pour tous les Web Services :
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>Message de l'exception levée</faultstring>
<detail>
<ns2:WebServiceException xmlns:ns2="http://adresse du web service interne à CarlSource/">
<code>Code de l'exception levée</code>
<message> Message de l'exception levée</message>
</ns2:WebServiceException>
</detail>
</env:Fault>
1.7.2. Correspondances « Symptôme - Cause » (FDC)
Pour faciliter le diagnostic de certaines erreurs, la Fiche De Connaissance (FDC) N°005938 a été créée sur le site support de CARL Berger-
Levrault : https://www.espaceclients.berger-levrault.fr/.
Il ne s’agit pas d’une liste exhaustive des erreurs pouvant être remontées.
Ci-dessous quelques exemples illustrant le contenu de cette FDC.
Exemple 1 : Erreur remontée à la création d’un relevé de mesure
Symptôme/Erreur
L’appel de la méthode « createMeasureReading » du Web Service « MeasureReadingWebServiceImpl » renvoie l’erreur suivante :
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>java.lang.RuntimeException:com.carl.xnet.system.backend.webservice.exceptions.WebServiceExc
eption:
com.carl.xnet.equipment.backend.exceptions.MeasureReadingDateException
[dataBean=<com.carl.xnet.equipment.backend.bean.MeasureReadingBean,146296c6327-2eb5>,severity=ERROR]
</faultstring>
</env:Fault>
Cause(s) possible(s) :
• Aucune date n’a été transmise à la méthode (ou a été positionnée à 'null').
• La date transmise à la méthode est antérieure au dernier relevé existant.
Exemple 2 : Autre erreur remontée à la création d’un relevé de mesure
Symptôme/Erreur – L’appel de la méthode « createMeasureReading » du Web Service « MeasureReadingWebServiceImpl » renvoie
l’erreur suivante :
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>java.lang.RuntimeException:com.carl.xnet.system.backend.webservice.exceptions.WebServiceExc
eption:
com.carl.xnet.system.backend.webservice.exceptions.WSEntityNotExistException[dataBean=null,severity=ERRO
R]</faultstring>
</env:Fault>
Cause(s) possible(s) :
• Le point de mesure transmis à la méthode n’existe pas dans CARL Source.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 5 / 73
Web Services standard
• L’utilisateur transmis à la méthode n’existe pas dans CARL Source.
1.8. Types de donnée
Toutes les données utilisées sont sensibles à la casse.
Type de donnée Descriptif
Alphanumérique de 20 caractères permettant d’identifier l’objet dans CARL Source (code
Code
manipulé par l’utilisateur).
Alphanumérique 33 caractères, permettant d’identifier l’objet dans la base de données (non
Identifiant
visible par l’utilisateur).
Libellé Texte 60 caractères maximum.
Texte Texte de 255 caractères maximum.
Libellé long Texte sans limitation de longueur (CLOB).
Valeur de liste Indiquer le code de la valeur issue d’une Valeur de listes de CARL Source.
• Il n’y a pas de séparateurs de milliers,
• Le séparateur des décimales est le point (".").
Numérique
• La colonne ne doit contenir aucun autre caractère : Pas de devise, ni d’unité pour une
quantité.
Booléen Valeur : "true" ou "false"
Les dates sont au format suivant, en horaire GMT :
Date jjjj-mm-ddThh:mm:ss+hh:00
Exemple : 2011-03-22T19:19:27+01:00
Chaque fois qu’une méthode retourne un enregistrement correspondant à un objet de
l’application CARL Source, celui-ci est retourné sous la forme d’un bloc contenant les
informations suivantes :
• className,
• id (Identifiant),
Objet
• code,
• description.
En entrée, il suffit généralement de renseigner le code de l’élément, dans le sous-attribut
<code>.
Les objets comportant des attributs spécifiques sont documentés en annexe.
6 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
2. EXEMPLES D’UTILISATION
Ci-dessous quelques exemples d’appels aux méthodes des différents WebServices.
Il est important de saisir que le principe d’appel sera toujours identique pour les « familles » de méthodes ayant le même objectif :
• L’exemple donné pour searchWO sera déclinable aux méthodes de type search.
• L’exemple donné pour createMR sera déclinable aux méthodes de type create.
• L’exemple donné pour findTransitionWO sera déclinable aux méthodes de type finTransition.
• etc.
Par ailleurs, et comme indiqué précédemment dans ce document, ces différents exemples démontrent que tous les paramètres ne sont
pas obligatoires à l’appel d’une méthode.
2.1. Méthode retournant une liste simplifiée : searchWO
2.1.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:searchWO>
<searchBean>
<code>WO-111</code>
</searchBean>
</web:searchWO>
</soapenv:Body>
</soapenv:Envelope>
2.1.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:searchWOResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.WOBean</className>
<id> 52394789f98-13</id>
<code>WO-110</code>
<description>Purge du système hydraulique - Vanne 101</description>
<actionType>
<className>com.carl.xnet.works.backend.bean.ActionTypeBean</className>
<id>6</id>
<code>MAINT-PREV</code>
<description>Maintenance Préventive</description>
</actionType>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>14</id>
<code>DUPONT</code>
<description>Acteur de l'utilisateur DUPONT</description>
</createdBy>
<eqptBroken>false</eqptBroken>
<expWOEnd>2011-05-06T15:14:24+02:00</expWOEnd>
<fixedDt>false</fixedDt>
<statusCode>REQUEST</statusCode>
<WOBegin>2011-05-12T15:14:24+02:00</WOBegin>
<WOEnd>2011-05-12T17:14:24+02:00</WOEnd>
<workPriority>NORMAL</workPriority>
</result>
<result>
<className>com.carl.xnet.works.backend.bean.WOBean</className>
<id>22</id>
<code>WO-111</code>
<description>Contrôle Pompe haute pression 32</description>
<actionType>
<className>com.carl.xnet.works.backend.bean.ActionTypeBean</className>
<id>4</id>
<code>CTRL-SECU</code>
<description>Contrôle sécurité</description>
</actionType>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>14</id>
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 7 / 73
Web Services standard
<code>DURAND</code>
<description>Acteur de l'utilisateur DURAND</description>
</createdBy>
<eqptBroken>false</eqptBroken>
<expWOEnd>2011-05-06T15:14:24+02:00</expWOEnd>
<fixedDt>false</fixedDt>
<statusCode>INPROGRESS</statusCode>
<WOBegin>2011-05-15T15:14:24+02:00</WOBegin>
<WOEnd>2011-05-15T19:14:24+02:00</WOEnd>
<workPriority>NORMAL</workPriority>
</result>
<result>
…
…
</result>
</ns2:searchWOResponse>
</env:Body>
</env:Envelope>
2.2. Méthode retournant le détail d’un objet : getMRDetail
2.2.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:getMRDetail>
<code>MR_DISP-3</code>
</web:getMRDetail>
</soapenv:Body>
</soapenv:Envelope>
2.2.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:getMRDetailResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.MRBean</className>
<id> 12394716c39-27</id>
<code>MR_DISP-3</code>
<description>Damande d'intervention sur DISP-MAT3</description>
<addressee>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>89</id>
<code>DUPOND</code>
<description>Utilisateur DUPOND</description>
</addressee>
<amount>0.0</amount>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>89</id>
<code> DUPOND </code>
<description>Utilisateur DUPOND</description>
</createdBy>
<creationDate>2012-01-03T14:00:00+01:00</creationDate>
<eqptBroken>false</eqptBroken>
<eqptUnavailable>false</eqptUnavailable>
<expEnd>2012-01-03T14:00:00+01:00</expEnd>
<material>
<className>com.carl.xnet.equipment.backend.bean.MaterialBean</className>
<id>DISP-MAT3</id>
<code>DISP-MAT3</code>
<description>Event de dispersion active - 3</description>
</material>
<statusCode>REQUEST</statusCode>
<workPriority>NORMAL</workPriority>
<workRecept>false</workRecept>
<comment/>
</result>
</ns2:getMRDetailResponse>
</env:Body>
</env:Envelope>
8 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
2.3. Méthode de création : createMR
2.3.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:createMR>
<MR>
<code>DI_CIRC_PANNE</code>
<addressee>
<code>INTERVENANT</code>
</addressee>
<createdBy>
<code>DEMANDEUR</code>
</createdBy>
<eqptBroken>true</eqptBroken>
<expEnd>2011-11-09T17:00:00+01:00</expEnd>
<material>
<code>CIRC</code>
</material>
<statusCode>REQUEST</statusCode>
<workPriority>HIGH</workPriority>
<workRecept>true</workRecept>
</MR>
<actorCode>DEMANDEUR</actorCode>
</web:createMR>
</soapenv:Body>
</soapenv:Envelope>
2.3.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:createMRResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.MRBean</className>
<id>12fde1b9e70-3</id>
<code>DI_CIRC_PANNE</code>
<addressee>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>TECHNICIAN</id>
<code>INTERVENANT</code>
<description>Intervenant</description>
</addressee>
<amount>0.0</amount>
<boxLocation>
<className>com.carl.xnet.equipment.backend.bean.BoxBean</className>
<id>B1130340596693-50</id>
<code>ZONE-P</code>
<description>Zone de production</description>
</boxLocation>
<boxMain>
<className>com.carl.xnet.equipment.backend.bean.BoxBean</className>
<id>B9</id>
<code>LIGNE_PROD1</code>
<description>Ligne de production 14</description>
</boxMain>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>REQUESTER</id>
<code>DEMANDEUR</code>
<description>Demandeur d'intervention</description>
</createdBy>
<creationDate>2011-05-11T14:14:20.767+02:00</creationDate>
<eqptBroken>true</eqptBroken>
<eqptUnavailable>true</eqptUnavailable>
<expEnd>2011-11-09T17:00:00+01:00</expEnd>
<material>
<className>com.carl.xnet.equipment.backend.bean.MaterialBean</className>
<id>6</id>
<code>CIRC</code>
<description>Circulateur</description>
</material>
<statusCode>REQUEST</statusCode>
<workPriority>HIGH</workPriority>
<workRecept>true</workRecept>
<comment/>
</result>
</ns2:createMRResponse>
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 9 / 73
Web Services standard
</env:Body>
</env:Envelope>
2.4. Méthode de mise à jour : updateMR
2.4.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:updateMR>
<MR>
<code>DI_CIRC_PANNE</code>
<description>Demande d'intervention pour Circulateur LP1</description>
<amount>158.5</amount>
<eqptBroken>false</eqptBroken>
<eqptUnavailable>true</eqptUnavailable>
<expEnd>2011-12-09T17:00:00+01:00</expEnd>
<workPriority>VERYHIGH</workPriority>
<workRecept>false</workRecept>
<comment>DI Urgente!!!</comment>
<xtraBool02>true</xtraBool02>
<xtraNum01>1589</xtraNum01>
<xtraDate02>2013-01-02T11:17:36.789+01:00</xtraDate02>
<xtraTxt03>Texte supp.</xtraTxt03>
</MR>
</web:updateMR>
</soapenv:Body>
</soapenv:Envelope>
2.4.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:updateMRResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.MRBean</className>
<id>12fde1b9e70-3</id>
<code>DI_CIRC_PANNE</code>
<description>Demande d'intervention pour Circulateur LP1</description>
<addressee>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>TECHNICIAN</id>
<code>INTERVENANT</code>
<description>Intervenant</description>
</addressee>
<amount>158.5</amount>
<boxLocation>
<className>com.carl.xnet.equipment.backend.bean.BoxBean</className>
<id>B1130340596693-50</id>
<code>ZONE-C</code>
<description>Zone de production</description>
</boxLocation>
<boxMain>
<className>com.carl.xnet.equipment.backend.bean.BoxBean</className>
<id>B9</id>
<code>LIGNE_PROD14</code>
<description>Ligne de production 14</description>
</boxMain>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>REQUESTER</id>
<code>DEMANDEUR</code>
<description>Demandeur d'intervention</description>
</createdBy>
<creationDate>2011-05-11T14:14:20.767+02:00</creationDate>
<eqptBroken>false</eqptBroken>
<eqptUnavailable>true</eqptUnavailable>
<expEnd>2011-12-09T17:00:00+01:00</expEnd>
<material>
<className>com.carl.xnet.equipment.backend.bean.MaterialBean</className>
<id>6</id>
<code>CIRC</code>
<description>Circulateur</description>
</material>
<statusCode>REQUEST</statusCode>
<workPriority>VERYHIGH</workPriority>
<workRecept>false</workRecept>
10 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
<comment>DI Urgente!!!</comment>
<xtraBool02>true</xtraBool02>
<xtraDate02>2013-01-02T11:17:36.789+01:00</xtraDate02>
<xtraNum01>1589.0</xtraNum01>
<xtraTxt03>Texte supp.</xtraTxt03>
</result>
</ns2:updateMRResponse>
</env:Body>
</env:Envelope>
2.5. Suppression : removeMR
2.5.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:removeMR>
<code>DI-TEST</code>
</web:removeMR>
</soapenv:Body>
</soapenv:Envelope>
2.5.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:removeMRResponse
xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>Id-DI-TEST</result>
</ns2:removeMRResponse>
</env:Body>
</env:Envelope>
2.6. Recherche des transitions sur intervention : findTransitionWO
2.6.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:findTransitionWO>
<code>000076</code>
<userCode>DEMO</userCode>
</web:findTransitionWO>
</soapenv:Body>
</soapenv:Envelope>
Des méthodes équivalentes existent pour différentes entités :
• Commande : findTransitionPO
• Demande d’achat (DA) : findTransitionPR
• Demande d’intervention (DI) : findTransitionDI
• etc.
2.6.2. Sortie
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:findTransitionWOResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.status.WOInProgressTransitionBean</className>
<id>WO_AUTOREALINPROGRESS</id>
</result>
<result>
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 11 / 73
Web Services standard
<className>com.carl.xnet.works.backend.bean.status.WOCancelTransitionBean</className>
<id>WO_REAL_CANCEL</id>
</result>
<result>
<className>com.carl.xnet.works.backend.bean.status.WOInProgressTransitionBean</className>
<id>WO_INPROGRESS</id>
</result>
<result>
<className>com.carl.xnet.works.backend.bean.status.WOInProgressClosedTransitionBean</className>
<id>WO_REAL_CLOSED</id>
</result>
</ns2:findTransitionWOResponse>
</soap:Body>
</soap:Envelope>
2.7. Transition sur intervention : applyTransitionWO
2.7.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.works.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:applyTransitionWO>
<code>000076</code>
<transitionId>WO_REAL_CLOSED</transitionId>
<userCode>DEMO</userCode>
</web:applyTransitionWO>
</soapenv:Body>
</soapenv:Envelope>
Pour connaître les identifiants des transitions autorisées sur une intervention donnée, il faut au préalable exécuter
le Web Service findtransitionWO décrit dans le chapitre précédent.
2.7.2. Sortie
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:applyTransitionWOResponse xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<result>
<className>com.carl.xnet.works.backend.bean.WOBean</className>
<id>158f90e90f2-1</id>
<code>000076</code>
<description>demonstration WS</description>
<actionType>
<className>com.carl.xnet.works.backend.bean.ActionTypeBean</className>
<id>15868961abc-153e</id>
<code>ACTIONTYPE</code>
<description>nature d'intervention</description>
</actionType>
<createdBy>
<className>com.carl.xnet.system.backend.bean.ActorBean</className>
<id>14</id>
<code>DEMO</code>
<description>Agent for DEMO user</description>
</createdBy>
<eqptBroken>false</eqptBroken>
<expWOEnd>2016-12-13T17:43:40+01:00</expWOEnd>
<fixedDt>false</fixedDt>
<statusCode>CLOSED</statusCode>
<WOBegin>2016-12-13T08:00:00+01:00</WOBegin>
<WOEnd>2016-12-13T18:00:00+01:00</WOEnd>
<workInvoice>false</workInvoice>
<workPriority>ACTIVE</workPriority>
<costCenter>
<className>com.carl.xnet.budget.backend.bean.CostCenterBean</className>
<id>158c079a095-9c9b</id>
<code>CC</code>
</costCenter>
<createDate>2016-12-13T17:43:40.543+01:00</createDate>
<eqptStop>false</eqptStop>
<exceptView>false</exceptView>
<expTime>0.0</expTime>
<longDesc/>
<maintStopTime>0.0</maintStopTime>
<outOfGuarantee>false</outOfGuarantee>
<realisedRate>0.0</realisedRate>
<tools/>
<WOFatherLink>
12 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
<className>com.carl.xnet.works.backend.bean.WOLinkBean</className>
<id>158f90e90f2-4</id>
</WOFatherLink>
<workRecept>false</workRecept>
</result>
</ns2:applyTransitionWOResponse>
</soap:Body>
</soap:Envelope>
2.8. Export : exportSynchrone
2.8.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://service.backend.exchange.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<ser:exportSynchrone>
<exItfCode>USER_OUT</exItfCode>
<userCode>DEMO</userCode>
<auth>simple:demo</auth>
</ser:exportSynchrone>
</soapenv:Body>
</soapenv:Envelope>
2.8.2. Sortie
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<ns2:exportSynchroneResponse xmlns:ns2=_"http://service.backend.exchange.xnet.carl.com/"_>
<listOfMessages><![CDATA[<?xml version='1.0' encoding='UTF-8'?><entities timezone="UTC" messageId="df139a7e-
e441-452f-964b-5d613b16d8e7" exchangeInterface="USER_OUT"><user id="13" code="GUEST"> user_customGroup
entityKeys="id,code" /><user_status><status_code>ACTIVE</status_code><status_changedBy id="14" code="DEMO"><actor_job
/><actor_xtraNum02 /><actor_xtraNum01 /><actor_timeZone /> actor_birthDate /><actor_xtraNum03 /><actor_xtraBool03
/><actor_xtraBool01 /><actor_xtraBool02 /><actor_supervisor entityKeys="id,code" /><actor_fullName>Acteur de
l'utilisateur DEMO</actor_fullName><actor_site entityKeys="id,code" /><actor_address1 /><actor_xtraTxt04
/><actor_xtraTxt03 /><actor_endDate /><actor_xtraTxt02 /><actor_address2 /><actor_xtraTxt01 /> actor_address3
/><actor_hireDate
/><actor_MRAddressee>false</actor_MRAddressee><actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07 /> actor_description>Acteur de l'utilisateur
DEMO</actor_description><actor_external>false</actor_external><actor_xtraTxt06 /><actor_xtraTxt05 /><actor_state
/><actor_department /> actor_mobility>false</actor_mobility><actor_language>fr_FR</actor_language><actor_city
/><actor_zipCode /><actor_code>DEMO</actor_code><actor_xtraDate01 /><actor_xtraDate02 /><actor_xtraDate03 />
actor_phones /><actor_xtraTxt10 /><actor_country /></status_changedBy><status_changedDate>2005-08-30
13:30:08.000</status_changedDate></user_status><user_groupTech entityKeys="id,code" />
user_password>ab4f63f9ac65152575886860dde480a1</user_password><user_organization /><user_profile id="1" code="CARL"
/><user_actor id="13" code="GUEST"><actor_job /><actor_xtraNum02 /> actor_xtraNum01 /><actor_timeZone
/><actor_birthDate /><actor_xtraNum03 /><actor_xtraBool03 /><actor_xtraBool01 /><actor_xtraBool02 /><actor_supervisor
entityKeys="id,code" /> actor_fullName>Invité</actor_fullName><actor_site entityKeys="id,code" /><actor_address1
/><actor_xtraTxt04 /><actor_xtraTxt03 /><actor_endDate /><actor_xtraTxt02 /><actor_address2 /> actor_xtraTxt01
/><actor_address3 /><actor_hireDate
/><actor_MRAddressee>false</actor_MRAddressee><actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07
/><actor_description>Invité</actor_description><actor_external>false</actor_external><actor_xtraTxt06
/><actor_xtraTxt05 /><actor_state /><actor_department /><actor_mobility>false</actor_mobility>
actor_language>en_GB</actor_language><actor_city /><actor_zipCode /><actor_code>GUEST</actor_code><actor_xtraDate01
/><actor_xtraDate02 /><actor_xtraDate03 /><actor_phones /><actor_xtraTxt10 /> actor_country
/></user_actor><user_groupSite entityKeys="id,code"
/><user_code>GUEST</user_code><user_passwordValidity>90</user_passwordValidity><user_login>GUEST</user_login>
user_pwdValidityEnd>2016-08-10
22:00:00.000</user_pwdValidityEnd><user_business>DEFAULT</user_business><user_reinitPwd>true</user_reinitPwd></user><
user id="14" code="DEMO"><user_customGroup entityKeys="id,code"
/><user_status><status_code>ACTIVE</status_code><status_changedBy id="14" code="DEMO"><actor_job /><actor_xtraNum02
/><actor_xtraNum01 /><actor_timeZone /><actor_birthDate /> actor_xtraNum03 /><actor_xtraBool03 /><actor_xtraBool01
/><actor_xtraBool02 /><actor_supervisor entityKeys="id,code" /><actor_fullName>Acteur de l'utilisateur
DEMO</actor_fullName><actor_site entityKeys="id,code" /><actor_address1 /><actor_xtraTxt04 /><actor_xtraTxt03
/><actor_endDate /><actor_xtraTxt02 /><actor_address2 /><actor_xtraTxt01 /><actor_address3 /><actor_hireDate />
actor_MRAddressee>false</actor_MRAddressee><actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07 /><actor_description>Acteur de l'utilisateur
DEMO</actor_description><actor_external>false</actor_external><actor_xtraTxt06 /><actor_xtraTxt05 /><actor_state
/><actor_department /><actor_mobility>false</actor_mobility> actor_language>fr_FR</actor_language><actor_city
/><actor_zipCode /><actor_code>DEMO</actor_code><actor_xtraDate01 /><actor_xtraDate02 /><actor_xtraDate03
/><actor_phones /><actor_xtraTxt10 /> actor_country /></status_changedBy><status_changedDate>2005-08-30
13:30:08.000</status_changedDate></user_status><user_groupTech entityKeys="id,code" />
user_password>fe01ce2a7fbac8fafaed7c982a04e229</user_password><user_organization /><user_profile id="1" code="CARL"
/><user_actor id="14" code="DEMO"><actor_job /><actor_xtraNum02 /> actor_xtraNum01 /><actor_timeZone
/><actor_birthDate /><actor_xtraNum03 /><actor_xtraBool03 /><actor_xtraBool01 /><actor_xtraBool02 /><actor_supervisor
entityKeys="id,code" /> actor_fullName>Acteur de l'utilisateur DEMO</actor_fullName><actor_site entityKeys="id,code"
/><actor_address1 /><actor_xtraTxt04 /><actor_xtraTxt03 /><actor_endDate /><actor_xtraTxt02 /> actor_address2
/><actor_xtraTxt01 /><actor_address3 /><actor_hireDate
/><actor_MRAddressee>false</actor_MRAddressee><actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07 /><actor_description>Acteur de l'utilisateur
DEMO</actor_description><actor_external>false</actor_external><actor_xtraTxt06 /><actor_xtraTxt05 /><actor_state
/><actor_department /><actor_mobility>false</actor_mobility><actor_language>fr_FR</actor_language><actor_city
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 13 / 73
Web Services standard
/><actor_zipCode /><actor_code>DEMO</actor_code><actor_xtraDate01 /><actor_xtraDate02 /><actor_xtraDate03
/><actor_phones /><actor_xtraTxt10 /><actor_country /></user_actor><user_groupSite entityKeys="id,code"
/><user_code>DEMO</user_code><user_passwordValidity /><user_login>DEMO</user_login> user_pwdValidityEnd
/><user_business>DEFAULT</user_business><user_reinitPwd>false</user_reinitPwd></user><user id="15"
code="CARLSOURCE"><user_customGroup entityKeys="id,code" /><user_status>
status_code>ACTIVE</status_code><status_changedBy id="14" code="DEMO"><actor_job /><actor_xtraNum02
/><actor_xtraNum01 /><actor_timeZone /><actor_birthDate /><actor_xtraNum03 /><actor_xtraBool03 /><actor_xtraBool01
/><actor_xtraBool02 /><actor_supervisor entityKeys="id,code" /><actor_fullName>Acteur de l'utilisateur
DEMO</actor_fullName><actor_site entityKeys="id,code" /><actor_address1 /><actor_xtraTxt04 /><actor_xtraTxt03
/><actor_endDate /><actor_xtraTxt02 /><actor_address2 /><actor_xtraTxt01 /><actor_address3 /><actor_hireDate
/><actor_MRAddressee>false</actor_MRAddressee> actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07 /><actor_description>Acteur de l'utilisateur DEMO</actor_description>
actor_external>false</actor_external><actor_xtraTxt06 /><actor_xtraTxt05 /><actor_state /><actor_department
/><actor_mobility>false</actor_mobility><actor_language>fr_FR</actor_language> actor_city /><actor_zipCode
/><actor_code>DEMO</actor_code><actor_xtraDate01 /><actor_xtraDate02 /><actor_xtraDate03 /><actor_phones
/><actor_xtraTxt10 /><actor_country /></status_changedBy> status_changedDate>2005-08-30
13:30:08.000</status_changedDate></user_status><user_groupTech entityKeys="id,code"
/><user_password>fe01ce2a7fbac8fafaed7c982a04e229</user_password> user_organization /><user_profile id="1"
code="CARL" /><user_actor id="15" code="CARLSOURCE"><actor_job /><actor_xtraNum02 /><actor_xtraNum01
/><actor_timeZone /><actor_birthDate /> actor_xtraNum03 /><actor_xtraBool03 /><actor_xtraBool01 /><actor_xtraBool02
/><actor_supervisor entityKeys="id,code" /><actor_fullName>Utilisateur système</actor_fullName><actor_site
entityKeys="id,code" /><actor_address1 /><actor_xtraTxt04 /><actor_xtraTxt03 /><actor_endDate /><actor_xtraTxt02
/><actor_address2 /><actor_xtraTxt01 /><actor_address3 /><actor_hireDate />
actor_MRAddressee>true</actor_MRAddressee><actor_statusCode>ACTIVE</actor_statusCode><actor_xtraTxt09
/><actor_xtraTxt08 /><actor_xtraTxt07 /><actor_description>Utilisateur
système</actor_description><actor_external>false</actor_external><actor_xtraTxt06 /><actor_xtraTxt05 /><actor_state
/><actor_department /><actor_mobility>false</actor_mobility> actor_language>fr_FR</actor_language><actor_city
/><actor_zipCode /><actor_code>CARLSOURCE</actor_code><actor_xtraDate01 /><actor_xtraDate02 /><actor_xtraDate03
/><actor_phones /><actor_xtraTxt10 /><actor_country /></user_actor><user_groupSite entityKeys="id,code"
/><user_code>CARLSOURCE</user_code><user_passwordValidity /><user_login>CARLSOURCE</user_login><user_pwdValidityEnd
/> user_business>DEFAULT</user_business><user_reinitPwd>true</user_reinitPwd></user></entities>]]></listOfMessages>
</ns2:exportSynchroneResponse>
</env:Body>
</env:Envelope>
2.9. Import : processSynchrone
2.9.1. Utilisation du format XML : Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://service.backend.exchange.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<ser:processSynchrone>
<exItfCode>COSTCENTER_IN</exItfCode>
<msgData><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
<entities>
<costCenter code="TRAVAUX-NEUFS-2017">
<costcenter_begin>2017-01-01</costcenter_begin>
<costcenter_end>2017-12-31</costcenter_end>
<costcenter_controlLevel>GLOBAL</costcenter_controlLevel>
<costcenter_description>Centre de Coût pour le suivi des travaux neufs 2017</costcenter_description>
<costcenter_code>TRAVAUX-NEUFS-2017</costcenter_code>
</costCenter>
</entities>]]></msgData>
<actorCode>DEMO</actorCode>
</ser:processSynchrone>
</soapenv:Body>
</soapenv:Envelope>
2.9.2. Utilisation du format XML : Sortie
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:processSynchroneResponse xmlns:ns2="http://service.backend.exchange.xnet.carl.com/"/>
</soap:Body>
</soap:Envelope>
2.9.3. Utilisation du format CSV : Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://service.backend.exchange.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<ser:processSynchrone>
<exItfCode>COSTCENTER_IN_CSV</exItfCode>
<msgData>;exchangeInterface ;COSTCENTER_IN_CSV ;timezone ;UTC
COSTCENTER;TRAVAUX-NEUFS-2017;TRAVAUX-NEUFS-2017;Centre de Coût pour le suivi des travaux neufs 2017;2017-01-01;2017-
12-31;GLOBAL;;;</msgData>
<actorCode>DEMO</actorCode>
14 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
</ser:processSynchrone>
</soapenv:Body>
</soapenv:Envelope>
2.9.4. Utilisation du format CSV : Sortie
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:processSynchroneResponse xmlns:ns2="http://service.backend.exchange.xnet.carl.com/"/>
</soap:Body>
</soap:Envelope>
2.10. Import de liens : importLinkEquipmentO
2.10.1. Entrée
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:web="http://webservice.backend.equipment.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<web:importLinkEquipmentO>
<junction>
<id>MAINMATERIAL</id>
</junction>
<parent>
<code>CENTRALE</code>
</parent>
<child>
<code>MA-000011</code>
</child>
<linkBegin>2016-12-18T10:15:01+01:00</linkBegin>
</web:importLinkEquipmentO>
</soapenv:Body>
</soapenv:Envelope>
2.10.2. Sortie
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns2:importLinkEquipmentOResponse xmlns:ns2="http://webservice.backend.equipment.xnet.carl.com/">
<result>NO ERROR</result>
</ns2:importLinkEquipmentOResponse>
</soap:Body>
</soap:Envelope>
2.10.3. Erreurs
2.10.3.1. Code existant (exemple : createWO)
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>La valeur WO_EXP1 existe déjà pour le champ Code de l'intervention. </faultstring>
<detail>
<ns2:WebServiceException xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<code>com.carl.frmk.backend.services.DataInconsistencyException</code>
<message>La valeur WO_EXP1 existe déjà pour le champ Code de l'intervention.</message>
</ns2:WebServiceException>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
2.10.3.2. Date incorrecte (exemple : createMeasureReading)
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 15 / 73
Web Services standard
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>La date pour le compteur VEH_8597_J1 est incorrecte.</faultstring>
<detail>
<ns2:WebServiceException xmlns:ns2="http://webservice.backend.equipment.xnet.carl.com/">
<code>com.carl.xnet.equipment.backend.exceptions.MeasureReadingDateException</code>
<message>La date pour le compteur VEH_8597_J1 est incorrecte.</message>
</ns2:WebServiceException>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
2.10.3.3. Contrôle des données obligatoires (exemple : createWO)
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>Le centre de coût est obligatoire sur l'intervention WO_EXT_05 car elle est
validée.</faultstring>
<detail>
<ns2:WebServiceException xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<code>com.carl.xnet.works.backend.exceptions.WOMandatoryCostCenterException</code>
<message>Le centre de coût est obligatoire sur l'intervention WO_EXT_05 car elle est
validée.</message>
</ns2:WebServiceException>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
2.10.3.4. Contrôle de cohérence des données (exemple : applyTransitionMR)
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
<env:Header/>
<env:Body>
<env:Fault>
<faultcode>env:Server</faultcode>
<faultstring>Changement d'état non autorisé.</faultstring>
<detail>
<ns2:WebServiceException xmlns:ns2="http://webservice.backend.works.xnet.carl.com/">
<code>com.carl.xnet.system.status.IllegalTransitionException</code>
<message>Changement d'état non autorisé.</message>
</ns2:WebServiceException>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>
16 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
3. DEMANDE D’INTERVENTION (DI): MRWEBSERVICE
3.1. Objets VO principaux
3.1.1. MRSearchVO
Critères de recherche des demandes d’intervention.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet MRBean Texte
code * Code de la DI Code
adressee Destinataire de la DI Code
boxLocation Point géographique de la DI Code
box Point principal de la DI Code
createdBy Acteur ayant créé la DI Code
customer Client Code
dateMaxi Date maximum de début Date
dateMini Date minimum de début Date
description Description Texte
EndDateMaxi Date de fin maximum de la DI Date
EndDateMini Date de fin minimum de la DI Date
eqptUnavailable Équipement indisponible Booléen
estimate Devis client Code
item Article Code
latitude Latitude Numérique
longitude Longitude Numérique
material Matériel concerné par la DI Code
reportDateMaxi Date de prise en compte max Date
reportDateMini Date de prise en compte min Date
site Site concerné Code
status État de la DI Code Workflow MRSTATUS
WODiag Diagnostic à l’origine de la DI Code
workPriority Priorité de la DI Valeur de liste 'PRIORITYLEVEL'
3.1.2. MRHeaderVO
Informations principales de la demande d’intervention.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet MRBean Texte
id Identifiant de la DI Identifiant
code * Code de la DI Code
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 17 / 73
Web Services standard
Nom Description Type Commentaire
description Description de la DI Libellé
adressee Destinataire de la DI Objet
amount Montant de la DI Numérique
askedBy Demandeur de la DI Texte
askedByPhone Coordonnées du demandeur Texte
boxLocation Point géographique de la DI Objet
boxMain Point principal de la DI Objet
createdBy Acteur ayant créé la DI Objet
creationDate Date de création de la DI Date
customer Client Objet
eqptBroken Équipement en panne Booléen
eqptUnavailable Équipement indisponible Booléen
estimate Devis client Objet
expEnd Fin de DI souhaité Date
latitude Latitude Numérique
longitude Longitude Numérique
material Matériel concerné par la DI Objet
site Site concerné Objet
statusCode État de la DI Code workflow MRSTATUS
symptom Symptôme rapporté Objet
workCategory Catégorie Valeur de liste WORKCATEGORY
workPriority Priorité de la DI Valeur de liste PRIORITYLEVEL
workRecept Réception des travaux Booléen
address Adresses de la DI Objet MRAddressVO
3.1.3. MRVO
Informations complètes de la demande d’intervention.
Cet objet contient tous les attributs de MRHeaderVO complétés par les attributs suivants.
Nom Description Type Commentaire
comment Description de la DI Libellé long
WO Intervention liée Objet WOVO
3.2. Recherche DI : searchMR
Cette méthode retourne une liste de DI répondant aux critères donnés en entrée.
18 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
3.2.1. Paramètres d’entrée (MRSearchVO)
Nom Description Type Commentaire
searchBean Attributs de l’objet Objet MRSearchVO
3.2.2. Informations retournées (MRHeaderVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet MRHeaderVO
3.3. Détail DI : getMRDetail
Cette méthode retourne le détail d’une DI dont le code ou l’identifiant est passé en paramètre.
3.3.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DI Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DI Code renseigné.
3.3.2. Informations retournées (MRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet MRVO
3.4. Création DI : createMR
Cette méthode permet la création d’une DI en fournissant les paramètres voulus.
3.4.1. Paramètres d’entrée (MRVO)
Nom Description Type Commentaire
MR Attributs de l’objet Objet MRVO
actorCode * Code de l’acteur du changement d’état Code
3.4.2. Paramètres de sortie (MRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet MRVO
3.5. Mise à jour DI : updateMR
Cette méthode assure la mise à jour de la DI dont le code ou l’identifiant est passé en paramètre.
3.5.1. Paramètres d’entrée (MRVO)
Nom Description Type Commentaire
MR Attributs de l’objet Objet MRVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 19 / 73
Web Services standard
3.5.2. Informations retournées (MRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet MRVO
3.6. Suppression DI : removeMR
Cette méthode assure la suppression une DI dont le code ou l’identifiant est passé en paramètre.
3.6.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DI Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DI Code renseigné.
3.6.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de la DI supprimée Identifiant
3.7. Transitions permises : findTransitionMR
Cette méthode renvoie les transitions étant acceptées sur la DI donnée.
3.7.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DI Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DI Code renseigné.
Pour connaître les
userCode Identifiant de l’utilisateur Code transitions autorisées à
son profil
3.7.2. Informations retournées
Nom Description Type Commentaire
className Nom complet de la classe de transition Texte
id Identifiant de la transition Identifiant
L’identifiant de transition servira en paramètre d’entrée dans la méthode applyTransitionMR.
3.8. Changement d’état : applyTransitionMR
Cette méthode applique une transition sur la DI dont le code ou l’identifiant est passé en paramètre.
Exemple : Passer une DI de l’état "En attente prise en compte" à l’état "Refusé".
3.8.1. Paramètres d’entrée
20 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
id * Identifiant de la DI Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DI Code renseigné.
transitionId * Identifiant de la transition Identifiant
commentStatus Commentaire de la transition Libellé long
Pour application des droits
userCode * Code de l’acteur de la transition Code
de profil.
Pour connaître les identifiants des transitions autorisées sur une DI donnée, il faut au préalable exécuter le Web
Service findtransitionDI (voir ici un exemple équivalent avec une intervention).
3.8.2. Informations retournées (MRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet MRVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 21 / 73
Web Services standard
4. INTERVENTION : WOWEBSERVICE
4.1. Objets VO principaux
4.1.1. WOSearchVO
Critères de recherches des interventions.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet WOBean Texte
actionGroup Regroupement (Thème de nature d’intervention) Valeur de liste 'ACTIONGROUP'
actionType Nature d’intervention Code
boxLocation Point géographique Code
boxMain Point principal Code
code Intervention Code
contract Contrat Code
costCenter Centre de coût Code
createdBy Créateur de l’intervention Code
cure Remède Code
customer Client Code
description Libellé Libellé
eqptBroken Matériel en panne Booléen
eqptStop Matériel à l’arret Booléen
estimate Devis client Code
failureCause Cause Code
latitude Latitude Numérique
longitude Longitude Numérique
MR DI Code
material Matériel Code
PWO Gamme Code
pattern Modèle Code
preventive Plan préventif Code
priority Priorité - 0…n Valeur de liste 'PRIORITYLEVEL'
project Projet Code
projectFather Projet parent Code
resource Intervenant Code
site Site Code
skill Spécialité Code
status État de l’intervention Code Workflow WOSTATUS
supervisor Responsable Code
22 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
symptom Symptôme Code
team Equipe Code
vendor Prestataire Code
WOBeginMax Date de début Maxi Date
WOBeginMin Date de début Mini Date
WOEndMax Date de fin Maxi Date
WOEndMin Date de fin Mini Date
workCategory Catégorie d’intervention Valeur de liste WORKCATEGORY
workInvoice Facturable ? Booléen
workRecept Réception des travaux ? Booléen
workType Type d’intervention Valeur de liste WORKTYPE
4.1.2. WOHeaderVO
Informations principales de la demande d’intervention.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet WOBean Texte
id Identifiant Identifiant
Code * Intervention Code
actionType Nature d’intervention Objet
boxLocation Point géographique Code
boxMain Point principal Code
contract Contrat Objet
createdBy Créateur de l’intervention Objet
customer Client Objet
description Libellé Libellé
eqptBroken Matériel en panne Booléen
estimate Devis client Objet
expWOEnd Fin d’intervention Date
fixedDt Date fixée ? Booléen
latitude Latitude Numérique
longitude Longitude Numérique
material Matériel Objet
pattern Modèle Objet
project Projet Code
PWO Gamme Objet
site Site Objet
statusCode État Code Workflow WOSTATUS
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 23 / 73
Web Services standard
Nom Description Type Commentaire
supervisor Responsable Objet
WOBegin Date de début Date
WOEnd Date de fin Date
workInvoice Facturable ? Booléen
workPriority Priorité Valeur de liste PRIORITYLEVEL
workType Type Valeur de liste WORKTYPE
4.1.3. WOVO
Informations complètes de l’intervention.
Cet objet contient tous les attributs de WOHeaderVO complétés par les attributs suivants.
Nom Description Type Commentaire
contractPeriod Période de contrat Objet
costCenter * Centre de coût d’imputation Objet
createDate Date de création Date
cure Remède Objet
evaluation Evaluation (Diagnostic) Objet
exceptView Hors forfait ? Booléen
expTime Temps prévu Numérique
failureCause Cause de la panne Objet
guarantee Garantie applicable sur l’intervention. Objet
habilitations Ensemble d’habilitations Objet habilitationVO
links Ensemble d’interventions liées Objet woLinkVo
longDesc Commentaire Libellé long
maintPlan Fiche maintenance Objet
maintStopTime Temps d’arrêt Numérique
Objet
measureReading Relevé de mesure
woMeasureReadingVO
MRLinks Ensemble de demandes d’intervention Objet MRLinkVO
occupations Ensemble d’occupations Objet occupationVO
outOfGarantee Intervention hors garantie ? Booléen
processes Ensemble d’opérations Objet ProcessVO
purchaseLineItems Ensemble d’achats articles prévus Objet purchaseElementVO
purchaseLineServices Ensemble d’achats services prévus Objet purchaseElementVO
realisedRate % réalisation Numérique
reservedItems Ensemble de réservations Objet reserveVO
risks Ensemble derisques Objet WORiskVO
24 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
Objet
stockMovements Mouvement de stock
WOStockMovementVO
symptom Symptôme Objet
tools Moyens nécessaires Libellé long
vendor Prestataire Objet
WOFatherLink Intervention parent Objet
WOResources Ensemble de ressources Objet resourceVO
workRecept Réception des travaux ? Booléen
actToolCost Coût réalisé moyen matériel Numérique
expTimeTools Charge prévue pour les moyens matériels Numérique
expectedToolCost Coût prévu des moyens matériels Numérique
WOToolOccupations Temps d’utilisation des moyens matériels Objet toolOccupationVO
WOTools Moyens nécessaires à l’intervention Objet woToolVO
allAddresses Adresses de l’intervention Objet WOAddressVO
4.2. Recherche d’interventions : searchWO
Cette méthode retourne une liste d’interventions répondant à un ensemble de critères passés en paramètres.
4.2.1. Paramètres d’entrée (WOSearchVO)
Nom Description Type Commentaire
searchBean Attributs de l’objet Objet WOSearchVO
4.2.2. Informations retournées (WOHeaderVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet WOHeaderVO
4.3. Détail intervention : getWODetail
Cette méthode retourne le détail de l’intervention passée en paramètre.
4.3.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de l’intervention Identifiant L’un des deux champs doit
obligatoirement être
code * Code de l’intervention Code renseigné.
4.3.2. Informations retournées (wovo)
Nom Description Type Commentaire
result Attributs de l’objet Objet WOVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 25 / 73
Web Services standard
4.4. Creation d’intervention : createWO
Cette méthode permet de créer une intervention.
4.4.1. Paramètres d’entrée (wovo)
Nom Description Type Commentaire
WO Attributs de l’objet Objet WOVO
actorCode * Acteur ayant saisi l’intervention Code
4.4.2. Informations retournées (wovo)
Nom Description Type Commentaire
result Attributs de l’objet Objet WOVO
4.5. Mise à jour Intervention : updateWO
Cette méthode permet de mettre à jour les données d’une intervention existante.
4.5.1. Paramètres d’entrée (wovo)
L’identifiant ou le code dans WOVO doit obligatoirement être renseigné pour désigner l’intervention impactée.
Nom Description Type Commentaire
WO Attributs de l’objet Objet WOVO
4.5.2. Informations retournées (wovo)
Nom Description Type Commentaire
result Attributs de l’objet Objet WOVO
4.6. Suppression d’une intervention : removeWO
Cette méthode permet de supprimer une intervention passée en paramètre.
4.6.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de l’intervention Identifiant L’un des deux champs doit
obligatoirement être
code * Code de l’intervention Code renseigné.
4.6.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de l’intervention supprimée Identifiant
4.7. Recherche transitions : findTransitionWO
Cette méthode retourne les transitions valides pour l’intervention dont le code ou l’identifiant est passé en paramètre.
26 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
4.7.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de l’intervention Identifiant L’un des deux champs doit
obligatoirement être
code * Code de l’intervention Code renseigné.
Pour connaître les
userCode Identifiant de l’utilisateur Code transitions autorisées à
son profil.
4.7.2. Informations retournées
Nom Description Type Commentaire
className Nom complet de la classe de transition Texte
id Identifiant de la transition Identifiant
L’identifiant de transition servira en paramètre d’entrée dans la méthode applyTransitionWO.
4.8. Changement d’état WO : applyTransitionWO
Applique la transition passée en paramètre à l’intervention dont le code ou l’id est passé en paramètre et retourne l’intervention dont
l’état a été modifié, si tout s’est bien passé.
4.8.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de l’intervention Identifiant L’un des deux champs doit
obligatoirement être
code * Code de l’intervention Code renseigné.
transitionId * Identifiant de la transition Identifiant
commentStatus Commentaire du changement d’état Texte
Pour connaître les
userCode Identifiant de l’utilisateur Code transitions autorisées à
son profil.
Pour connaître les identifiants des transitions autorisées sur une intervention donnée, il faut au préalable exécuter
le Web Service findtransitionWO (voir exemple).
4.8.2. Informations retournées (wovo)
Nom Description Type Commentaire
result Attributs de l’objet Objet WOVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 27 / 73
Web Services standard
5. POINT DE STRUCTURE : BOX
5.1. Objets VO principaux
5.1.1. BoxSearchVO
Critères de recherche d’un point.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet BoxBean Texte
boxComp Point ascendant Code
code Point de structure Code
costCenter Centre de coût Code
customer Client Code
description Libellé Libellé
eqptType Type d’équipement Code
item Article Code
latitude Latitude Numérique
longitude Longitude Numérique
pattern Modèle Code
site Site Code
status État du point Code Workflow BOXSTATUS
structure Structure Code
supervisor Responsable Code
WOAuthorized Interventions autorisées ? Booléen
5.1.2. BoxHeaderVO
Informations principales d’un point.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet BoxBean Texte
id Identifiant de la commande Identifiant
code Code de la commande Code
costcenter Centre de coût Objet
customer Client Objet
description Libellé libellé
latitude Latitude Numérique
longDesc Commentaire long Libellé long
longitude Longitude Numérique
safety Fiche sécurité Objet
eqptType Type d’équipement Code
28 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
pattern Modèle Objet
site Site Objet
status État du point Code Workflow BOXSTATUS
structure Structure Objet
supervisor Responsable Objet
WOAuthorized Interventions autorisées ? Booléen
5.2. Recherche points de structures : getBoxList
Cette méthode renvoie le détail des points de structure répondant aux critères de recherche envoyés.
5.2.1. Paramètres d’entrée (BoxSearchVO)
Nom Description Type Commentaire
query Attributs de l’objet Objet BoxSearchVO
5.2.2. Informations retournées (BoxHeaderVO)
Nom Description Type Commentaire
return Attributs de l’objet Objet BoxHeaderVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 29 / 73
Web Services standard
6. MATÉRIEL : MATERIAL
6.1. Objets VO principaux
6.1.1. MaterialSearchVO
Critères de recherche du matériel.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet MaterialBean Texte
availGroup Groupe de disponibilité Code
box Point de structure Code
code Matériel Code
costCenter Centre de coût Code
customer Client Code
description Libellé Libellé
eqptType Type de point Code
fromContract Sous contrat ? Booléen
guaranted Sous garantie ? Booléen
inStock En stock Booléen
item Article Code
itemFamily Famille de l’article Code
latitude Latitude Numérique
longitude Longitude Numérique
manufacturer Fabricant Code
referMaterial Matériel référent Code
reparable Réparable ? Booléen
serialNumber Numéro de série Texte
site Site Code
Workflow
status État Code
MATERIALSTATUS
supervisor Responsable Code
support SAV Code
vendor Fournisseur Code
6.1.2. MaterialHeaderVO
Informations principales du matériel.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet BoxBean Texte
id Identifiant Identifiant
brand Marque Objet
30 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
code Matériel Code
costCenter Centre de coût Objet
customer Client Objet
criticaly Criticité Objet
description Libellé Libellé
endGuarantee Date de fin de garantie Date
eqptType Type de point Valeur de liste
guaranteeMainMeasure Valeur de fin de garantie du point de mesure principal Numérique
Valeur de fin de garantie du point de mesure principal
guaranteeMainMeasure2 Numérique
2
latitude Latitude Numérique
location Emplacement Objet
longitude Longitude Numérique
mainMeasurePoint Point de mesure principal Objet
mainMeasurePoint2 Point de mesure principal 2 Objet
manufacturer Fabriquant Objet
pattern Modèle Objet
purchaseDate Date d’achat Date
purchasePr Valeur d’achat Numérique
referMaterial Matériel référent ? Booléen
reparable Réparable ? Booléen
replacementPr Valeur de remplacement Numérique
residualPr Valeur résiduelle Numérique
safety Fiche de sécurité Objet
serialNumber Numéro de série Texte
site Site Objet
Workflow
status État Code
MATERIALSTATUS
supervisor Responsable Objet
supplier Fournisseur Objet
support SAV Objet
warehouse Magasin Objet
6.2. Recherche matériel : getMaterialList
Cette méthode retourne une liste de matériels répondant à un ensemble de critères de filtre passés en paramètre.
6.2.1. Paramètres d’entrée (MaterialSearchVO)
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 31 / 73
Web Services standard
Nom Description Type Commentaire
query Attributs de l’objet Objet MaterialSearchVO
6.2.2. Informations retournées (MaterialHeaderVO)
Nom Description Type Commentaire
return Attributs de l’objet Objet MaterialHeaderVO
32 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
7. LIEN ÉQUIPEMENTS : LINKEQUIPMENT
7.1. Objets VO principaux
7.1.1. LinkEquipmentSearchVO
Critères de recherche de lien équipement.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
className Texte
LinkEquipmentBean
child Fils Code
childStructure Structure du fils (réseau ou arbo) Code
linkBeginMax Date maximum du début du lien Date
linkBeginMin Date minimum du début du lien Date
parent Parent Code
parentStructure Structure du parent Code
structure Structure de la jonction (réseau ou arbo) Code
7.1.2. LinkEquipmentVO
Informations complètes du lien équipement.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
className Texte
LinkEquipmentBean
id Identifiant du lien Identifiant
child Fils Objet equipmentVO
description Description du lien Texte
junction Jonction du lien Objet
linkBegin Date de début du lien Date
linkEnd Date de fin du lien Date
ordering Position du lien Numérique
parent Parent Objet equipmentVO
qtLink Quantité du lien Numérique
7.2. Recherche de liens : getLinkEquipmentList
Cette méthode retourne une liste de liens équipements répondant à un ensemble de critères de filtre passés en paramètre.
7.2.1. Paramètres d’entrée (LinkEquipmentSearchVO)
Nom Description Type Commentaire
Objet
query Attributs de l’objet
LinkEquipmentSearchVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 33 / 73
Web Services standard
7.2.2. Informations retournées (LinkEquipmentVO)
Nom Description Type Commentaire
results Attributs de l’objet Objet LinkEquipmentVO
7.3. Import de liens : importLinkEquipmentO
Cette méthode crée ou met à jour un lien équipement.
Cette méthode remplace la méthode « importLinkEquipment » devenue obsolète.
Elle lui rajoute notamment un numéro d’ordre pour le lien importé.
7.3.1. Paramètres d’entrée
Nom Description Type Commentaire
junction * Jonction Objet junctionVO
parent Parent Objet equipmentVO
child * Fils Objet equipmentVO
linkBegin Date de début du lien Date
linkEnd Date de fin du lien Date
qtLink Quantité du lien Numérique
description Description du lien Texte
ordering Numéro d’ordre du lien Numérique
7.3.2. Informations retournées
Si le lien est correctement créé, le code résultat NO ERROR est renvoyé par l’application.
34 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
8. RELEVÉS DE MESURE : MEASUREREADING
8.1. Objets VO principaux
8.1.1. MeasurePointDetailVO
Informations complètes du point de mesure.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
className texte
MeasurePointBean
id Identifiant du point de mesure Identifiant
code Code du point de mesure Code
averageMeasure Valeur de vieillissement moyen Numérique
averagePeriod Période de vieillissement moyen Numérique
box Point de mesure lié Objet
category Catégorie Texte
correctionHighLimit Plafond de correction Numérique
correctionLowLimit Plancher de correction Numérique
costCenter Centre de coût Objet
createMR Créer une DI ? Booléen
decimal Nombre de décimales Numérique
description Libellé Libellé
lastReadingDate Date du dernier relevé Date
lastReadingMeasure Valeur du dernier relevé Numérique
material Équipement lié Objet
measurePattern Modèle de point de mesure Objet
monitorHighLimit Plafond de surveillance Numérique
monitorLowLimit Plancher de surveillance Numérique
periodReading Période des relevés Numérique
realMeasurePoint Point de mesure réel ? Booléen
sendMail Envoyer un mail ? Booléen
site Site Objet
type Type de point de mesure Objet
typeCost Type de coût Objet
unit Unité Objet
unitCost Coût unitaire Numérique
valMaxi Valeur maximale Numérique
valMini Valeur minimum Numérique
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 35 / 73
Web Services standard
8.1.2. MeasureSearchVO
Critères de recherche de mesures à effectuer.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
lassName Texte
MeasurePointBean
box Point de structure Code
category Catégorie Texte
description Description Libellé
material Équipement Code
measurePattern Modèle du point de mesure Code
measurePoint Code Code
Forcé à vrai en 3.1 (pas de
realMeasurePoint Point de mesure réel ? Booléen relevé de point de mesure
fictif)
type Type Valeur de liste 'MEASUREPOINTTYPE'
8.1.3. MeasureToReadVO
Informations principales du point de mesure à relever.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
className Texte
MeasurePointBean
id Identifiant du point de mesure Identifiant
code Code du point de mesure Code
description Libellé Libellé
lastReadingMeasure Valeur du dernier relevé Numérique
unit Unité du point de mesure Objet
8.1.4. MeasureReadingVO
Informations du relevé de mesure.
Nom Description Type Commentaire
Nom complet de la classe de l’objet
className Texte
MeasureReadingBean
id Identifiant Identifiant
correction Correction de la valeur précédente ? Booléen
createdBy Acteur de l’enregistrement Objet
dateMeasure * Date de la mesure Date
36 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
Un des 2 champs measure
measure * Valeur de la mesure Numérique
ou variation doit
obligatoirement être
variation * Valeur de la variation Numérique
renseigné
measurePoint * Point de mesure Objet
Répercuter la correction sur les points de mesure
repercussion Booléen
cibles
userCode Utilisateur Code
8.2. Détail d’un point de mesure : getMesurePointDetail
Cette méthode retourne le détail d’un point de mesure selon l’identifiant ou le code transmis.
8.2.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant du point de mesure Identifiant L’un des deux champs doit
obligatoirement être
code * Code du point de mesure Code renseigné.
8.2.2. Informations retournées (MeasurePointDetailVO)
Nom Description Type Commentaire
Objet
measurePoint Attributs de l’objet
MeasurePointDetailVO
8.3. Relevés en attente : getMeasureToRead
Retourne une liste de relevés de mesure à effectuer, pour un ensemble de critères de filtre passés en paramètre.
8.3.1. Paramètres d’entrée (MeasureSearchVO)
Nom Description Type Commentaire
query Attributs de l’objet Objet MeasureSearchVO
8.3.2. Informations retournées (MeasureToReadVO)
Nom Description Type Commentaire
measurePoints Attributs de l’objet Objet MeasureToReadVO
8.4. Relevé de mesure : createMeasureReading
Cette méthode permet de créer des relevés de mesures.
8.4.1. Paramètres d’entrée (MeasureReadingVO)
Nom Description Type Commentaire
measureReading Attributs de l’objet Objet MeasureReadingVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 37 / 73
Web Services standard
8.4.2. Informations retournées
Nom Description Type Commentaire
idCreated Identifiant de la mesure créée Identifiant
38 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
9. EVÈNEMENT SUR ÉQUIPEMENT : EVENT
9.1. Objets VO Principaux
9.1.1. EventSearchVO
Critères de recherche des évènements.
Nom Description Type Commentaire
className Nom complet de la classe de l’objet EventBean Texte
box Point de structure de l’évènement Code
comment Commentaire Texte
dateMax Date maximum de l’évènement Date
dateMin Date minimale de l’évènement Date
material Matériel lié à l’évènement Code
symptom Symptôme de l’évènement Objet
9.1.2. EventVO
Informations principales d’un évènement.
Nom Description Type Commentaire
classname Classe Texte
id Identifiant de l’événement Identifiant Ignoré en création
box * Point de structure Objet
comment Commentaire Texte
eventDate Date de l’évènement Date
material * matériel Objet
symptom * Symptôme Objet
9.2. Recherche évènement : getEventList
Cette méthode permet de retourner le détail des événements correspondant au filtre transmis.
9.2.1. Paramètres d’entrée (EventSearchVO)
Nom Description Type Commentaire
query Attributs de l’objet Objet EventSearchVO
9.2.2. Informations retournées (EventVO)
Nom Description Type Commentaire
results Attributs de l’objet Objet EventVO
9.3. Création évenement : createEvent
Cette méthode crée l’événement avec les paramètres renseignés.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 39 / 73
Web Services standard
9.3.1. Paramètres d’entrée (EventVO)
Nom Description Type Commentaire
event Attributs de l’objet Objet EventVO
actorCode Utilisateur à l’origine de l’enregistrement Code
9.3.2. Informations retournées
Nom Description Type Commentaire
id Identifiant de l’évènement créé Identifiant
40 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
10. DEMANDE D’ACHAT : PR
10.1. Objets VO principaux
10.1.1. PRSearchVO
Critère de recherche de la demande d’achat.
Nom Description Type Commentaire
classname Classe Texte
askedBy Emetteur de la DA Code
budgAcc Budget Code
code Code Code
contract Contrat Code
costCenter Centre de coût Code
deliverySite Site de livraison Code
description Libellé Libellé
item Article Code
itemDescription Libellé de l’article Libellé
maxCreation Date maxi de création Date
maxOrder Date maxi de la commande Date
maxReception Date maxi de la livraison Date
maxValidation Date maxi de la validation Date
minCreation Date mini de création Date
minOrder Date mini de la commande Date
minReception Date mini de la livraison Date
minValidation Date mini de la validation Date
origin Origine de la DA Valeur de liste PRORIGIN
packet Colis Libellé
purchaseType Nature d’achat Code
service Prestation Code
site Site Code
Workflow PRSTATUS
Balise à répéter pour
status Liste d’états Code
chaque valeur du critère
"État" de la recherche.
supplier Fournisseur Code
supplierReference Référence fournisseur Code
urgent Urgent ? Booléen
WO Intervention Code
warehouse Magasin Code
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 41 / 73
Web Services standard
10.1.2. PRHeaderVO
Informations principales d’une demande d’achat.
Nom Description Type Commentaire
classname Classe Texte
id * Identifiant de la DA Identifiant
code * Code de la DA Code
description Libellé Libellé
amountHT Montant total HT dans la devise de référence Numérique
amountHTRef Montant total HT dans la devise du fournisseur Numérique
amountTTC Montant total TTC dans la devise de référence Numérique
amountTTCRef Montant total TTC dans la devise du fournisseur Numérique
amountTaxes Montant taxes dans la devise de référence Numérique
amountTaxesRef Montant taxes dans la devise du fournisseur Numérique
askedBy Emetteur de la DA Objet
budgAcc Budget Objet
comment Commentaire Libellé long
costCenter Centre de coût Objet
deliveryDate Date de livraison Date
deliverySite Site de livraison Objet
exchangeRate Taux de change Numérique
origin Origine de la DA Valeur de liste PRORIGIN
packet Colis Libellé
site Site Objet
statusCode État Code Workflow PRSTATUS
supplier Fournisseur Objet
supplierCurrency Devise fournisseur Objet
urgent Urgent ? Booléen
10.1.3. PRVO
Informations détaillées de la demande d’achat.
Cet objet contient tous les attributs de PRHeaderVO complétés par les attributs suivants.
Nom Description Type Commentaire
contract Contrat Objet
contractPeriod Période de contrat Objet
purchaseLines Ligne DA Objet PRLineVO
WO Intervention Objet
42 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
10.2. Changement d’etat : ApplyTransitionPR
Cette méthode permet de modifier l’état d’une demande d’achat à l’aide d’une transition.
10.2.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DA Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DA Code renseigné.
transitionId * Identifiant de la transition Identifiant
commentStatus Commentaire de la transition Libellé long
userCode * Code de l’acteur de la transition Code
Pour connaître les identifiants des transitions autorisées sur une DA donnée, il faut au préalable exécuter le Web
Service findtransitionPR (voir ici un exemple équivalent avec une intervention).
10.2.2. Informations retournées (PRVO)
Nom Description Type Commentaire
results Attributs de l’objet Objet PRVO
10.3. Creation DA : createPR
Cette méthode assure la création d’une DA suivant les paramètres passés.
10.3.1. Paramètres d’entrée (PRVO)
Nom Description Type Commentaire
PR Attributs de l’objet Objet PRVO
actorCode * Acteur de la création Code
10.3.2. Informations retournées (PRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet PRVO
10.4. Détail DA : getPRDetail
Cette méthode retourne le détail d’une DA données en paramètre.
10.4.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DA Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DA Code renseigné.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 43 / 73
Web Services standard
10.4.2. Informations retournées (PRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet PRVO
10.5. Mise à jour DA : updatePR
Cette méthode permet de mettre à jour une DA avec les éléments passés en paramètre.
10.5.1. Paramètres d’entrée (PRVO)
L’identifiant ou le code de la demande d’achat doit être précisé afin de désigner la DA concernée.
Nom Description Type Commentaire
PR Attributs de l’objet Objet PRVO
10.5.2. Informations retournées (PRVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet PRVO
10.6. Recherche de DA : searchPR
Cette méthode retourne la liste des Demandes d’achats correpondant aux critères passés en paramètres.
10.6.1. Paramètres d’entrée (PRSearchVO)
Nom Description Type Commentaire
searchBean Attributs de l’objet Objet PRSearchVO
10.6.2. Informations retournées (PRHeaderVO)
Nom Description Type Commentaire
result Attributs de l’objet Objet PRHeaderVO
10.7. Suppression DA : removePR
Cette méthode supprime la DA de l’application si l’état l’autorise.
10.7.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DA Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DA Code renseigné.
10.7.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de la DA supprimée Identifiant
44 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
10.8. Transition permises : findTransitionPR
Cette méthode retourne les transitions pour la DA passé en paramètre.
10.8.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la DA Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la DA Code renseigné.
Filtre des actions pour cet
userCode Identifiant de DA Code
utilisateur.
10.8.2. Informations retournées
Nom Description Type Commentaire
className Nom complet de la classe de transition Texte
id Identifiant de la transition Identifiant
L’identifiant de transition servira en paramètre d’entrée dans la méthode applyTransitionPR.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 45 / 73
Web Services standard
11. COMMANDE : PO
11.1. Objets VO principaux
11.1.1. POSearchVO
Critères de recherche de la commande.
Nom Description Type Commentaire
className Classe de l’objet Texte
account Code comptable Code
budgAcc Budget Code
code Commande Code
contract Contrat Code
createDateMax Date de création maxi Date
createDateMin Date de création mini Date
createdBy Créateur de la commande Code Acteur
deliveryCode Bon de livraison Code
deliveryDateMax Date de livraison maxi Date
deliveryDateMin Date de livraison mini Date
description Description d’une ligne de commande Libellé
editDateMax Date d’édition maxi de la cmde Date
editDateMin Date d’édition mini de la cmde Date
externalOrder Commande externe Code
invoiceDateMax Date maxi de facturation Date
invoiceDateMin Date mini de facturation Date
item Article Code
open Commande ouverte ? Booléen
PRAskedBy Demandeur de la DA Code
PRCode DA Code
packet Colis Code
paymentTerm Type de règlement Code
purchaseType Nature d’achat Code
sendingMode Mode d’envoi Valeur de liste SENDINGMODE
service Service Code
site Site Code
status État de la commande Code Workflow POSTATUS
supplier Fournisseur Code
supplierReference Référence fournisseur Libellé
urgent Urgent ? Booléen
46 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
validateDateMax Date de Validité maxi ? Date
validateDateMin Date de validité mini ? Date
11.1.2. POHeaderVO
Informations principales de la commande.
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
code Code PO code
description Description libellé Identique au code
refoulement Montant HT Numérique
supplierAmountHT Montant total HT dans la devise du fournisseur Numérique
refAmountTTC Montant TTC Numérique
supplierAmountTTC Montant total TTC dans la devise du fournisseur Numérique
budgAcc Budget Objet
contract Contrat Objet
contractPeriod Période de contrat Objet
createDate Date de création Date
createdBy Emetteur de la Commande Objet
deliveryDate Date de livraison Date
exchangeRate Taux de change Numérique
externalOrder Commande externe Code
open Commande ouverte ? Booléen
packet Colis Libellé
paymentMethod Mode de paiement Valeur de liste PAYMENTMETHOD
paymentTerms Type de règlement Objet
sendingMode Mode d’envoi Valeur de liste SENDINGMODE
site Site de l’émetteur Objet
statusCode Code de l’état Code Workflow POSTATUS
supplier Fournisseur Objet
supplierCurrency Devise fournisseur Objet
urgent Commande urgente ? Booléen
11.1.3. POVO
Informations détaillées de la commande.
Cet objet contient tous les attributs de POHeaderVO complétés par les attributs suivants.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 47 / 73
Web Services standard
Nom Description Type Commentaire
deliveryAddress Adresse de livraison Objet POAddressVO
extraCosts Frais annexes Objet extraCostPOLineVO
incoterms International Commercial Terms Valeur de liste INCOTERMS
invoiceAddress Adresse de facturation Objet POAddressVO
orderAdress Adresse de commande Objet POAddressVO
orderContact Coordonnées du l’interlocuteur pour la commande Objet POContactVO
orderLines Ligne de commande Objet POLineVO
shipmentMode Type d’expédition Valeur de liste SHIPMENTMODE
11.2. Changement d’état : applyTransitionPO
Cette méthode permet de modifier l’état d’une commande à l’aide d’une transition.
11.2.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la Commande Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la Commande Code renseigné.
transitionId * Identifiant de la transition Identifiant
commentStatus Commentaire de la transition Libellé long
userCode * Code de l’acteur de la transition Code
Pour connaître les identifiants des transitions autorisées sur une commande donnée, il faut au préalable exécuter le
Web Service findtransitionPO (voir ici un exemple équivalent avec une intervention).
11.2.2. Informations retournées (POVO)
Nom Description Type Commentaire
result Attributs de la classe Objet POVO
11.3. Création Commande : createPO
Cette méthode permet de créer une Commande.
11.3.1. Paramètres d’entrée (POVO)
Nom Description Type Commentaire
PO Attributs de la classe Objet POVO
Responsable du
actorCode * Utilisateur CS Code
changement d’état
11.3.2. Informations retournées (POVO)
Nom Description Type Commentaire
result Attributs de la classe Objet POVO
48 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
11.4. Détail commande : getPODetail
Cette méthode retourne les détails d’une commande en fonction du code ou de l’ID de la commande demandée.
11.4.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la commande Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la Commande Code renseigné.
11.4.2. Informations retournées (POVO)
Nom Description Type Commentaire
result Attributs de la classe Objet POVO
11.5. Mise à jour Commande : updatePO
Cette méthode permet de mettre à jour une commande.
11.5.1. Paramètres d’entrée (POVO)
L’identifiant ou le code doit etre renseigné afin de désigné la commande concernée.
Nom Description Type Commentaire
PO Attributs de la classe Objet POVO
11.5.2. Informations retournées (POVO)
Nom Description Type Commentaire
result Attributs de la classe Objet POVO
11.6. Recherche commande : searchPO
Cette méthode retourne la liste de commandes répondant à un ensemble de critères de filtre passés en paramètre.
11.6.1. Paramètres d’entrée (POSearchVO)
Nom Description Type Commentaire
searchBean Attributs de l’objet Objet POSearchVO
11.6.2. Informations retournées (POHeaderVO)
Les informations retournées sont un résumé des commandes correspondant au filtre de la recherche.
Nom Description Type Commentaire
result Attributs de l’objet Objet POHeaderVO
11.7. Suppression Commande : removePO
Cette méthode assure la suppression d’une commande dont le code ou l’id est passé en paramètre
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 49 / 73
Web Services standard
11.7.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la commande Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la Commande Code renseigné.
11.7.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de la commande supprimée Identifiant
11.8. Transitions permises : findTransitionPO
Cette méthode renvoie les transitions étant acceptées sur la commande donnée à l’acteur près s’il est communiqué.
11.8.1. Paramètres d’entrée
Nom Description Type Commentaire
id * Identifiant de la commande Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la Commande Code renseigné.
userCode Identifiant de l’utilisateur Code
11.8.2. Informations retournées
Nom Description Type Commentaire
className Nom complet de la classe de transition Texte
id Identifiant de la transition Identifiant
L’identifiant de transition servira en paramètre d’entrée dans la méthode applyTransitionPO.
50 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
12. LIGNE DE RÉCEPTION : DELIVERYLINE
12.1. Objet VO principal
12.1.1. DeliveryLineVO
Informations détaillées de la ligne de livraison.
Nom Description Type Commentaire
classname Classe de l’objet Texte
id Identifiant de la ligne Identifiant Ne pas renseigner
deliveryDate Date de livraison Date
litigationComment Commentaire du litige Libellé
litigationQty Quantité en litige Numérique
litigationType Type de litige Valeur de liste LITIGATIONTYPE
netUnitPr Prix unitaire net Numérique
quantity Quantité Numérique
comment Commentaire Libellé
createdByCode * Utilisateur à l’origine de la ligne Code
deliveryCode * Bon de livraison Code
Si non précisé : "true" si
finished Livraison terminée Booléen quantité livrée = reste à
livrer, "false" sinon.
itemCode * Article Code Si article
Si non renseigné, ligne
lineNumber N° LDA ou Ligne de commande Numérique recherchée en fonction de
l’article/service
POCode * Commande Code L’un des deux doit
obligatoirement être
PRCode * DA Code renseigné
serviceCode * Service Code Si service
warehouseCode Magasin Code
A renseigner lorsque
batchNumber Numéro de lot Libellé
l’article est géré par lot.
12.2. Creation ligne de réception : createDeliveryLine
Cette méthode assure la création d’une réception comportant une unique ligne de réception.
12.2.1. Paramètres d’entrée (DeliveryLineVO)
Nom Description Type Commentaire
deliveryLine Attributs de l’objet Objet DeliveryLineVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 51 / 73
Web Services standard
12.2.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de la ligne de livraison Identifiant
52 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
13. LIGNE DE RETOUR : RETURNLINE
13.1. Objet VO principal
13.1.1. returnLineVO
Informations de la ligne de retour.
Nom Description Type Commentaire
classname Classe de l’objet Texte
id * Identifiant Identifiant L’un des deux champs doit
obligatoirement être
code * Code de la ligne Code renseigné.
comment Commentaire Libellé long
createdByCode * Utilisateur a l’origine de la ligne Code
deliveryCode * Livraison Code
itemCode * Article Code Si article
quantity * Quantité Numérique
reason Raison du retour libellé long
returnDate Date de retour Date
serviceCode * Prestation Code Si service
13.2. Creation ligne de retour : createReturnLine
Cette méthode assure la création d’un retour fournisseur comportant une unique ligne.
13.2.1. Paramètres d’entrée (returnLineVO)
Nom Description Type Commentaire
returnLine Attributs de l’objet Objet returnLineVO
13.2.2. Informations retournées
Nom Description Type Commentaire
result Identifiant de la ligne de retour Identifiant
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 53 / 73
Web Services standard
14. MOUVEMENT DE STOCK : STOCKMOVEMENT
14.1. Objets VO Principaux
14.1.1. StockMovementSearchVO
Citères de recherche du mouvement de stock.
Nom Description Type Commentaire
className Classe Texte
actor Acteur ayant créé le mvt Code
batchNum Numéro de lot Texte
box Point de structure Code
costCenter Centre de cout Code
createdBy Créé par Code
dateMaxi Date maximum Date
dateMini Date minimum Date
description Description Texte
family Famille Code
item Article Code
location Emplacement Code
material Matériel imputé Code
materialMoved Matériel mouvementé, si article sérialisé Code
movementType Type de mouvement Code
WO Intervention Code
warehouse Magasin Code
14.1.2. StockMovementVO
Informations détaillées du mouvement de stock.
Nom Description Type Commentaire
className Classe Texte
id Identifiant Identifiant
actionType Nature de l’intervention Objet
actor Acteur ayant créé le mouvement Objet
batchNum Numéro de lot Texte
boxMain Point de structure Objet
code Numéro de bon Texte
comments Commentaire Texte
costCenter Centre de coût d’imputation Objet
costCenter2 Centre de coût d’écart Objet
54 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
externeCost Valorisation externe Numérique
item Article Objet
location Emplacement Objet
material Équipement d’imputation Objet
materialMoved Équipement (mouvementé) lié à l’article Objet
movementDate Date du mouvement Date
movementQuantity Quantité du mouvement Numérique
movementType Type de mouvement Code
PO Commande Objet
PR Demande d’achat Objet
PRLine Ligne de demande d’achat Objet
reserve Sortie sur réservation Booléen
stockCost Valorisation stock Numérique
warehouse Magasin Objet
WO Intervention Objet
14.2. Recherche de mouvements de stock : getMovementStockList
Cette méthode permet de récupérer une liste de mouvements de stock répondant à un ensemble de critères de filtre passés en
paramètre.
14.2.1. Paramètres d’entrée(StockMovementSearchVO)
Nom Description Type Commentaire
Objet
query Attributs de l’objet
StockMovementSearchVO
14.2.2. Informations retournées (StockMovementVO)
Nom Description Type Commentaire
Objet
stockMovements Attributs de l’objet
StockMovementSearchVO
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 55 / 73
Web Services standard
15. WEB SERVICE D’ÉCHANGE DE DONNÉES
Les échanges de données s’effectuent à l’aide du Web service ExchangeGatewayService.
15.1. Principes d’utilisation
• Différentes méthodes d’import et d’export de données sont disponibles : celles-ci seront détaillées plus bas dans ce document.
• Ces méthodes prennent systématiquement en paramètre l’un des « Objets principaux » nécessaires aux échanges de données.
• Les imports/exports de données peuvent s’effectuer de manière synchrone ou asynchrone : les avantages et inconvénients des
différentes approches sont détaillés ci-dessous.
15.2. Modes d’import/export : particularités
Les imports/exports de données peuvent s’effectuer de manière synchrone ou asynchrone : chacun de ces modes peut présenter des
avantages et des inconvénients.
Les tableaux de ce chapitre dressent une synthèse des particularités liées à l’utilisation des différents mécanismes disponibles : ces
informations vous permettront de déterminer le mode d’utilisation le plus approprié à votre contexte.
15.2.1. Export de données – Comparatif des approches
Le tableau ci-dessous dresse la synthèse des particularités liées aux méthodes d’export.
Il convient de distinguer 3 notions – les avantages/inconvénients :
• liés au type d’échange (« Synchrone » ou « Asynchrone »),
• spécifiques à un paramètre (ex : « exItfCode »),
• relatifs à un groupe de paramètres (ex : « exItfCode + extSysCode »).
Mode « Synchrone » Mode « Asynchrone »
Avantages : Avantages :
• Permet de savoir si l’exécution de l’interface • Déclenche l’exécution de l’interface
est terminée et s’il y a eu (ou non) des lorsqu’une ressource backend est disponible
erreurs. (ex : serveur CARL Source principal ou serveur
dédié dans le cas d’un cluster).
Inconvénients :
Inconvénients :
• Le temps de réponse est dépendant du
volume de données. • Ajoute une dépendance sur l’architecture
• L’exécution de l’interface sollicite directement réseau (car passe par un système externe).
le serveur répondant aux appels de Web • Ne permet pas de savoir si l’exécution de
Services. l’interface est terminée et s’il y a eu (ou non)
des erreurs.
Méthode d’export : Méthode « exportSynchrone » Méthode « exportAsynchronous »
Paramètre « exItfCode » Avantages : Avantages :
• Permet d’obtenir directement le contenu de • Effectue l’export sur tous les systèmes
l’export. externes rattachés à l’interface.
• Ne dépend pas d’un système externe (ce qui
simplifie l’échange). Inconvénients :
• Nécessite qu’au moins un système externe
soit rattaché à l’interface.
56 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Mode « Synchrone » Mode « Asynchrone »
Paramètre « extSysCode » [Paramètre non disponible] Avantages :
• Exporte chaque interface rattachée au
système externe.
Groupe de paramètres Avantages : Avantages :
« exItfCode +
extSysCode » • Exporte une seule interface sur le système • Exporte une seule interface sur le système
externe. externe.
• Les données sont exportées sur le système
externe et non dans la communication du WS.
Inconvénients :
• Ajoute une dépendance sur l’architecture
réseau.
15.2.2. Import de données – Comparatif des approches
Le tableau ci-dessous dresse la synthèse des particularités liées aux méthodes d’import.
Il convient de distinguer 3 notions – les avantages/inconvénients :
• liés au type d’échange (« Synchrone » ou « Asynchrone »),
• spécifiques à un paramètre (ex : « exItfCode »),
• relatifs à un groupe de paramètres (ex : « exItfCode + msgData »).
Mode « Synchrone » Mode « Asynchrone »
Avantages : Avantages :
• Permet de savoir si l’exécution de l’interface • Déclenche l’exécution de l’interface
est terminée et s’il y a eu (ou non) des lorsqu’une ressource backend est disponible
erreurs. (ex : serveur CARL Source principal ou serveur
dédié dans le cas d’un cluster).
Inconvénients :
Inconvénients :
• Le temps de réponse est dépendant du
volume de données. • Ajoute une dépendance sur l’architecture
• L’exécution de l’interface sollicite directement réseau (car passe par un système externe).
le serveur répondant aux appels de Web • Ne permet pas de savoir si l’exécution de
Services. l’interface est terminée et s’il y a eu (ou non)
des erreurs.
Méthode d’import Méthode « processSynchrone » Méthode « processAsynchronousImport »
Paramètre « exItfCode » Avantages : Avantages :
• Les données à importer sont présentes sur le • Les données à importer sont présentes sur le
système externe et non dans la système externe et non dans la
communication avec le WS. communication avec le WS.
• Exécute l’import sur tous les systèmes • Exécute l’import sur tous les systèmes
externes rattachés à l’interface. externes rattachés à l’interface.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 57 / 73
Web Services standard
Mode « Synchrone » Mode « Asynchrone »
Paramètre « extSysCode » Avantages : Avantages :
• Les données à importer sont présentes sur le • Les données à importer sont présentes sur le
système externe et non dans la système externe et non dans la
communication avec le WS. communication avec le WS.
• Exécute l’import de toutes les interfaces • Exécute l’import de toutes les interfaces
rattachées au système externe. rattachées au système externe.
Inconvénients :
• Ajoute une dépendance sur l’architecture
réseau.
Groupe de paramètres Avantages : Avantages :
« exItfCode + msgData »
• Les données sont communiquées • Les données sont communiquées
directement. directement.
• Ne dépend pas d’un système externe (ce qui • Ne dépend pas d’un système externe (ce qui
simplifie l’échange). simplifie l’échange).
Inconvénients : Inconvénients :
• Le volume de données est inclus dans la • Le volume de données est inclus dans la
communication avec le WS. communication avec le WS.
15.3. Import de données asynchrone
15.3.1. processAsynchronousImport
Cette méthode exécute un import asynchrone des données via une interface CARL Source et retourne une erreur en cas de problème sur
la méthode du WS.
L’import est ajouté à la pile de traitement à exécuter.
Table 1. Paramètres d’entrée
Nom Description Type Commentaire
processAsynchronousImp processAsynchronousImp
Attributs de l’objet
ort ort
Table 2. Informations retournées
Nom Description Type Commentaire
messageId Identifiant du message JMS interne Identifiant
15.3.2. process
Cette méthode exécute un import asynchrone des données via une interface CARL Source et retourne toujours VRAI (aucune gestion des
erreurs).
Cette méthode est identique à processAsynchronousImport.
Elle a été conservée uniquement pour compatibilité.
Table 3. Paramètres d’entrée
58 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
process Attributs de l’objet Objet process
Table 4. Informations retournées
Nom Description Type Commentaire
status Retour acquitement : VRAI Booléen Toujours à VRAI
15.4. Import de données synchrone
15.4.1. processSynchrone
Cette méthode exécute un import synchrone et ne retourne aucune valeur.
Table 5. Paramètres d’entrée
Nom Description Type Commentaire
processSynchrone Attributs de l’objet Objet processSynchrone
15.5. Export de données synchrone
15.5.1. exportSynchrone
Cette méthode exécute un export synchrone et retourne dans un paramètre la totalité du fichier créé par l’interface (aucune gestion des
erreurs).
Table 6. Paramètres d’entrée
Nom Description Type Commentaire
exportSynchrone Attributs de l’objet Objet exportSynchrone
Table 7. Informations retournées
Nom Description Type Commentaire
listOfMessages Données du fichier généré Chaine de caractère
15.6. Objets principaux
Les objets décrits ci-dessous sont à renseigner puis à fournir aux différentes méthodes d’import/export de données.
15.6.1. Process, processAsynchronousImport, processSynchrone
Ces trois objets sont équivalents et sont exploités par les méthodes d’importation de données.
Nom Description Type Commentaire
extSysCode Code du système externe Code
exItfCode Code de l’interface Code
Chaine de caractères du fichier d’échange à traiter.
msgData (Identique au contenu d’un fichier importé Chaine de caractères
directement depuis CARL Source)
actorCode Code de l’acteur Code
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 59 / 73
Web Services standard
Nom Description Type Commentaire
Syntaxe :
auth Mot de passe en clair ou crypté Texte
- En clair : simple:<auth>
- Crypté : crypt:<auth>
15.6.2. exportSynchrone
Nom Description Type Commentaire
exItfCode Code de l’interface Code
userCode Code de l’utilisateur Code
Syntaxe :
auth Mot de passe en clair ou crypté Texte
- En clair : simple:<auth>
- Crypté : crypt:<auth>
Paramètres supplémentaires conditionnant l’export
evalParameters hashMap
(filtre).
EvalParameters est donc une « map » qui contient un couple « clé – valeur » permettant de filtrer un export :
• La clé correspond à un attribut de l’objet de recherche.
Ex : pour rechercher sur l’attribut WOBegin (date de début d’une intervention) de l’entité WO, on utilisera l’attribut WOBeginStart
de l’entité de recherche WOSel).
• La valeur de cet attribut – celle-ci peut être un numérique, un alphanumérique, un booléen, une date…
Cas d’utilisation – Exemple n°1 – Si l’on souhaite exporter des articles gérés en lot uniquement, on peut écrire dans le code générant
l’appel du Web Service :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://service.backend.exchange.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<ser:exportSynchrone>
<exItfCode>ITEM_OUT</exItfCode>
<userCode>DEMO</userCode>
<evalParameters>
<value key="batch">true</value>
</evalParameters>
</ser:exportSynchrone>
</soapenv:Body>
</soapenv:Envelope>
Cas d’utilisation – Exemple n°2 – Si l’on souhaite exporter les commandes validées après une date donnée :
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ser="http://service.backend.exchange.xnet.carl.com/">
<soapenv:Header/>
<soapenv:Body>
<ser:exportSynchrone>
<exItfCode>PO_OUT</exItfCode>
<userCode>DEMO</userCode>
<evalParameters>
<value key="validateDateMin">2017-01-30</value>
</evalParameters>
</ser:exportSynchrone>
</soapenv:Body>
</soapenv:Envelope>
60 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
16. WEB SERVICES SPÉCIFIQUES
L’utilisation de certains WebServices est réservée à CARL Berger-Levrault :
• CustomObjectsWebServiceImplService est réservé à un usage interne.
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 61 / 73
Web Services standard
17. ANNEXES
17.1. MRWebService
17.1.1. Objet WOVO : Intervention liée
Nom Description Type Commentaire
className Classe Texte
id Identifiant Identifiant
code Intervention Code
Description Libellé Libellé
expWOEnd Date de fin souhaitée Date
statusCode État Code Workflow WOSTATUS
supervisor Responsable Objet
treatComment Commentaire de prise en charge Libellé long
workPriority Priorité de l’intervention Valeur de liste PRIORITYLEVEL
17.1.2. Transitions autorisées pour une DI
Identifiant transition Description État initial DI État demandé Famille de transitions
MR_PREPARE_REQUEST Soumettre la DI PREPARE REQUEST SUBMIT
M1 Accepter la DI REQUEST AWAITINGREAL ACCEPT_MR
M7 Transférer la DI REQUEST REQUEST TRANSFER_MR
M2 Refuser la DI REQUEST DENIED REFUSE_MR
M21 Demander un complément REQUEST WAITINFO WAITINFO_MR
d’information
M22 Soumettre la DI WAITINFO REQUEST SUBMIT
M5 Accepter les travaux FINISHED CLOSED CLOSE
M6 Refuser les travaux FINISHED REQUEST REFUSE_WORKS
M8 Clôturer la demande REQUEST CLOSED CLOSE
17.1.3. MRAddressVO : Adresses de la demande d’intervention
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
address1 Adresse 1 Texte
address2 Adresse 2 Texte
address3 Adresse 3 Texte
city Ville Texte
country Pays Texte
number Numéro Texte
62 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
state Etat Texte
zipCode Code postal Texte
road Voie Code
17.2. WOWebService
17.2.1. Détails des objets complémentaires
17.2.1.1. habilitationVO : Habilitation
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
comment Commentaire de l’Habilitation Texte
habilitation Habilitation Objet
17.2.1.2. MRLinkVO : DIWO
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
code Code Code
description Libellé Libellé
creationDate Date de création Date
material Matériel lié à la DI Objet
statusCode État de la DI Code de l’état Workflow MRSTATUS
symptom Symptôme Objet
17.2.1.3. OccupationVO : Occupation
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
comment Description détaillée Libellé long
duration Temps Numérique
hourType Type d’horaire Objet
labourCost Coût de l’occupation Numérique
occupationDate Date de l’opération Date
technician Intervenant Objet
WOProcess Opération Objet
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 63 / 73
Web Services standard
17.2.1.4. ProcessVO : Opération
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
code Code Code
description Description de l’opération Texte
Box Point de structure Objet
comment Commentaire de l’opération sur l’intervention Texte
createdMR DI créée (opération de contrôle) Objet
createdWO Intervention créée (opération de contrôle) Objet
duration Temps Numérique
evaluation Évaluation Objet
expTime Temps prévu Numérique
hourType Type d’horaire Objet
longDesc Commentaire long Libellé long
mantarory Opération obligatoire ? Booléen
material Matériel Objet
Objet
measureReading Relevé de mesure
woMeasureReadingVO
miscCost Coût Numérique
ordering Ordre Numérique
quantity Quantité Numérique
realisedDate Date de réalisation Date
reserveNumber Numéro de réserve Texte
skill Spécialité Objet
technician Intervenant Objet
typeCost Type de coût Valeur de liste COSTTYPE
unitPrice Prix unitaire Numérique
17.2.1.5. PurchaseElementVO : Ligne d’achat
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
amountHTSupplier Montant HT fournisseur Numérique
askedQty Quantité demandée Numérique
deliveryDate Date de livraison Date
discount Remise, en % Numérique
itemService Article ou Service demandé Objet
64 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
PR Demande d’achat Objet
supplier Fournisseur Objet
supplierReference Référence fournisseur Texte
unit Unité Code
17.2.1.6. ResourceVO : Ressource
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
description Commentaire de la ressource Texte
expTime Temps prévu, en heure Numérique
planningDate Date de planification Date
skill Spécialité Objet
team Equipe Objet
technician Intervenant Objet
17.2.1.7. WORiskVO : Risque
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
risk Risque Objet
preventionList Prévention attachée (1…n) Objet
17.2.1.8. WOStockMovementVO : Mouvement de stock
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
actor Intervenant Objet
comments Commentaire Texte
item Article Objet
location Emplacement Objet
material Matériel Objet
movementDate Date du mouvement Date
movementQuantity Quantité Numérique
warehouse Magasin Objet
17.2.1.9. woLinkVO : Lien Intervention
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 65 / 73
Web Services standard
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
description Description du lien Texte
hierarchical Lien hiérarchique ? Booléen
linkType Nature du lien Code
orderLink Ordre Numérique
statusControlled Héritage d’état ? Booléen
synchro Lien synchronisé ? Booléen
WOLink Intervention liée Objet
WOSource Intervention père Objet
17.2.1.10. woMeasureReadingVO : Relevé WO
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
measure Dernière valeur relevée Numérique
measurePoint Point de mesure Objet
17.2.1.11. ReserveVO : Reservation
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
actor Acteur ayant effectué la réservation. Code
description Commentaire de la réservation Texte
item Article Objet
quantity Quantité restant à sortir Numérique
reserveDate Date de réservation Date
totalQuantity Quantité initialement réservée Numérique
warehouse Magasin Objet
17.2.1.12. toolOccupationVO : Temps d’utilisation d’un moyen matériel
Nom Description Type Commentaire
Cost Coût Numérique
Duration Temps d’utilisation Numérique
hourType Type d’horaire Code
occupationDate Date d’utilisation Date
tool Moyen matériel Code
66 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
WOProcess Opération Code
17.2.1.13. woToolVO : Moyen matériel planifié à une intervention validée
Nom Description Type Commentaire
Description Description Texte
expTime Temps prévu Numérique
expWOTool Moyen matériel prévu Objet expWOToolVO
planningDate Date de plannification Date
skill Code de la spécialité Code
team Code de l’équipe Code
tool Moyen matériel Code
17.2.1.14. expWOToolVO : Moyen matériel prévu sur une intervention
Nom Description Type Commentaire
description Descriptif du moyen Texte
expTime Temps prévu par moyen Numérique
planningDate Date/heure de planification Date
skill Spécialité Code
team Equipe Code
tool Moyen matériel Code
17.2.1.15. WOAddressVO : Adresses de l’intervention
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
address1 Adresse 1 Texte
address2 Adresse 2 Texte
address3 Adresse 3 Texte
city Ville Texte
country Pays Texte
number Numéro Texte
state Etat Texte
zipCode Code postal Texte
road Voie Code
mainAddress Adresse principale Booléen
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 67 / 73
Web Services standard
17.3. LinkWebService
17.3.1. Détail des objets complémentaires
17.3.1.1. equipmentVO : Équipement du lien
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
structure Structure Objet
17.3.1.2. junctionVO : Jonction
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
accessPos Position de l’onglet de la jonction dans l’arborescence Numérique
child Elément fils Objet equipmentVO
datedLink Lien daté ? Booléen
parent Père Objet equipmentVO
qtLinks Lien stock ? Booléen
stockMove Lien quantifié ? Booléen
structure Structure Objet
17.4. PRWebService
17.4.1. Objets complémentaires
17.4.1.1. extraCostPRLineVO : Frais annexe
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
amountHT Montant HT Numérique
amountTTC Montant TTC Numérique
budget Budget Objet
extraCost Frais annexes Objet
tax Taxes Objet taxVO
taxRate Taux Numérique
17.4.1.2. taxVO : Taxe
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
68 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
code Code Code
description Description Libellé
taxRate Taux Numérique
17.4.1.3. PRLineVO : Ligne DA
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
account Code comptable Objet
amountHTSupplier Montant HT dans la devise fournisseur Numérique
amountTTCSupplier Montant TTC dans la devise fournisseur Numérique
amountTaxesSupplier Montant taxes dans la devise fournisseur Numérique
askedQty Quantité demandée Numérique
budgAcc Budget Objet
costCenter Centre de coût Objet
currency Devise Objet
delivered Entièrement réceptionnée ? Booléen
deliveryCtrl Contrôle réception ? Booléen
deliveryDate Date de réception prévue Date
Objet
deliveryLines Ensemble des lignes de réception
DeliveryLineHeaderVO
description Libellé Libellé
discount Remise, en % Numérique
equipment Équipement Objet
exchangeRate Taux de change de la devise Numérique
extraCosts Frais annexes Objet extraCostPRLineVO
grossUnitPr Prix unitaire brut Numérique
initGrossunitPr Prix unitaire brut initial Numérique
item Article Objet
lineNumber Numéro de ligne Numérique
lineType Type d’achat (article ou service) Objet
longDesc Description longue Libellé long
netUnitPr Prix unitaire net Numérique
purchaseType Nature d’achat Objet
rateUnit Coefficient d’achat Numérique
service Prestation Objet
storageQty Quantité de stockage Numérique
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 69 / 73
Web Services standard
Nom Description Type Commentaire
supplier Fournisseur Objet
supplierAmountExtraCosts Montant total HT des frais annexes pour cette ligne
Numérique
HT dans la devise du fournisseur.
supplierAmountExtraCosts Montant total TTC des frais annexes pour cette ligne
Numérique
TTC dans la devise du fournisseur.
supplierReference Référence fournisseur Libellé
tax1 Taxe 1 Numérique
tax1Rate Taxe 1 Objet taxVO
tax2 Taxe 2 Numérique
tax2Rate Taxe 2 Objet taxVO
tax3 Taxe 3 Numérique
tax3Rate Taxe 3 Objet taxVO
unit Unité d’achat Objet
validatedQty Quantité validée Numérique
warehouse Magasin Objet
17.4.1.4. DeliveryLineHeaderVO : Ligne de réception
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
delivery Ligne de réception Objet
deliveryDate Date de réception Date
litigationQty Quantité en litige Numérique
litigationType Type de litige Objet
netUnitPr Prix net Numérique
quantity Quantité réceptionnée Numérique
17.5. POWebService
17.5.1. Objets complémentaires
17.5.1.1. DeliveryLineHeaderVO : Ligne de réception
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
delivery Livraison Objet
deliveryDate Date de livraison Date
litigationQty Quantité en litige Numérique
litigationType Type de litige Valeur de liste LITIGATIONTYPE
70 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
netUnitPr Prix unitaire net Numérique
quantity Quantité Numérique
17.5.1.2. ExtraCostPOLineVO : Frais annexe global
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
amountHT Montant HT Numérique
amountTTC Montant TTC Numérique
budget Budget Objet
extraCost Frais annexes Objet
tax Taxes Objet taxVO
taxRate Taux Numérique
17.5.1.3. taxVO : Taxe
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
code Code Code
description Description Libellé
taxRate Taux Numérique
17.5.1.4. POLineVO : Ligne de commande
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
account Montant Objet
supplierAmountHT Montant HT fournisseur Numérique
supplierAmountTTC Montant TTC fournisseur Numérique
supplierAmountTaxes Montant des taxes Numérique
askedBy Demandeur Objet
budgAcc Budget Objet
costCenter Centre de coût Objet
creditNote Ligne d’avoir Booléen
decimalUnitPurchase Nb de décimales de l’unité d’achat Numérique
delay Délai de livraison Numérique
delivered Entièrement réceptionné ? Booléen
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 71 / 73
Web Services standard
Nom Description Type Commentaire
deliveryCtrl Contrôle réception ? Booléen
deliveryDate Date de livraison Date
Objet
deliveryLines Lignes de livraison
DeliveryLineHeaderVO
description Description Libellé
discount Remise Numérique
editionDate Date d’édition Date
equipment Équipement Objet
extraCosts Frais annexes Objet ExtraCostPOLineVO
grossUnitPr Prix unitaire brut Numérique
initGrossUnitPr Prix unitaire brut initial Numérique
item Article Objet
lineNumber Numéro de ligne Numérique
lineType Type de ligne Objet
longDesc Description Libellé long
netUnitPr Prix unitaire net Numérique
orderedQty Quantité demandée Numérique
origin Origine Code
PR DA Objet
Objet (Classe et
PRLine Ligne DA
identifiant)
purchaseType Nature d’achat Objet
rateUnit Coéf. Achat Numérique
service Prestation Objet
storageQty Quantité de stockage Numérique
supplierAmountExtraCosts
Montant total frais annexes HT pour cette ligne Numérique
HT
supplierAmountExtraCosts
Montant total frais annexes TTC pour cette ligne Numérique
TTC
supplierReference Reference fournisseur Code
tax1 Taxe 1 Objet taxVO
tax1Rate Taux taxe 1 Numérique
tax2 Taxe 2 Objet taxVO
tax2Rate Taux taxe 2 Numérique
tax3 Taxe 3 Objet taxVO
tax3Rate Taux taxe 3 Numérique
unit Unité d’achat Objet
WO Intervention Objet
72 / 73 Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025
Web Services standard
Nom Description Type Commentaire
warehouse Magasin Objet
17.5.1.5. POAddressVO : Adresse
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
address Bloc adresse Objet AddressVO
17.5.1.6. AddressVO : Bloc adresse
Nom Description Type Commentaire
className Classe de l’objet Texte
address1 Ligne 1 Libellé
address2 Ligne 2 Libellé
address3 Ligne 3 Libellé
country Pays Libellé
state État Libellé
zipCode Code postal Numérique
17.5.1.7. POContactVO : Contact
Nom Description Type Commentaire
className Classe de l’objet Texte
id Identifiant Identifiant
contactName Nom Texte
email Mail Texte
faxNum Numéro de fax Texte
mobileNum Portable Texte
phoneNum Fixe Texte
Version du document : 02-10-2025 07:22:27 - © CARL Berger-Levrault 2025 73 / 73
Texte extrait tel quel de la pièce officielle, qui seule fait foi. La mise en page du document d'origine peut différer.