Aller au contenu

Dossiers

Récupérer les sites d'une BU

Requête

  • URL : {url_base}/interface-carbone14/client-agence
  • Méthode : GET
  • Authorization : Bearer {access_token}

Paramètres de requête

Paramètre Type Obligatoire Description
codeBu string Oui Code de la Business Unit

Exemple curl

curl -X GET "{url_base}/interface-carbone14/client-agence?codeBu={codeBu}" \
  -H "Authorization: Bearer {access_token}"

Réponse

[
    {
        "idSite": 321,
        "nomSite": "Agence Centre",
        "codeSite": "AGCTR"
    },
    {
        "idSite": 527,
        "nomSite": "Agence Nord",
        "codeSite": "AGNRD"
    }
]

Description des champs

Champ Type Description
idSite integer Identifiant du site
nomSite string Nom du site
codeSite string Code du site

Récupérer la liste des dossiers

Requête

  • URL : {url_base}/interface-carbone14/dossiers
  • Méthode : GET
  • Authorization : Bearer {access_token}

Paramètres de requête

Paramètre Type Obligatoire Description
date string Oui Renvoie tous les dossiers créés ou modifiés depuis cette date (format : yyyy-MM-dd HH:mm:ss:SS)
codeBu string Oui Code de la Business Unit
size integer Non Nombre d'éléments par page (max : 10)
p integer Non Numéro de page (commence à 0)

Exemple curl

curl -X GET "{url_base}/interface-carbone14/dossiers?date=2026-01-30%2008%3A34%3A00%3A00&codeBu={codeBu}&size=10&p=0" \
  -H "Authorization: Bearer {access_token}"

Réponse

{
    "content": [
        {
            "agenceDossier": "Agence de Grenoble",
            "idAgence": 227,
            "civiliteDefunt": "M.",
            "nomDefunt": "DUPONT",
            "prenomDefunt": "Jean",
            "prenomUsuelDefunt": null,
            "communeDeces": "38000",
            "numeroDossier": "DOG220001",
            "codeAssistant": "JMARTIN",
            "nomAssitant": "JEAN MARTIN",
            "prenomAssistant": "",
            "nomDeJeuneFilleDefunt": "DUPONT",
            "lienParentePouvoirDefunt": "",
            "pouvoir": {
                "idPouvoir": 10001,
                "nom": "POMPES FUNEBRES EXEMPLE",
                "prenom": "",
                "civilite": "",
                "email": "contact@exemple.fr",
                "telephone": "04.00.00.00.00",
                "mobile": ""
            },
            "service": [
                {
                    "idService": 606,
                    "libelleService": "Crémation",
                    "debut": "2022-05-20T12:30:00.000+0000",
                    "fin": "2022-05-20T13:48:00.000+0000",
                    "cp": "38000",
                    "commune": "GRENOBLE",
                    "adresse": "10 Rue Exemple 38000 GRENOBLE",
                    "involvedRoom": "",
                    "isServiceConfirmed": null,
                    "codeService": null,
                    "lieu": "Crématorium de Grenoble"
                }
            ],
            "dateDeces": "16/05/2022",
            "dateNaissanceDefunt": "05/08/1932",
            "dateCreation": "2022-05-18 09:21:11",
            "stateChangeDate": "2022-05-19 01:53:29",
            "miniature": null,
            "type": null,
            "avisDeces": null,
            "accordParution": false,
            "adresseDefunt": "10 Rue Exemple 38000 Grenoble"
        }
    ],
    "pageable": {
        "sort": {
            "sorted": false,
            "unsorted": true
        },
        "offset": 0,
        "pageSize": 10,
        "pageNumber": 0,
        "paged": true,
        "unpaged": false
    },
    "totalElements": 1627,
    "totalPages": 163,
    "last": false,
    "size": 10,
    "number": 0,
    "sort": {
        "sorted": false,
        "unsorted": true
    },
    "numberOfElements": 10,
    "first": true
}

Réponse si aucun dossier

Si aucun dossier ne correspond aux critères, l'API retourne un statut 404 NOT_FOUND :

{
    "timestamp": "2026-04-15T10:30:33.109+0000",
    "message": "Aucun dossier à synchroniser sur cette date",
    "details": "uri=/pcborec/interface-carbone14/dossiers",
    "httpStatus": "NOT_FOUND"
}

Récupérer les dossiers par enseigne

