Aller au contenu

Employés

Les employés correspondent aux collaborateurs rattachés à la société (BU).
Chaque employé est identifié de manière unique par son idEmployee.

Un employé contient notamment :

  • son identifiant (idEmployee)
  • ses informations personnelles
  • sa civilité
  • les enseignes auxquelles il est autorisé

Exemples d’informations disponibles :

  • nom
  • prénom usuel
  • prénoms
  • nationalité
  • civilité
  • liste des enseignes autorisées

Structure d’un employé

Champ Description
idEmployee Identifiant unique de l’employé
personne Informations personnelles de l’employé
personne.nom Nom de l’employé
personne.nomNaissance Nom de naissance
personne.prenomUsuel Prénom usuel
personne.prenoms Ensemble des prénoms
personne.nationalite Nationalité
personne.civilite Civilité de l’employé
personne.civilite.diminutif Civilité abrégée
personne.civilite.libelle Libellé de la civilité
personne.civilite.genre Genre associé à la civilité
enseignes Informations sur les enseignes autorisées
enseignes.allowedEnseignes Liste des enseignes accessibles par l’employé
enseignes.allowedEnseignes[].id Identifiant technique de l’enseigne
enseignes.allowedEnseignes[].code Code unique de l’enseigne
enseignes.allowedEnseignes[].nom Nom de l’enseigne

Pagination

Certains endpoints retournent une liste paginée d’employés.

Structure :

Champ Description
content Liste des employés
totalPages Nombre total de pages
totalElements Nombre total d’employés
pageable.pageNumber Numéro de la page courante
pageable.pageSize Nombre d’éléments par page

Exemple de réponse :

{
  "content": [
    {
      "idEmployee": 870,
      "personne": {
        "nom": "RODRIGUES",
        "nomNaissance": "",
        "prenomUsuel": "Jean-David",
        "prenoms": "Jean-David",
        "nationalite": "Française",
        "civilite": {
          "diminutif": "M.",
          "libelle": "Monsieur",
          "genre": "M"
        }
      },
      "enseignes": {
        "allowedEnseignes": [
          {
            "id": 182,
            "code": "bc8d8d8bb07f45329bf725fcfe01f67a",
            "nom": "MAISON FUNÉRAIRE SOISSONS"
          }
        ]
      }
    }
  ],
  "totalPages": 4,
  "totalElements": 35,
  "pageable": {
    "pageNumber": 0,
    "pageSize": 10
  }
}

Récupération d’un employé par nom

Cet endpoint retourne un seul employé.

Le paramètre transmis dans l’URL conserve le même format que les autres APIs, mais la recherche est effectuée sur le nom de l’employé et non sur un code technique.

Exemple :

GET /v1/employee/RODRIGUES?codeBu=FUN

Réponse :

{
  "idEmployee": 870,
  "personne": {
    "nom": "RODRIGUES",
    "nomNaissance": "",
    "prenomUsuel": "Jean-David",
    "prenoms": "Jean-David",
    "nationalite": "Française",
    "civilite": {
      "diminutif": "M.",
      "libelle": "Monsieur",
      "genre": "M"
    }
  },
  "enseignes": {
    "allowedEnseignes": [
      {
        "id": 182,
        "code": "bc8d8d8bb07f45329bf725fcfe01f67a",
        "nom": "MAISON FUNÉRAIRE SOISSONS"
      }
    ]
  }
}

Liste des endpoints disponibles

GET /v1/employee/all

Retourne la liste paginée de tous les employés.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
page integer oui Numéro de page (commence à 0)

Exemple :

GET /v1/employee/all?codeBu={{codeBu}}&page=0

GET /v1/employee/{nom}

Retourne un employé unique.

Attention : même si la structure d’URL reste identique aux autres APIs, la valeur transmise dans le path correspond ici au nom de l’employé.

Paramètres :

Path :

Paramètre Type Obligatoire Description
nom string oui Nom de l’employé

Query :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)

Exemple :

GET /v1/employee/RODRIGUES?codeBu={{codeBu}}

GET /v1/employee/latest

Retourne la liste paginée des employés créés ou modifiés depuis une date.

Paramètres :

Paramètre Type Obligatoire Description
codeBu string oui Code de la BU (société)
depuis string oui Date de début de synchronisation
page integer oui Numéro de page (commence à 0)

Format de la date :

dd/MM/yyyy HH:mm:ss

Exemple :

GET /v1/employee/latest?codeBu={{codeBu}}&depuis=01/01/2026 00:00:00&page=0

Endpoint non disponible

L’endpoint de récupération des employés supprimés depuis une date n’est pas implémenté pour les employés.

L’endpoint suivant n’est donc pas disponible :

GET /v1/employee/delete/latest