{"info":{"_postman_id":"aaee5e0a-507e-4cc5-9bb7-107201f70022","name":"BILLJOBS — ÉTATS","description":"<html><head></head><body><h1 id=\"generalites\">Généralités</h1>\n\n<h2>Architecture</h2>\n\n<p>Nos ressources sont regroupées sous le chemin : adresseIP:50432/API/json/v1.<br><br>Pour accéder à nos ressources, l'URL est constituée d'un chemin et d'une requête :</p>\n\n<table><tbody><tr><th>Methode</th><th>Protocole</th><th>Adresse</th><th>Path</th><th>Version</th><th>ressource</th><th>Parametres</th></tr><tr><td><div>GET,POST<br>,PUT,PATCH<br>,DELETE</div><div><div><div><div></div></div></div><div></div></div></td><td><div>http://</div><div><div><div><div></div></div></div><div></div></div></td><td><div>adresseIP:50432</div><div><div><div><div></div></div></div><div></div></div></td><td><div>/API/json/</div><div><div><div><div></div></div></div><div></div></div></td><td><div>V1/</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Connexion/</div><div><div><div><div></div></div></div><div></div></div></td><td><div><p>?Login=ee@e<br>&amp;MdP=Azty</p><p></p><p></p></div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<p><br>Le port d'accès au serveur d'APIs est le 50432.<br>Les autres éléments de la requête sont décrits dans la description de chaque API.<br><br></p>\n\n<h2>Base de données</h2>\n\n<p>Pour l'API de connexion, il est obligatoire d'indiquer le nom de la base de données (fourni par BillJobs).<br>Et, en dehors des APIs de connexion et de déconnexion, il est également obligatoire d'indiquer le nom de l'agence (également fourni par BillJobs).<br>Ces informations sont à indiquer dans les headers.<br>Pour faciliter le développement dans Postman, nos headers comportent les variables «bdd» (pour le nom de la base de données) et «agence» (pour le nom de l'agence) qui doivent donc être définies dans chaque environnement utilisé.</p>\n<h2>Authentification</h2>\n\n<p>Nos APIs sont sécurisées par une clé API et par le token de chaque utilisateur.<br>Dans Postman, la variable «leTokenPerso» y fait référence. Il faut la valoriser après chaque connexion.<br><br>La récupération de ce token est indiquée dans la section «Connexion».<br>Le champ \"Authorization\" dans le \"Headers\" de la requête doit contenir le token retourné par la première connexion (variable Postman «leTokenPerso» ).<br></p>\n\n<h6 id=\"attention-la-durée-de-vie-dun-token-est-limitée-voir-lapi-de-connexion-à-ce-sujet\">Attention, la durée de vie d'un token est limitée (voir l'API de connexion à ce sujet).</h6>\n<p><br>Une fois identifié, chaque utilisateur dispose dans la webapp de son profil défini dans le logiciel BillJobs.<br></p>\n\n<h2>Clé API</h2>\n\n<p>L'accès aux jeux d'APIs est contrôlé par une clé (fournie par BillJobs).<br>Dans Postman, la variable «cleAPI» y fait référence. Elle doit donc être définie dans chaque environnement utilisé.</p>\n\n<h2>Les Headers</h2>\n\n<p>Pour chaque API (sauf les 2 APIs de connexion et de déconnexion), les 3 « headers » suivants doivent obligatoirement être indiqués :<br>— base (nom de l'agence fourni par BillJobs)</p>\n\n<p>— APIKey (clé fournie par BillJobs)</p>\n\n<p>— content-type (toujours égal à «application/json»)<br></p>\n\n<h2>Envoi des données</h2>\n\n<p>Pour les APIs de liste, les filtres (la plupart du temps optionnels) sont passés en paramètre.<br><br>Pour les APIs de création ou de mise à jour de ressource, les données sont contenues dans un JSON passé en \"raw\" dans le \"Body\".<br><br><br></p>\n\n<h2>Code retour</h2>\n\n<p>Toutes nos APIs renvoient du JSON.<br><br></p>\n\n<blockquote><h3>Code Erreur</h3></blockquote>\n\n<p>Les codes d'erreur suivants sont communs à toutes les APIs (sauf celle ce connexion).</p>\n<table><tbody><tr><th>Codes</th><th>statut</th><th>description</th></tr><tr><td><div>ErreurDB</div><div><div><div><div></div></div></div><div></div></div></td><td><div>500</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Erreur de base de données</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTokenAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>404</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Token non transmis</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTokenInconnu</div><div><div><div><div></div></div></div><div></div></div></td><td><div>498</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Token invalide</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTokenTermine</div><div><div><div><div></div></div></div><div></div></div></td><td><div>498</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Token expiré</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrNomBaseVide</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Nom de la base de données non défini</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrNomBaseAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Nom de la base de données non fourni</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrBaseAgenceInconnue</div><div><div><div><div></div></div></div><div></div></div></td><td><div>400</div><div><div><div><div></div></div></div><div></div></div></td><td><div>La base de données indiquée n'existe pas</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAgenceInconnue</div><div><div><div><div></div></div></div><div></div></div></td><td><div>400</div><div><div><div><div></div></div></div><div></div></div></td><td><div>L'agence indiquée n'existe pas dans le carnet d'adresses de la base</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrBaseNonAccessible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Base de données inaccessible</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrApiKeyAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>498</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Clé API vide ou non fournie</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrCleAPIInvalide</div><div><div><div><div></div></div></div><div></div></div></td><td><div>498</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Clé API incorrecte</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTypeDonneeNonConforme</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Le type de donnée n'est pas conforme à ce qui est attendu (string, date, double,integer ou numérique)</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrPeriodeIncorrecte</div><div><div><div><div></div></div></div><div></div></div></td><td><div>400</div><div><div><div><div></div></div></div><div></div></div></td><td><div>La période indiquée est incorrecte</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAccesLectureImpossible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>L'utilisateur n'a pas de droit de lecture de cette resource</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAccesCreationImpossible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>L'utilisateur n'a pas de droit d'écriture sur cette resource</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAccesModificationImpossible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>L'utilisateur n'a pas de droit de modifier cette resource</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAccesSuppressionImpossible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>403</div><div><div><div><div></div></div></div><div></div></div></td><td><div>L'utilisateur n'a pas de droit de supprimer cette resource</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrCommandeInconnue</div><div><div><div><div></div></div></div><div></div></div></td><td><div>404</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Commande inconnue</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<p>En cas d'erreurs, le JSON contient le champ \"Statut\" qui reprend le code HTTP entre 400 et 500.</p>\n<p>En cas de succès, le JSON contient le champ \"Statut\" qui reprend le code HTTP (si sa valeur est égale à 201, cela signifie que la ressource a été créée avec succès et 200 dans les autres cas).</p>\n<p>En cas de création ou de mise à jour, la ressource est entièrement retournée dans le JSON.<br>En cas de suppression, le JSON contient le json \"OK\" ou \"suppressionOK\" avec, comme valeur, true ou l'ID de la ressource supprimée.</p>\n<h2>Type de données</h2>\n\n<p>Les types de valeurs utilisés sont ceux définis dans la syntaxe JSON (string, number, object, array, boolean, null).<br><br>La mention dans cette documentation du type \"NUMERIQUE\" indique que la valeur transmise à nos APIs est soit du type JSON \"string\" (ex:\"1000.00\") soit du type JSON \"number\" (ex: 1000.00) avec dans les deux cas le point comme séparateur de décimales et aucun séparateur de milliers.</p></body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Généralités","slug":"generalites"}],"owner":"6868803","collectionId":"aaee5e0a-507e-4cc5-9bb7-107201f70022","publishedId":"2s9YJjSK4R","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-10-11T15:34:15.000Z"},"item":[{"name":"CONNEXIONS","item":[{"name":"Liste référencés","id":"0e5cdb15-2e6d-4374-aa50-4f15089e7a04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"<p>La base de données de BillJobs</p>\n","key":"base","type":"text","value":"{{agence}}"},{"description":"<p>Le type MIME de la ressource</p>\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Serveur/Liste/","description":"<p>API donnant la liste des personnes déclarées pouvant utiliser BillJobs et, pour chacune d'elles, la liste de agences auxquelles elles ont accès.</p>\n<h4 id=\"codes-erreurs\">Codes Erreurs</h4>\n<p>Cf. en tête de cette documentation.</p>\n<p>Exemple de retour :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"TotalRows\": 18,\n    \"listeReferences\": [\n        {\n            \"prenom\": \"Albert\",\n            \"nom\": \"Dupuis Gronase\",\n            \"email\": \"ald@dp.gr\",\n            \"statut\": \"Intégrale\",\n            \"agences\": [\n                {\n                    \"nom\": \"Test 17\",\n                    \"base\": \"bj_test17\"\n                },\n                {\n                    \"nom\": \"Test FdT\",\n                    \"base\": \"bj_testfdt\"\n                }\n            ]\n        },\n\n</code></pre>\n","urlObject":{"protocol":"http","path":["api","json","v1","Serveur","Liste",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e5cdb15-2e6d-4374-aa50-4f15089e7a04"},{"name":"Déconnexion","id":"07a93f39-c2bb-42f4-8345-e619081c2165","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"<p>Le type MIME de la ressource</p>\n","key":"Content-Type","type":"text","value":"application/json"}],"url":"http://{{url}}/api/json/v1/Deconnexion/","description":"<p>API de déconnexion de l’utilisateur.<br />Il est nécessaire de se déconnecter pour pouvoir ensuite utiliser l’application BillJobs.</p>\n<h4 id=\"codes-erreurs\">Codes Erreurs</h4>\n<p>Cf. en tête de cette documentation.</p>\n","urlObject":{"protocol":"http","path":["api","json","v1","Deconnexion",""],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9f8571f6-f6b1-4e7d-8891-004540276c01","name":"Déconnexion","originalRequest":{"method":"GET","header":[{"key":"base","type":"text","value":"bj_test17"}],"url":"http://127.0.0.1:8080/api/json/v1/Deconnexion/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Fri, 05 Apr 2019 14:00:04 GMT"},{"key":"Content-Length","value":"11"}],"cookie":[],"responseTime":null,"body":"{\n    \"OK\": true\n}"}],"_postman_id":"07a93f39-c2bb-42f4-8345-e619081c2165"},{"name":"Connexion","id":"b9e02c2a-6987-4239-8d80-bae0f9e867c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","description":"<p>Le type MIME de la ressource</p>\n","type":"text"}],"body":{"mode":"file","file":{"src":""}},"url":"http://{{url}}/api/json/v1/Connexion/?Login={{loginPerso}}&MdP={{mdpPerso}}&bdd={{bdd}}","description":"<h5 id=\"api-didentification-permettant-de-vérifier-si-lutilisateur-a-le-droit-de-se-connecter-en-cas-de-succès-elle-retourne-un-token-didentification-à-fournir-lors-de-chaque-appel-dapi-suivant-la-liste-des-agences-billjobs-auxquelles-a-accès-cet-utilisateur-et-la-dernière-agences-accédée\">API d’identification permettant de vérifier si l’utilisateur a le droit de se connecter. En cas de succès, elle retourne un token d'identification à fournir lors de chaque appel d'API suivant, la liste des agences BillJobs auxquelles a accès cet utilisateur et la dernière agences accédée.</h5>\n<p>La durée de vie du token est de 10 minutes après chaque appel d'API.<br />Si aucune API n'est appelée pendant ces 10 minutes, la validité du token est terminée et il faudra se reconnecter avec cette API.</p>\n<h4 id=\"codes-erreurs\">Codes Erreurs</h4>\n<table><tbody><tr><th>Codes</th><th>description</th></tr><tr><td><div>ErrLoginAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Login non défini</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrMdpAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Mot de passe vide ou incorrect</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrPersonneNonReferencee</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Utilisateur non reférencé</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrDepassementQuotaConnexions</div><div><div><div><div></div></div></div><div></div></div></td><td><div>nombre de connexions limité</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrUtilisateurDejaConnecte</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Utilisateur déja connecté</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTokenInconnu</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Le token fourni ne correspond à rien</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrTokenTermine</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Le token fourni n'est lus valable</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAucuneBaseAccessible</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Aucune base accessible</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrAgenceInconnue</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Agence inconnue</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<h4 id=\"exemple-de-réponse-du-serveur-\">Exemple de réponse du serveur :</h4>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"listeAgences\": [\n        {\n            \"nom\": \"Test 17\",\n            \"base\": \"bj_test17\"\n        },\n        {\n            \"nom\": \"Test FdT\",\n            \"base\": \"bj_testfdt\"\n        }\n    ],\n    \"derniereAgence\": {\n        \"nom\": \"Test 17\",\n        \"schema\": \"bj_test17\"\n    },\n    \"token\": \"5ctq149nccxww1c69i26626f-11\",\n    \"nom\": \"Vincent Timetre\"\n}\n\n</code></pre>\n","urlObject":{"protocol":"http","path":["api","json","v1","Connexion",""],"host":["{{url}}"],"query":[{"description":{"content":"<p>(string, obligatoire) Adresse email de la personne référencée de l'agence</p>\n","type":"text/plain"},"key":"Login","value":"{{loginPerso}}"},{"description":{"content":"<p>(string, obligatoire) son mot de passe</p>\n","type":"text/plain"},"key":"MdP","value":"{{mdpPerso}}"},{"description":{"content":"<p>(string, obligatoire) Nom de la base de données (fourni par BillJobs)</p>\n","type":"text/plain"},"key":"bdd","value":"{{bdd}}"}],"variable":[]}},"response":[],"_postman_id":"b9e02c2a-6987-4239-8d80-bae0f9e867c9"}],"id":"fab0ae3c-4454-4ea5-a699-703160407c5d","description":"<p>Cette collection traite les APIs permettant de se connecter vers le serveur BillJobs ou de s'en déconnecter.</p>\n","event":[{"listen":"prerequest","script":{"id":"df572e06-1e2c-4269-ac6b-50ec4a00339b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"9bc60476-76b6-41aa-a126-b9fdebcb9069","type":"text/javascript","exec":[""]}}],"_postman_id":"fab0ae3c-4454-4ea5-a699-703160407c5d"},{"name":"État","item":[{"name":"Liste personnes affectées à un(des) dossiers","id":"e9947ab7-658c-4e7b-810b-cd9fe440c262","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"description":"<p>La base de données de BillJobs</p>\n","key":"base","type":"text","value":"{{agence}}"},{"description":"<p>Le type MIME de la ressource</p>\n","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"<p>Votre clé API transmise par Billjobs</p>\n","key":"APIKey","type":"text","value":"{{CleApi}}"}],"url":"http://{{url}}/api/json/v1/dossiers/ListePersonnesAffectees?id=15","description":"<p>Cette API liste les personnes affectées à un dossier<br />ou aux dossiers d'un classeur ou d'un client</p>\n<p>En cas de succès, un json récapitulant la liste est retourné (voir exemple).</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">{\n    \"Liste\": [\n        {\n            \"prenom\": \"Diane\",\n            \"nom\": \"Chasseresse\",\n            \"sexe\": \"Mme\",\n            \"id\": 9,\n            \"sisupprime\": false,\n            \"typeadrs\": \"Personne\",\n            \"responsable\": true\n        },\n        {\n            \"prenom\": \"Sylvain\",\n            \"nom\": \"Estire\",\n            \"sexe\": \"M\",\n            \"id\": 7,\n            \"sisupprime\": false,\n            \"typeadrs\": \"Personne\",\n            \"responsable\": false\n        }...\n   ]\n}\n\n</code></pre>\n<h4 id=\"codes-erreurs\">Codes Erreurs</h4>\n<table><tbody><tr><th>Codes</th><th>description</th></tr><tr><td><div>ErrIddossierAbsent</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Identifiant (dossier, classeur ou client) absent</div><div><div><div><div></div></div></div><div></div></div></td></tr><tr><td><div>ErrIdDossierInconnu</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Identifiant (dossier, classeur ou client) inconnu</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<p>Autres erreurs : Cf. en tête de cette documentation.</p>\n","urlObject":{"protocol":"http","path":["api","json","v1","dossiers","ListePersonnesAffectees"],"host":["{{url}}"],"query":[{"description":{"content":"<p>(integer, obligatoire) : identifiant de dossier (ou de classeur ou de client)</p>\n","type":"text/plain"},"key":"id","value":"15"},{"disabled":true,"description":{"content":"<p>(String, optionnel avec valeurs possibles : \"\", \"classeur\" ou \"client\") : si absent, le paramètre ID devra être celui d'un dossier</p>\n","type":"text/plain"},"key":"categorie","value":""}],"variable":[]}},"response":[{"id":"08c84377-9539-452d-8015-c536d34e4a99","name":"Liste personnes affectées à un(des) dossiers","originalRequest":{"method":"GET","header":[{"description":"La base de données de BillJobs","key":"base","type":"text","value":"{{agence}}"},{"description":"Le type MIME de la ressource","key":"Content-Type","name":"Content-Type","type":"text","value":"application/json"},{"description":"Votre clé API transmise par Billjobs","key":"APIKey","type":"text","value":"{{CleApi}}"}],"url":{"raw":"http://{{url}}/api/json/v1/dossiers/ListePersonnesAffectees?id=117&categorie=client","protocol":"http","host":["{{url}}"],"path":["api","json","v1","dossiers","ListePersonnesAffectees"],"query":[{"key":"id","value":"117","description":" (integer, obligatoire) : identifiant de dossier (ou de classeur ou de client)"},{"key":"categorie","value":"client","description":"(String, optionnel avec valeurs possibles : \"\", \"classeur\" ou \"client\") : si absent l'ID drevra être celui d'un dossier"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json; charset=UTF-8"},{"key":"Connection","value":"close"},{"key":"Date","value":"Thu, 15 Oct 2020 07:53:55 GMT"},{"key":"Content-Encoding","value":"gzip"},{"key":"Content-Length","value":"682"}],"cookie":[],"responseTime":null,"body":"{\n    \"Liste\": [\n        {\n            \"prenom\": \"Georges\",\n            \"nom\": \"Aten\",\n            \"sexe\": \"M\",\n            \"id\": 4,\n            \"dossiers\": [\n                {\n                    \"id\": 118,\n                    \"numero\": \"62\",\n                    \"titre\": \"PACKAGING BOUTEILLE NOEL\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 125,\n                    \"numero\": \"67\",\n                    \"titre\": \"PLAN MEDIAS 2018\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 236,\n                    \"numero\": \"142\",\n                    \"titre\": \"Brochure marque Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Eva\",\n            \"nom\": \"Delpech\",\n            \"sexe\": \"M\",\n            \"id\": 5,\n            \"dossiers\": [\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Sylvain\",\n            \"nom\": \"Durand\",\n            \"sexe\": \"M\",\n            \"id\": 6,\n            \"dossiers\": [\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 236,\n                    \"numero\": \"142\",\n                    \"titre\": \"Brochure marque Badoit\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Sylvain\",\n            \"nom\": \"Estire\",\n            \"sexe\": \"M\",\n            \"id\": 7,\n            \"dossiers\": [\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 118,\n                    \"numero\": \"62\",\n                    \"titre\": \"PACKAGING BOUTEILLE NOEL\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 125,\n                    \"numero\": \"67\",\n                    \"titre\": \"PLAN MEDIAS 2018\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 236,\n                    \"numero\": \"142\",\n                    \"titre\": \"Brochure marque Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Yvon\",\n            \"nom\": \"Martin\",\n            \"sexe\": \"M\",\n            \"id\": 8,\n            \"dossiers\": [\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Vincent\",\n            \"nom\": \"Mercey\",\n            \"sexe\": \"M\",\n            \"id\": 14,\n            \"dossiers\": [\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Dina\",\n            \"nom\": \"Aharram\",\n            \"sexe\": \"M\",\n            \"id\": 208,\n            \"dossiers\": [\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": true\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": true\n                }\n            ]\n        },\n        {\n            \"nom\": \"Technique\",\n            \"id\": 478,\n            \"typeadrs\": \"Service\",\n            \"dossiers\": [\n                {\n                    \"id\": 118,\n                    \"numero\": \"62\",\n                    \"titre\": \"PACKAGING BOUTEILLE NOEL\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Margaux\",\n            \"nom\": \"Sausse\",\n            \"sexe\": \"M\",\n            \"id\": 508,\n            \"dossiers\": [\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 118,\n                    \"numero\": \"62\",\n                    \"titre\": \"PACKAGING BOUTEILLE NOEL\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 125,\n                    \"numero\": \"67\",\n                    \"titre\": \"PLAN MEDIAS 2018\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 236,\n                    \"numero\": \"142\",\n                    \"titre\": \"Brochure marque Badoit\",\n                    \"responsable\": false\n                }\n            ]\n        },\n        {\n            \"prenom\": \"Eva\",\n            \"nom\": \"Delpech\",\n            \"sexe\": \"M\",\n            \"id\": 548,\n            \"dossiers\": [\n                {\n                    \"id\": 125,\n                    \"numero\": \"67\",\n                    \"titre\": \"PLAN MEDIAS 2018\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 236,\n                    \"numero\": \"142\",\n                    \"titre\": \"Brochure marque Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 194,\n                    \"numero\": \"109\",\n                    \"titre\": \"Eclatement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 237,\n                    \"numero\": \"143\",\n                    \"titre\": \"BNP PARIBAS\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 192,\n                    \"numero\": \"108\",\n                    \"titre\": \"Refonte de site Badoit\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 173,\n                    \"numero\": \"92\",\n                    \"titre\": \"BADOIT - Refonte identité - Compétition\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 312,\n                    \"numero\": \"202\",\n                    \"titre\": \"Pour fractionnement\",\n                    \"responsable\": false\n                },\n                {\n                    \"id\": 118,\n                    \"numero\": \"62\",\n                    \"titre\": \"PACKAGING BOUTEILLE NOEL\",\n                    \"responsable\": false\n                }\n            ]\n        }\n    ]\n}"}],"_postman_id":"e9947ab7-658c-4e7b-810b-cd9fe440c262"},{"name":"CA par clients","id":"4a577bde-bc13-4406-98c1-73847424fa06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{leTokenPerso}}"}]},"isInherited":false},"method":"GET","header":[{"key":"base","value":"{{agence}}","description":"<p>La base de données indiquée par BillJobs</p>\n","type":"text"},{"key":"Content-Type","value":"application/json","description":"<p>Le type MIME de la ressource (toujours \"application/json\")</p>\n","type":"text"},{"key":"APIKey","value":"{{CleApi}}","description":"<p>Votre clé API transmise par Billjobs </p>\n","type":"text"}],"url":"http://{{url}}/api/json/v1/Etats/CAParClient/?$start=2022-01-01&$end=2022-12-31&siAvecBudget=true&siAvecMargeBrute=true&siAvecGroupeActivite=true","description":"<h5 id=\"api-pour-laffichage-des-ca-budgeté-ca-réalisé-marge-brute-budgetée-marge-brute-réalisée-sur-la-période-passée-en-paramètres\">API pour l’affichage des CA budgeté, CA réalisé, Marge brute budgetée, Marge brute réalisée sur la période passée en paramètres.</h5>\n<h5 id=\"attention-cet-état-prend-en-compte-la-totalité-des-dossiers-sans-restriction-liée-à-lutilisateur\">ATTENTION, cet état prend en compte la totalité des dossiers, sans restriction liée à l'utilisateur.</h5>\n<h4 id=\"code-erreur\">Code Erreur</h4>\n<table><tbody><tr><th>Codes</th><th>description</th></tr><tr><td><div>ErrPeriodeIncorrecte</div><div><div><div><div></div></div></div><div></div></div></td><td><div>Si une période est indiquée, alors l'une des dates ou les deux dates sont incorrectes</div><div><div><div><div></div></div></div><div></div></div></td></tr></tbody></table>\n\n<p>Autres erreurs : Cf. en tête de cette documentation.</p>\n<h4 id=\"valeurs-de-retour\">Valeurs de retour</h4>\n<p>Exemple de résultat :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"id\": 158,\n        \"client\": \"- COMPÉTITIONS\",\n        \"carealise\": \"11000.00\",\n        \"cabudget\": \"154152.31\",\n        \"realisemargebrute\": \"11000.00\",\n        \"budgetmargebrute\": \"154152.31\"\n    },\n    {\n        \"id\": 944,\n        \"client\": \"Ah le beau client\",\n        \"carealise\": \"1670.60\",\n        \"cabudget\": \"36584.66\",\n        \"realisemargebrute\": \"1490.60\",\n        \"budgetmargebrute\": \"36369.66\"\n    },\n...\n]\n\n</code></pre>\n<p>ou, si siAvecGroupeActivite est à true :</p>\n<pre class=\"click-to-expand-wrapper is-snippet-wrapper\"><code class=\"language-json\">[\n    {\n        \"id\": 51,\n       \"client\": \"Chogropic\",\n        \"CARealise\": 26780.0,\n        \"CABudget\": 29680.0,\n        \"realiseMargeBrute\": 24680.0,\n        \"budgetMargeBrute\": 26680.0,\n        \"groupesActivite\": [\n            {\n                \"id\": 28,\n                \"nom\": \"Création\",\n                \"CARealise\": 19000.0,\n                \"CABudget\": 21000.0,\n                \"realiseMargeBrute\": 17500.0,\n                \"budgetMargeBrute\": 19000.0\n            },\n            {\n                \"id\": 20,\n                \"nom\": \"Fabrication\",\n                \"CARealise\": 6500.0,\n                \"CABudget\": 7200.0,\n                \"realiseMargeBrute\": 5900.0,\n                \"budgetMargeBrute\": 6200.0\n            },\n       ...\n        ]\n    },\n...\n]\n\n</code></pre>\n","urlObject":{"protocol":"http","path":["api","json","v1","Etats","CAParClient",""],"host":["{{url}}"],"query":[{"description":{"content":"<p>(date, optionnel) : date de début de période</p>\n","type":"text/plain"},"key":"$start","value":"2022-01-01"},{"description":{"content":"<p>(date, optionnel) : date de fin de période</p>\n","type":"text/plain"},"key":"$end","value":"2022-12-31"},{"disabled":true,"description":{"content":"<p>(boolean, optionnel) Inclut/exclut les dossiers archivés. (exclu (false) par défaut)</p>\n","type":"text/plain"},"key":"siAvecArchive","value":"true"},{"disabled":true,"description":{"content":"<p>(integer ,optionnel)  si valorisé : filtre le client ayant cet ID (paramètre prioritaire sur les 4 suivants)</p>\n","type":"text/plain"},"key":"idClient","value":"490"},{"disabled":true,"description":{"content":"<p>(string ,optionnel)  si valorisé : filtre les clients dont le nom commence par la valeur indiquée</p>\n","type":"text/plain"},"key":"$begin","value":"SARL"},{"disabled":true,"description":{"content":"<p>(string ,optionnel)  si valorisé : filtre les clients dont le nom contient la valeur indiquée</p>\n","type":"text/plain"},"key":"$lk","value":"SIROP TYPHON"},{"disabled":true,"description":{"content":"<p>(string ,optionnel)  si valorisé : exclut les clients dont le nom ne contient pas la valeur indiquée</p>\n","type":"text/plain"},"key":"$nlk","value":"BOLDOFLORINE"},{"disabled":true,"description":{"content":"<p>(string ,optionnel)  si valorisé : filtre les clients dont le nom est égal à la valeur indiquée</p>\n","type":"text/plain"},"key":"$eq","value":"LEVITAN"},{"disabled":true,"description":{"content":"<p>(integer ,optionnel)  si valorisé : filtre les dossiers dont le responsable a cet ID (cf API Liste personnes affectées à un(des) dossiers)</p>\n","type":"text/plain"},"key":"idResponsable","value":"470"},{"description":{"content":"<p>(boolean, optionnel) le résultat inclut le CA budgeté</p>\n","type":"text/plain"},"key":"siAvecBudget","value":"true"},{"description":{"content":"<p>(boolean, optionnel) le résultat inclut la marge brute</p>\n","type":"text/plain"},"key":"siAvecMargeBrute","value":"true"},{"disabled":true,"description":{"content":"<p>(boolean, optionnel) le résultat inclut les opérations de mandatement</p>\n","type":"text/plain"},"key":"siAvecMandatement","value":"true"},{"description":{"content":"<p>(boolean, optionnel) le résultat inclut un détail par client et par groupe d’activités</p>\n","type":"text/plain"},"key":"siAvecGroupeActivite","value":"true"}],"variable":[]}},"response":[],"_postman_id":"4a577bde-bc13-4406-98c1-73847424fa06"}],"id":"9ef7cff7-1a16-4dbd-97fb-a10e82aa8c61","_postman_id":"9ef7cff7-1a16-4dbd-97fb-a10e82aa8c61","description":""}]}