ISignatureClient
Client pour récupérer les signatures d'adhésion des employés. Supporte les versions V1 et V2 de l'API.
public interface ISignatureClient : IBaseClient
Méthodes
GetSignaturesDepuis
Récupère toutes les signatures effectuées depuis une date donnée (V1).
Task<ErrorOr<IEnumerable<B2BAdhesionItem>>> GetSignaturesDepuis(DateTime depuis)
Paramètres:
| Nom | Type | Description |
|---|---|---|
depuis | DateTime | Date à partir de laquelle récupérer les signatures |
Retour: Liste des adhésions signées depuis la date spécifiée.
Exemple:
var result = await _signatureClient.GetSignaturesDepuis(DateTime.UtcNow.AddDays(-7));
if (result.IsError)
{
_logger.LogError("Erreur: {Error}", result.FirstError.Description);
return;
}
foreach (var adhesion in result.Value)
{
Console.WriteLine($"{adhesion.Employe.Prenom} {adhesion.Employe.Nom} - {adhesion.DateSignature}");
}
GetSignaturesParIdExterne
Récupère les signatures d'un employé par son identifiant externe (V1).
Task<ErrorOr<IEnumerable<B2BAdhesionItem>>> GetSignaturesParIdExterne(string idExterne)
Paramètres:
| Nom | Type | Description |
|---|---|---|
idExterne | string | Identifiant externe de l'employé |
Exemple:
var result = await _signatureClient.GetSignaturesParIdExterne("EMP-001");
if (result.IsError)
{
_logger.LogError("Erreur: {Error}", result.FirstError.Description);
return;
}
foreach (var adhesion in result.Value)
{
Console.WriteLine($"Adhésion {adhesion.IdUniqueAdhesion} - {adhesion.DateSignature}");
Console.WriteLine($" Manuscrite: {adhesion.ASignatureManuscripte}");
Console.WriteLine($" Syndicat: {adhesion.SyndicatNom}");
}
GetSignaturesV2Depuis
Récupère toutes les signatures depuis une date donnée (V2). La V2 retourne un snapshot des coordonnées de l'employé au moment de la signature au lieu des données courantes.
Task<ErrorOr<IEnumerable<B2BAdhesionItemV2>>> GetSignaturesV2Depuis(DateTime depuis)
Paramètres:
| Nom | Type | Description |
|---|---|---|
depuis | DateTime | Date à partir de laquelle récupérer les signatures |
Retour: Liste des adhésions V2 avec snapshot des coordonnées au moment de la signature.
Préférez les méthodes V2 pour les nouvelles intégrations. Elles retournent les coordonnées telles qu'elles étaient au moment de la signature, plutôt que les données courantes de l'employé.
Exemple:
var result = await _signatureClient.GetSignaturesV2Depuis(DateTime.UtcNow.AddDays(-30));
if (result.IsError)
{
_logger.LogError("Erreur: {Error}", result.FirstError.Description);
return;
}
foreach (var adhesion in result.Value)
{
Console.WriteLine($"{adhesion.EmployePrenom} {adhesion.EmployeNom} - {adhesion.DateSignature}");
Console.WriteLine($" Courriel (au moment de la signature): {adhesion.Courriel}");
Console.WriteLine($" Syndicat: {adhesion.SyndicatNom}");
}
GetSignaturesV2ParIdExterne
Récupère les signatures d'un employé par son identifiant externe (V2).
Task<ErrorOr<IEnumerable<B2BAdhesionItemV2>>> GetSignaturesV2ParIdExterne(string idExterne)
Paramètres:
| Nom | Type | Description |
|---|---|---|
idExterne | string | Identifiant externe de l'employé |
Exemple:
var result = await _signatureClient.GetSignaturesV2ParIdExterne("EMP-001");
if (result.IsError)
{
_logger.LogError("Erreur: {Error}", result.FirstError.Description);
return;
}
foreach (var adhesion in result.Value)
{
Console.WriteLine($"Adhésion {adhesion.IdUniqueAdhesion} - {adhesion.DateSignature}");
Console.WriteLine($" Courriel: {adhesion.Courriel}");
Console.WriteLine($" Téléphone: {adhesion.TelephonePrincipal}");
Console.WriteLine($" Adresse: {adhesion.Adresse1}, {adhesion.Ville} {adhesion.CodePostal}");
foreach (var champ in adhesion.ValeursChampUtilisateur)
{
Console.WriteLine($" {champ.Nom}: {champ.Valeur}");
}
}
Différences V1 vs V2
| Aspect | V1 (B2BAdhesionItem) | V2 (B2BAdhesionItemV2) |
|---|---|---|
| Coordonnées | Données courantes de l'employé | Snapshot au moment de la signature |
| Structure employé | Objet Employe imbriqué | Propriétés à plat (EmployePrenom, EmployeNom, etc.) |
| Champs personnalisés | Non disponibles | ValeursChampUtilisateur inclus |
| Adresse | Via Employe | Directement sur l'adhésion |
Types associés
B2BAdhesionItem- Adhésion V1 avec données employé courantesB2BAdhesionItemV2- Adhésion V2 avec snapshot des coordonnées