Requête

  • URL : {url_base}/interface-carbone14/dossiers/enseigne
  • Méthode : GET
  • Authorization : Bearer {access_token}

Paramètres de requête

Paramètre Type Obligatoire Description
date string Oui Date à partir de laquelle récupérer les dossiers (format : yyyy-MM-dd HH:mm:ss:SS)
codeBu string Oui Code de la Business Unit
codeEnseigne string Oui Code de l'enseigne
size integer Non Nombre d'éléments par page (max : 10)
p integer Non Numéro de page (commence à 0)

Exemple curl

curl -X GET "{url_base}/interface-carbone14/dossiers/enseigne?date=2024-03-05%2010%3A00%3A56%3A00&codeBu={codeBu}&size=10&p=0&codeEnseigne={codeEnseigne}" \
  -H "Authorization: Bearer {access_token}"

La réponse est identique à celle de l'endpoint Récupérer la liste des dossiers.

Récupérer les dossiers par site

Requête

  • URL : {url_base}/interface-carbone14/dossiers/site
  • Méthode : GET
  • Authorization : Bearer {access_token}

Paramètres de requête

Paramètre Type Obligatoire Description
date string Oui Renvoie tous les dossiers créés ou modifiés depuis cette date (format : yyyy-MM-dd HH:mm:ss:SS)
codeBu string Oui Code de la Business Unit
codeSite string Oui Code du site
size integer Non Nombre d'éléments par page (max : 10)
p integer Non Numéro de page (commence à 0)

Exemple curl

curl -X GET "{url_base}/interface-carbone14/dossiers/site?date=2024-03-05%2010%3A00%3A56%3A00&codeBu={codeBu}&size=10&p=0&codeSite={codeSite}" \
  -H "Authorization: Bearer {access_token}"

La réponse est identique à celle de l'endpoint Récupérer la liste des dossiers.

Description des champs

Description des champs du dossier

Champ Type Description
agenceDossier string Nom de l'agence associée au dossier
idAgence integer Identifiant de l'agence
civiliteDefunt string Civilité du défunt (M., Mme, etc.)
nomDefunt string Nom de famille du défunt
prenomDefunt string Prénom(s) du défunt
prenomUsuelDefunt string Prénom usuel du défunt
communeDeces string Code postal de la commune de décès
numeroDossier string Numéro unique du dossier
codeAssistant string Code du collaborateur en charge du dossier
nomAssitant string Nom complet du collaborateur
prenomAssistant string Prénom du collaborateur
nomDeJeuneFilleDefunt string Nom de jeune fille du défunt
lienParentePouvoirDefunt string Lien de parenté entre le pouvoir et le défunt
pouvoir object Informations sur le donneur d'ordre (voir ci-dessous)
service array Liste des services associés au dossier (voir ci-dessous)
dateDeces string Date de décès (format : dd/MM/yyyy)
dateNaissanceDefunt string Date de naissance du défunt (format : dd/MM/yyyy)
dateCreation string Date de création du dossier (format : yyyy-MM-dd HH:mm:ss)
stateChangeDate string Date du dernier changement d'état du dossier
miniature string Miniature associée au dossier
type string Type de dossier
avisDeces string Avis de décès
accordParution boolean Accord de parution de l'avis de décès
adresseDefunt string Adresse du défunt

Objet pouvoir (donneur d'ordre)

Champ Type Description
idPouvoir integer Identifiant du pouvoir
nom string Nom ou raison sociale
prenom string Prénom
civilite string Civilité
email string Adresse email
telephone string Numéro de téléphone
mobile string Numéro de mobile

Objet service

Champ Type Description
idService integer Identifiant du service
libelleService string Libellé du service
debut string Date et heure de début (format ISO 8601)
fin string Date et heure de fin (format ISO 8601)
cp string Code postal du lieu du service
commune string Commune du lieu du service
adresse string Adresse complète du lieu du service
involvedRoom string Salle utilisée
isServiceConfirmed boolean Indique si le service est confirmé
codeService string Code du service
lieu string Nom du lieu du service

Pagination

La réponse est paginée. Les informations de pagination se trouvent dans l'objet pageable et les champs suivants :

Champ Type Description
totalElements integer Nombre total de dossiers
totalPages integer Nombre total de pages
size integer Nombre d'éléments par page
number integer Numéro de la page courante (commence à 0)
first boolean true si c'est la première page
last boolean true si c'est la dernière page
numberOfElements integer Nombre d'éléments dans la page courante