Lister les templates d’email

GET /api/email/templates

Renvoie une liste des templates d’email connus.

Request Headers:

• Authorization – Les identifiants de l’utilisateur

Parameters:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort ([name+|name-]) – Le paramètre selon lequel les templates seront triés (défaut: name+)

Status Codes:

• 200 OK – La liste a été renvoyée avec succès

• 400 Bad Request – Requête invalide

• 401 Unauthorized – Authentification REST invalide

• 403 Forbidden – L’utilisateur REST n’a pas le droit d’effectuer cette action

Response JSON Object:

• templates (array) – La liste des templates d’email demandés

Response JSON Array of Objects:

• name (string) – Le nom du template.

• subject (string) – Le sujet de l’email.

• mimeType (string) – Le type MIME du corps de l’email.

• body (string) – Le corps de l’email.

• attachments (array) – La liste des fichiers joints au template.

Exemple de requête

GET https://my_waarp_gateway.net/api/email/templates?limit=10&sort=name+ HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 165

{
  "templates": [{
    "name": "transfer-error",
    "subject": "Erreur de transfert",
    "mimeType": "text/plain",
    "body": "Le transfert {{ .Rule }} a échoué.",
    "attachments": []
  }]
}