Dossiers
Un dossier regroupe l’ensemble des informations métier liées à défunt ou une vente magasin (ex : obsèques, crémation, marbrerie…).
Comme les pièces commerciales, les dossiers sont typés.
Types possibles :
| typeDossier | Description |
|---|---|
| pf | Obsèques |
| marbrerie | Marbrerie |
| contratobseque | Contrat obsèques |
| cremation | Crémation |
| funerarium | Funérarium |
| ventesdiverses | Ventes diverses |
Un dossier est identifié principalement par son numeroDossier (ex : DO160029).
Structure d’un dossier
Champs principaux :
| Champ | Description |
|---|---|
| idDossier | Identifiant technique du dossier |
| numeroDossier | Numéro de dossier |
| typeActivite | Type d’activité rattachée au dossier |
| defunt | Informations du défunt (si applicable) |
| statutDossier | Statut du dossier |
| site | Site de rattachement du dossier |
| employee | Collaborateur / agent en charge |
| serviceDossierList | Liste des services associés au dossier (optionnel) |
Type d’activité
| Champ | Description |
|---|---|
| typeActivite.idTypeActivite | Identifiant du type d’activité |
| typeActivite.libelle | Libellé du type d’activité |
Défunt (si applicable)
L’objet defunt contient des informations d’identité et d’adresses (domicile, naissance, décès) ainsi que la date de naissance.
Champs fréquents :
| Champ | Description |
|---|---|
| defunt.personne | Identité (nom, prénoms, civilité, nationalité…) |
| defunt.domicile | Adresse de domicile |
| defunt.adresseNaissance | Adresse de naissance |
| defunt.adresseDeces | Adresse de décès |
| defunt.dateNaissance | Date de naissance |
Statut dossier
L’objet statutDossier contient des informations du statut du dossier.
Champs fréquents :
| Champ | Description |
|---|---|
| code | Code statut |
| libelle | libellé du statut |
Site
| Champ | Description |
|---|---|
| site.idSite | Identifiant technique du site |
| site.codeSite | Code du site |
| site.nomSite | Nom du site |
Collaborateur
| Champ | Description |
|---|---|
| employee.personne | Identité du collaborateur en charge |
Services associés au dossier
serviceDossierList liste les services réalisés ou prévus dans le cadre du dossier.
| Champ | Description |
|---|---|
| serviceDossierList[].service.codeService | Code du service |
| serviceDossierList[].service.libelle | Libellé du service |
| serviceDossierList[].duree | Durée (en minutes) |
Exemples de services : transport, soins, etc.
Pagination
Les endpoints de liste retournent une structure paginée.
| Champ | Description |
|---|---|
| content | Liste des dossiers |
| totalPages | Nombre total de pages |
| totalElements | Nombre total de dossiers |
| pageable.pageNumber | Numéro de la page |
| pageable.pageSize | Taille de la page |
Liste des endpoints disponibles
Le paramètre typeDossier est une path variable.
GET /v1/dossier/{typeDossier}/all
Retourne la liste paginée des dossiers pour un type donné.
Path variables :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| typeDossier | string | oui | pf, marbrerie, contratobseque, cremation, funerarium, ventesdiverses |
Query parameters :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| codeBu | string | oui | Code de la BU |
| page | integer | oui | Numéro de page (commence à 0) |
Exemple :
GET /v1/dossier/pf/all?codeBu={{ codeBu }}&page=0
GET /v1/dossier/{typeDossier}/{numeroDossier}
Retourne un dossier à partir de son numéro.
Path variables :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| typeDossier | string | oui | pf, marbrerie, contratobseque, cremation, funerarium, ventesdiverses |
| numeroDossier | string | oui | Numéro de dossier (ex : DO160029) |
Query parameters :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| codeBu | string | oui | Code de la BU |
Exemple :
GET /v1/dossier/pf/DO160029?codeBu={{ codeBu }}
GET /v1/dossier/{typeDossier}/latest
Retourne les dossiers créés ou modifiés depuis une date (synchronisation).
Path variables :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| typeDossier | string | oui | pf, marbrerie, contratobseque, cremation, funerarium, ventesdiverses |
Query parameters :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| codeBu | string | oui | Code de la BU |
| depuis | string | oui | Date de synchronisation |
| page | integer | oui | Numéro de page |
Format :
dd/MM/yyyy HH:mm:ss
Exemple :
GET /v1/dossier/pf/latest?codeBu={{ codeBu }}&depuis=01/01/2026 00:00:00&page=0
GET /v1/dossier/{typeDossier}/delete/latest
Retourne les dossiers supprimés depuis une date.
Path variables :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| typeDossier | string | oui | pf, marbrerie, contratobseque, cremation, funerarium, ventesdiverses |
Query parameters :
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| codeBu | string | oui | Code de la BU |
| depuis | string | oui | Date de synchronisation |
| page | integer | oui | Numéro de page |
Format :
dd/MM/yyyy HH:mm:ss
Exemple :
GET /v1/dossier/pf/delete/latest?codeBu={{ codeBu }}&depuis=01/01/2026 00:00:00&page=0
RGPD (exemples)
Dans la documentation, ne pas exposer de données réelles (nom, prénom, email, téléphone, adresse, date de naissance). Remplacer par des valeurs anonymisées :
- noms/prénoms :
NOM/Prénom - email :
contact@example.com - téléphone :
06 00 00 00 00 - adresse :
Adresse masquée - dates :
YYYY-MM-DDou une valeur fictive cohérente