| Service de gestion des groupes de destinataires |
|
DéfinitionLe service de gestion des groupes de destinataires vous permet de récupérer tous les groupes de destinataires et leurs e-mails définis sur la plateforme DOLIST.
Ces groupes sont une liste d'adresses e-mails destinatrices de compte-rendus d'export et de rapport de statistiques de campagne.
Récupérez-les et paramétrez vos rapports de statistiques de campagne à partir du service "Courriel de synthèse" |
Récupération de la liste des groupes de destinataires Nom de la méthode : GetRecipientGroupList
Méthode permettant de récupérer les groupes de destinataires et leurs e-mails, définis sur la plateforme DOLIST.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
|
AuthenticationTokenContext |
|
| Champ | Type | Description |
|---|
| AccountID | int | Identifiant du client | | Key | string | Clé du jeton d'authentification | | ListID | int | Identifiant du client: obsolète. Utilisez AccountID à la place |
|
GetRecipientGroupListRequest |
|
|
GetRecipientGroupListResult |
|
| Champ | Type | Description |
|---|
| Count | int | Nombre retourné par la requête | | RecipientGroupList | RecipientGroup[]
| Liste des groupes de destinataires |
|
RecipientGroup |
|
| Champ | Type | Description |
|---|
| Id | int | Identifiant du groupe | | Name | string | Nom du groupe | | RecipientList | Recipient[]
| Liste des destinataires | | NbExportInProgress | int | Nombre d'export en cours pour lesquels ce groupe est destinataire | | NbCouponUsed | int | Nombre de coupon pour lesquels ce groupe est destinataire | | NbReportUsed | int | Nombre de courriel de synthèse pour lesquels ce groupe est destinataire |
|
Recipient |
|
| Champ | Type | Description |
|---|
| Id | int | Identifiant du destinataire | | Email | string | E mail du destinataire |
|
ServiceException |
|
| Champ | Type | Description |
|---|
| Ticket | string | Le numéro de ticket | | Message | string | Le message d'erreur | | Description | string | La description de l'erreur | | ErrorCodeType | ErrorCodeType | Type du code de l'erreur | | ErrorCode | int | Code de l'erreur |
|
Liste des erreurs communes |
|
| Code | Nom | Description |
|---|
| 0 | UnexpectedException | Erreur inattendue | | 1 | AuthenticationException | Erreur d'authentification | | 2 | NullTokenException | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 3 | NullRequestException | L'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 4 | ForbiddenActionException | L'action demandée n'est pas autorisée | | 5 | InvalidArgumentException | Les arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité | | 6 | BadRequestException | La requête n'est pas correcte | | 7 | NothingToDoException | La requête demandée n'effectue aucun traitement, car les données soient déjà à jour, il est possible que la requête ai été exécuté plusieurs fois | | 8 | InvalidDataTypeException | Le type de donnée n'est pas valide | | 9 | UnknownTicketException | Le ticket n'est pas connu, vérifiez la valeur de celui-ci | | 10 | UnavailableTicketResultException | Le résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard. | | 11 | InvalidDatePeriodException | L'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête | | 999998 | TokenNull | Le token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées | | 999999 | TokenNotAuthorized | L'objet 'token' n'est pas autorisé, vérifiez les propriétés |
|