PortfolioLinkApi

<back to all web services

SendMailTemplate

The following routes are available for this service:
All Verbs/mail/template
SendMailTemplate Parameters:
NameParameterData TypeRequiredDescription
AppquerystringNo
FromquerystringNo
ToquerystringNo
TemplateAliasquerystringNo
TemplateModelqueryDictionary<string, Object>No
ProposalPdfFriendlyNamequerystringNo
ProposalPdfquerystringNo
ProposalPdfAfrikaansquerystringNo
ProposalPdfFriendlyNameAfrikaansquerystringNo
SendMailTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
MessageformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /mail/template HTTP/1.1 
Host: api.portfoliolink.co.za 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SendMailTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <App>String</App>
  <From>String</From>
  <ProposalPdf>String</ProposalPdf>
  <ProposalPdfAfrikaans>String</ProposalPdfAfrikaans>
  <ProposalPdfFriendlyName>String</ProposalPdfFriendlyName>
  <ProposalPdfFriendlyNameAfrikaans>String</ProposalPdfFriendlyNameAfrikaans>
  <TemplateAlias>String</TemplateAlias>
  <TemplateModel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </TemplateModel>
  <To>String</To>
</SendMailTemplate>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SendMailTemplateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PortfolioLinkApi.ServiceModel">
  <Message>String</Message>
  <Result>false</Result>
</SendMailTemplateResponse>