Service de gestion des templates
Contrat WSDLhttp://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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateIDintL'ID du template
Les valeurs renvoyées
TypeDescription
GetTemplateResponseUn objet GetTemplateResponse qui contient toutes les informations du template

Nom de la méthode : GetTemplateList

Les paramètres attendus en entrée
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
Les valeurs renvoyées
TypeDescription
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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateIDintL'ID du template
templateContentTypeTemplateContentTypeLe type de contenu : valeurs possibles 'Html' ou 'Text'
Les valeurs renvoyées
TypeDescription
stringLe 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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateIDintL'ID du template
templateContentTypeTemplateContentTypeLe type de contenu : valeurs possibles 'Html' ou 'Text'
Les valeurs renvoyées
TypeDescription
stringLe 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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateIDintL'ID du template
templateContentTypeTemplateContentTypeLe type de contenu : valeurs possibles 'Html' ou 'Text'
contentstringLe contenu texte ou html
Les valeurs renvoyées
TypeDescription
booleanVrai 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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateIDintL'ID du template
templateContentTypeTemplateContentTypeLe type de contenu : valeurs possibles 'Html' ou 'Text'
Les valeurs renvoyées
TypeDescription
booleanVrai 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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
htmlstringLe flux HTML à analyser
Les valeurs renvoyées
TypeDescription
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
ChampTypeDescription
tokenAuthenticationTokenContextLe jeton d'authentification
templateUpdateTemplateRequestLes informations du template à mettre à jour
Les valeurs renvoyées
TypeDescription
booleanVrai si les informations du template ont bien été mis à jour

Les objets du service de gestion des templates

AuthenticationTokenContext

ChampTypeDescription
AccountIDintIdentifiant du client
KeystringClé du jeton d'authentification
ListIDintIdentifiant du client: obsolète. Utilisez AccountID à la place

    ServiceException

    ChampTypeDescription
    TicketstringUn numéro identifiant l'exception, utilisé pour le suivi de l'erreur
    MessagestringLe message décrivant l'erreur
    DescriptionstringLa description détaillée de l'erreur
    ErrorCodeErrorCodeTypeCode identifiant le type d'erreur (se référrer à la doc pour la liste des codes possibles)

      GetTemplateResponse

      ChampTypeDescription
      FromMailstringAdresse expéditeur
      FromNamestringNom de l'expéditeur
      IDintL'identifiant du template
      NamestringLe nom du template
      ReplyToMailstringAdresse de réponse
      ReplyToNamestringNom de réponse
      SubjectstringObjet/Sujet
      XmlDataDormatstringLe format des données variables à utiliser par la méthode SendMessage

        GetValidateHtmlErrorResponse

        ChampTypeDescription
        ColumnintColonne de l'erreur
        DescriptionstringLe détail de l'erreur
        ErrorTypeValidateHtmlErrorTypeLe type de problème : Info / Error / Warning
        LineintLigne de l'erreur

          UpdateTemplateRequest

          ChampTypeDescription
          FromMailstringPartie gauche de l'adresse de l'expéditeur
          FromNamestringNom de l'expéditeur
          ReplyToMailstringAdresse de réponse
          ReplyToNamestringNom de réponse
          SubjectstringObjet/Sujet
          TemplateIDintL'identifiant du template
          TemplateNamestringLe nom du template

            Liste des erreurs communes

            CodeNomDescription
            0UnexpectedExceptionErreur inattendue
            1AuthenticationExceptionErreur d'authentification
            2NullTokenExceptionLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
            3NullRequestExceptionL'objet 'request' est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
            4ForbiddenActionExceptionL'action demandée n'est pas autorisée
            5InvalidArgumentExceptionLes arguments passés à la méthode ne sont pas valides, vérifiez les types des propriétés, leurs noms et leur nullité
            6BadRequestExceptionLa requête n'est pas correcte
            7NothingToDoExceptionLa 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
            8InvalidDataTypeExceptionLe type de donnée n'est pas valide
            9UnknownTicketExceptionLe ticket n'est pas connu, vérifiez la valeur de celui-ci
            10UnavailableTicketResultExceptionLe résultat associé n'est pas disponible, le traitement de la demande n'est pas terminé, veuillez réessayer plus tard.
            11InvalidDatePeriodExceptionL'intervalle de temps n'est pas valide, vérifiez les dates passées à la requête
            999998TokenNullLe token est null, vérifiez que l'objet est correctement passé à la méthode et que les propriétés sont renseignées
            999999TokenNotAuthorizedL'objet 'token' n'est pas autorisé, vérifiez les propriétés