POST api/Telecom/SendEmail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Attachments	Collection of FileBaseDTO	None.
From	string	Required
SendTo	string	Required
Subject	string	Required
Body	string	Required
CC	string	None.
BCC	string	None.

Request Formats

text/json, application/json

Sample:

Request sample for mailRequestDTO 

--------------------------------------------------------------------------------------------------------------------------------

{
  "Attachments": [
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Base64Content": "sample string 3"
    },
    {
      "ID": "sample string 1",
      "Name": "sample string 2",
      "Base64Content": "sample string 3"
    }
  ],
  "From": "sample string 1",
  "SendTo": "sample string 2",
  "Subject": "sample string 3",
  "Body": "sample string 4",
  "CC": "sample string 5",
  "BCC": "sample string 6"
}

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:

Request sample for mailRequestDTO 

--------------------------------------------------------------------------------------------------------------------------------

<SendEmailRequestDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs.Telecom" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <Attachments xmlns:a="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.CommonDTOs">
    <a:FileBaseDTO>
      <a:Base64Content>sample string 3</a:Base64Content>
      <a:ID>sample string 1</a:ID>
      <a:Name>sample string 2</a:Name>
    </a:FileBaseDTO>
    <a:FileBaseDTO>
      <a:Base64Content>sample string 3</a:Base64Content>
      <a:ID>sample string 1</a:ID>
      <a:Name>sample string 2</a:Name>
    </a:FileBaseDTO>
  </Attachments>
  <BCC>sample string 6</BCC>
  <Body>sample string 4</Body>
  <CC>sample string 5</CC>
  <From>sample string 1</From>
  <SendTo>sample string 2</SendTo>
  <Subject>sample string 3</Subject>
</SendEmailRequestDTO>

--------------------------------------------------------------------------------------------------------------------------------

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendEmailRequestDTO'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

text/json, application/json

Sample:


--------------------------------------------------------------------------------------------------------------------------------

[
  {
    "SendMailStatus": true,
    "ProcessingStatusList": [
      {
        "StatusCode": "sample string 1",
        "StatusDescription": "sample string 2"
      },
      {
        "StatusCode": "sample string 1",
        "StatusDescription": "sample string 2"
      }
    ]
  },
  {
    "SendMailStatus": true,
    "ProcessingStatusList": [
      {
        "StatusCode": "sample string 1",
        "StatusDescription": "sample string 2"
      },
      {
        "StatusCode": "sample string 1",
        "StatusDescription": "sample string 2"
      }
    ]
  }
]

--------------------------------------------------------------------------------------------------------------------------------

text/xml, application/xml

Sample:


--------------------------------------------------------------------------------------------------------------------------------

<ArrayOfSendEmailResponseDTO xmlns="http://schemas.datacontract.org/2004/07/AHC.WebServices.WebAPI.DTOs.Telecom" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <SendEmailResponseDTO>
    <ProcessingStatusList xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
      <a:ProcessingStatus>
        <a:StatusCode>sample string 1</a:StatusCode>
        <a:StatusDescription>sample string 2</a:StatusDescription>
      </a:ProcessingStatus>
      <a:ProcessingStatus>
        <a:StatusCode>sample string 1</a:StatusCode>
        <a:StatusDescription>sample string 2</a:StatusDescription>
      </a:ProcessingStatus>
    </ProcessingStatusList>
    <SendMailStatus>true</SendMailStatus>
  </SendEmailResponseDTO>
  <SendEmailResponseDTO>
    <ProcessingStatusList xmlns:a="http://schemas.datacontract.org/2004/07/AHC.Core">
      <a:ProcessingStatus>
        <a:StatusCode>sample string 1</a:StatusCode>
        <a:StatusDescription>sample string 2</a:StatusDescription>
      </a:ProcessingStatus>
      <a:ProcessingStatus>
        <a:StatusCode>sample string 1</a:StatusCode>
        <a:StatusDescription>sample string 2</a:StatusDescription>
      </a:ProcessingStatus>
    </ProcessingStatusList>
    <SendMailStatus>true</SendMailStatus>
  </SendEmailResponseDTO>
</ArrayOfSendEmailResponseDTO>

--------------------------------------------------------------------------------------------------------------------------------