| Service de gestion des intérêts déclarés |
|
DéfinitionLe service de gestion des intérêts déclarés vous permet de gérer vos centres d'intérêt.
Administrer, par ce service, les groupes d'intérêts déclarés et les intérêts correspondants de votre base.
|
Création d'un groupe d'intérêts avec ses intérêts Nom de la méthode : CreateDeclaredInterestGroup
Méthode permettant de créer un groupe d'intérêts et ses intérêts.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Mise à jour d'un groupe d'intérêtsNom de la méthode : UpdateDeclaredInterestGroupMéthode permettant de mettre à jour le nom, le type d'intérêt (choix unique / multiple) et la visibilité dans la fiche contact de la plateforme d’e-mailing Dolist-V8.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Récupération de tous les groupes d'intérêtsNom de la méthode : GetAllDeclaredInterestGroupsMéthode permettant de récupérer l'ensemble des groupes d'intérêts disponibles sur la plateforme d’e-mailing Dolist-V8.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Récupération d'un groupe d'intérêtsNom de la méthode : GetDeclaredInterestGroupMéthode permettant de récupérer un groupe d'intérêt déclaré précis en fonction de son identifiant.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Création d'un intérêt déclaréNom de la méthode : CreateDeclaredInterestMéthode permettant de créer un intérêt déclaré pour un groupe donné.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Mise à jour d'un intérêt déclaréNom de la méthode : UpdateDeclaredInterestMéthode permettant de mettre à jour le nom, le groupe d'intérêt d'un intérêt déclaré.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
|
|
Récupération d'un intérêt déclaréNom de la méthode : GetDeclaredInterestMéthode permettant de récupérer les détails d'un intérêt déclaré (nom, groupe d'appartenance, nombre de contacts).
|
| Les paramètres attendus en entrée |
| Champ | Type | Description |
|---|
| token | AuthenticationTokenContext | Jeton d'authentification | | declaredInterestID | int | L'identifiant de l'intérêt | | ContactsNumber | boolean | Retourner le nombre de contacts |
|
| Les valeurs renvoyées |
|
|
Suppression d'un groupe d'intérêtsNom de la méthode : DeleteDeclaredInterestGroupMéthode permettant de supprimer un groupe d'intérêts avec l'ensemble de ses intérêts.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | true si la suppression s'est correctement déroulé |
|
|
Suppression d'un intérêt déclaréNom de la méthode : DeleteDeclaredInterestMéthode permettant de supprimer un intérêt déclaré.
|
| Les paramètres attendus en entrée |
|
| Les valeurs renvoyées |
| Type | Description |
|---|
boolean | true si la suppression s'est correctement déroulé |
|
|
Les objets du service de gestion des intérêts déclarés |
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 |
|
ServiceException |
| Exception renvoyée en cas d'erreur à l'appel d'une méthode. |
| Champ | Type | Description |
|---|
| Ticket | string | Le numéro de ticket | | Message | string | Le message d'erreur | | Description | string | La description de l'erreur |
|
DeclaredInterestGroup |
| Objet représentant un groupe d'intérêt avec ses intérêts. |
| Champ | Type | Description |
|---|
| ID | int | L'identifiant | | Name | string | Le nom | | MultipleChoices | boolean | Groupe d'intérêt à choix multiples | | CustomerCard | boolean | L'intérêt est visible dans la fiche contact | | DeclaredInterests | DeclaredInterest[]
| La liste des intérêts | | UserGroupIDList | int[]
| La liste des identifiants des groupes utilisateurs | | ReadOnly | boolean | Indique si le groupe d'interets est en lecture seule |
|
DeclaredInterest |
| Objet représentant un intérêt. |
| Champ | Type | Description |
|---|
| ID | int | L'identifiant | | Name | string | Le nom | | GroupID | int | L'identifiant du groupe | | NumberOfContacts | int | Le nombre de contacts |
|
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 |
|