GET api/{database}/MailTemplate/ByDocumentType/{type}

Gets the specified MailTemplate.



Request Information

Parameters

NameDescriptionAdditional information
type The type. Accepted values are: Value Description 0 PurchaseOrder 1 Intrastat 2 Mandate 3 Quote 4 ShippingOrder 5 CustomerCollectiveInvoice 6 RegularOrder 7 Reminder 8 PaymentSpecification 9 Docket 10 ServiceOrder 11 CustomerInvoice 12 InvoiceOrder 13 DirectDebitSpecification 14 PackingList 15 WordDocument 16 WordTemplateDocument 17 AccountSpecification 18 DirectInvoice 19 OutgoingMessages 20 IncomingMessages 21 GeneralLedgerMutations 22 AssemblyRequisition 23 SelectionList 24 Undefined 25 WebCustomerInvoice 26 WebReminder

Define this parameter in the request URI.

$expand MailLanguageTemplates

Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "messages": [],
  "bcc": "sample string 1",
  "canChange": true,
  "cannotChangeReason": "sample string 3",
  "cc": "sample string 4",
  "documentType": 0,
  "mailLanguageTemplates": null,
  "mailTemplateId": "de4859f3-3462-46c8-b34d-3ee9d7c5b4d1",
  "name": "sample string 6",
  "to": "sample string 7"
}

application/xml, text/xml

Sample:
<MailTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.CRM.Edit">
  <BCC>sample string 1</BCC>
  <CC>sample string 4</CC>
  <CanChange>true</CanChange>
  <CannotChangeReason>sample string 3</CannotChangeReason>
  <DocumentType>PurchaseOrder</DocumentType>
  <MailLanguageTemplates xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.BL.CRM.Lists" i:nil="true" />
  <MailTemplateId>de4859f3-3462-46c8-b34d-3ee9d7c5b4d1</MailTemplateId>
  <Messages xmlns:d2p1="http://schemas.datacontract.org/2004/07/UNIT4.Multivers.API.Web.WebApi.Core.Models" />
  <Name>sample string 6</Name>
  <To>sample string 7</To>
</MailTemplate>