Aller au contenu principal

Employés

Endpoints CRUD pour la gestion des employés (membres). Module requis : MaCarteDeMembre.

Préférez la V2 pour les nouvelles intégrations

Pour les imports en lot ou les intégrations multi-employeurs, utilisez plutôt l'endpoint Synchronisation V2 (POST /b2b/v2/sync) documenté dans ISyncClient. Les endpoints CRUD V1 ci-dessous restent disponibles pour les opérations unitaires et les intégrations existantes.

Liste des employés

GET /b2b/v1/employe

Retourne tous les employés du client.

Réponse

[
{
"idExterne": "EMP-001",
"prenom": "Jean",
"nom": "Dupont",
"noMembre": "M-001",
"courriel": "jean.dupont@example.com",
"identifiantExterneEmployeur": "EMPL-001",
"idUnique": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"derniereMAJ": "2024-01-15T10:30:00Z",
"dateCreation": "2024-01-01T09:00:00Z"
}
]

Exemple

curl -X GET "https://api.macartedemembre.com/b2b/v1/employe" \
-H "X-Api-Key: votre-cle-api"

Obtenir un employé

GET /b2b/v1/employe/{idExterne}

Paramètres

NomEmplacementTypeDescription
idExternePathstringIdentifiant externe de l'employé

Erreurs possibles

CodeHTTPSignification
Employe.NotFound404Aucun employé n'existe avec cet identifiant externe

Exemple

curl -X GET "https://api.macartedemembre.com/b2b/v1/employe/EMP-001" \
-H "X-Api-Key: votre-cle-api"

Créer un employé

POST /b2b/v1/employe

Corps de la requête

{
"idExterne": "EMP-NEW",
"prenom": "Marie",
"nom": "Tremblay",
"noMembre": "M-NEW",
"courriel": "marie.tremblay@example.com",
"identifiantExterneEmployeur": "EMPL-001",
"telephonePrincipal": "514-555-1234",
"ville": "Montréal",
"province": "QC"
}

Erreurs possibles

CodeHTTPSignification
Employe.PrenomRequis400Le prénom est requis
Employe.NomRequis400Le nom est requis
Employe.CourrielRequis400Le courriel est requis
Employe.Existing409Un employé avec cet idExterne, ce courriel ou ce numéro de membre existe déjà
Employe.CourrielExists409Un employé avec ce courriel existe déjà
Employe.EmployeurMustExist404L'identifiantExterneEmployeur ne référence aucun employeur connu

Exemple

curl -X POST "https://api.macartedemembre.com/b2b/v1/employe" \
-H "X-Api-Key: votre-cle-api" \
-H "Content-Type: application/json" \
-d '{
"idExterne": "EMP-NEW",
"prenom": "Marie",
"nom": "Tremblay",
"noMembre": "M-NEW",
"courriel": "marie.tremblay@example.com",
"identifiantExterneEmployeur": "EMPL-001"
}'

Modifier un employé

PUT /b2b/v1/employe

Même structure que POST. L'idExterne identifie l'employé à modifier.

Erreurs possibles

CodeHTTPSignification
Employe.NotFound404Aucun employé n'existe avec cet idExterne
Employe.CourrielExists409Le nouveau courriel est déjà utilisé par un autre employé
Employe.EmployeurMustExist404L'identifiantExterneEmployeur ne référence aucun employeur connu

Supprimer un employé

DELETE /b2b/v1/employe/{idExterne}

Opération destructrice. La suppression peut être bloquée si l'employé a des adhésions actives ou des références dans des votes en cours.

Erreurs possibles

CodeHTTPSignification
Employe.NotFound404Aucun employé n'existe avec cet idExterne

Exemple

curl -X DELETE "https://api.macartedemembre.com/b2b/v1/employe/EMP-001" \
-H "X-Api-Key: votre-cle-api"

Synchronisation (legacy V1)

POST /b2b/v1/employe/sync

Synchronise plusieurs employés en une seule opération (upsert).

Endpoint legacy

Cet endpoint n'est plus exposé par le SDK mais reste accessible en HTTP brut pour la compatibilité ascendante. Migrez vers ISyncClient.Sync (V2), qui prend en charge les syndicats avec employeurs imbriqués et les adhésions imbriquées. Voir Migration vers V2.

Corps de la requête

{
"employes": [
{
"idExterne": "EMP-001",
"prenom": "Jean",
"nom": "Dupont"
}
],
"employeurs": [
{
"idExterne": "EMPL-001",
"nom": "Entreprise ABC"
}
],
"objetsConsentement": []
}

Réponse

{
"created": 5,
"updated": 10,
"errors": [
{
"idExterne": "EMP-BAD",
"message": "Courriel invalide"
}
]
}

Mise à jour groupée des courriels

POST /b2b/v1/employe/UpdateCourriels

Met à jour les adresses courriel de plusieurs employés en lot. Réponse 204 No Content en cas de succès ; les échecs partiels sont retournés dans le tableau errors.


Voir aussi