Service de gestion des templates

Contrat WSDL	http://api.emt.dolist.net/V3/TemplateService.svc?wsdl
Ce service est également disponible en SSL, remplacez simplement http par https.

Définition

Le service de gestion des templates vous permet de récupérer et modifier vos templates disponibles en production et en test.
Chaque méthode est indépendante et vous pourrez gérer vos templates comme vous le souhaitez.

Récupération des templates

Nom de la méthode : GetTemplateByID

2 méthodes vous permettent de récupérer l'ensemble des informations de vos templates.
La méthode "GetTemplateByID" vous retournera toutes les informations propres au template en spécifiant son identifiant.
La méthode "GetTemplateList" vous retournera toutes les informations de tous les templates disponibles sur la plateforme DOLIST-EMT.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'ID du template

Les valeurs renvoyées

Type	Description
`GetTemplateResponse`	Un objet GetTemplateResponse qui contient toutes les informations du template

Nom de la méthode : GetTemplateList

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification

Les valeurs renvoyées

Type	Description
`GetTemplateResponse[]`	Un objet GetTemplateResponse qui contient toutes les informations du template

Récupération template en production

Nom de la méthode : GetTemplateContentProduction

Cette méthode vous permet de récupérer le contenu en production de votre template.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'ID du template
templateContentType	`TemplateContentType`	Le type de contenu : valeurs possibles 'Html' ou 'Text'

Les valeurs renvoyées

Type	Description
`string`	Le contenu en production du template

Les valeurs possibles de templateContentType

Html
Text

Récupération template en Test

Nom de la méthode : GetTemplateContentTest

Cette méthode vous permet de récupérer le contenu en test de votre template.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'ID du template
templateContentType	`TemplateContentType`	Le type de contenu : valeurs possibles 'Html' ou 'Text'

Les valeurs renvoyées

Type	Description
`string`	Le contenu en test du template

Les valeurs possibles de templateContentType

Html
Text

Modification template en Test

Nom de la méthode : UpdateTemplateContentTest

Appelez cette méthode dès que vous avez besoin d'effectuer une modification sur votre template en test.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'ID du template
templateContentType	`TemplateContentType`	Le type de contenu : valeurs possibles 'Html' ou 'Text'
content	`string`	Le contenu texte ou html

Les valeurs renvoyées

Type	Description
`boolean`	Vrai si le contenu a bien été mis à jour

Les valeurs possibles de templateContentType

Html
Text

Modification template en production

Nom de la méthode : UpdateTemplateContentTestToProduction

Appelez cette méthode dès que vous avez besoin de mettre à jour le contenu de votre template en production.

Vous devez d'abord mettre à jour le contenu de votre template en Test avant de pouvoir appeler cette méthode.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
templateID	`int`	L'ID du template
templateContentType	`TemplateContentType`	Le type de contenu : valeurs possibles 'Html' ou 'Text'

Les valeurs renvoyées

Type	Description
`boolean`	Vrai si le contenu de test a bien été passé en production

Les valeurs possibles de templateContentType

Html
Text

Validation template HTML

Nom de la méthode : ValidateHtml

En appelant cette méthode, vous pourrez valider, vérifier le contenu HTML de votre template.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
html	`string`	Le flux HTML à analyser

Les valeurs renvoyées

Type	Description
`GetValidateHtmlErrorResponse[]`	La liste des erreurs HTML

Modification entêtes du template

Nom de la méthode : UpdateTemplateHeader

Cette méthode vous permet de modifier l'adresse et le nom d'expéditeur, l'adresse et le nom de réponse, le sujet du message ou le template lui même.

Les paramètres attendus en entrée

Champ	Type	Description
token	`AuthenticationTokenContext`	Le jeton d'authentification
template	`UpdateTemplateRequest`	Les informations du template à mettre à jour

Les valeurs renvoyées

Type	Description
`boolean`	Vrai si les informations du template ont bien été mis à jour

Les objets du service de gestion des templates

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

Champ	Type	Description
Ticket	`string`	Un numéro identifiant l'exception, utilisé pour le suivi de l'erreur
Message	`string`	Le message décrivant l'erreur
Description	`string`	La description détaillée de l'erreur
ErrorCode	`ErrorCodeType`	Code identifiant le type d'erreur (se référrer à la doc pour la liste des codes possibles)

GetTemplateResponse

Champ	Type	Description
FromMail	`string`	Adresse expéditeur
FromName	`string`	Nom de l'expéditeur
ID	`int`	L'identifiant du template
Name	`string`	Le nom du template
ReplyToMail	`string`	Adresse de réponse
ReplyToName	`string`	Nom de réponse
Subject	`string`	Objet/Sujet
XmlDataDormat	`string`	Le format des données variables à utiliser par la méthode SendMessage

GetValidateHtmlErrorResponse

Champ	Type	Description
Column	`int`	Colonne de l'erreur
Description	`string`	Le détail de l'erreur
ErrorType	`ValidateHtmlErrorType`	Le type de problème : Info / Error / Warning
Line	`int`	Ligne de l'erreur

UpdateTemplateRequest

Champ	Type	Description
FromMail	`string`	Partie gauche de l'adresse de l'expéditeur
FromName	`string`	Nom de l'expéditeur
ReplyToMail	`string`	Adresse de réponse
ReplyToName	`string`	Nom de réponse
Subject	`string`	Objet/Sujet
TemplateID	`int`	L'identifiant du template
TemplateName	`string`	Le nom du template

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