Templates

Resource type: templates

This API call can be used to query the templates for emails, PDF exposés, PDF letters and PDF forms from enterprise. The transmission of the body of a PDF exposé template is currently not available due to technical reasons.

Parameters:

  • type
    STRING. MANDATORY. Template type to be queried (mail, pdf, pdfletter, pdfform).
  • list
    BOOLEAN. Flag, whether a shorter list of all email templates should be returned. This list consists of the ID, the title and the subject. Acts exclusively on email templates.
  • mailtemplateids
    ARRAY. Contains specific template IDs to which further information is to be returned.
  • category
    STRING. Email category of the template. Without the parameter all categories are returned. Only email templates can be filtered via category, no PDF letters and PDF forms. Possible values: Vorlage, Aktivitaeten_Bericht, Interessenten_Nachweis, ExposePDFMitInteressent_Vorlage, appointmentConfirmation, cancelation, adressCompletion, contactShipping.

Example:

...
    {
        "actionid":"urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid":"",
        "identifier":"",
        "resourcetype":"templates",
        "parameters":{
			"type":"pdf"
        }
    }
...

Response (mail):

  • id
    ID of the email template.
  • title
    Title / name of the email template.
  • subject
    Subject of the email template (can be empty).
  • body
    Body of the email template (can be empty). Not returned if parameter "list:true" is set.
  • ishtml
    Flag, if this is an HTML template. Not returned if parameter "list:true" is set.

Response (pdf):

  • identifier
    ID of the PDF exposé template.
  • title
    Title / name of the PDF exposé template.

Response (pdfletter, pdfform):

  • identifier
    ID of the PDF letter or form.
  • title
    Title of the PDF letter or form.