POST api/v1/EmailQueue/Add

Request Information

URI Parameters

None.

Body Parameters

MessageQueueModel
NameDescriptionTypeAdditional information
Id

string

None.

Sender

string

None.

Recipient

string

None.

CC

string

None.

BCC

string

None.

MessageBody

string

None.

Attachments

Collection of AttachmentInfo

None.

Subject

string

None.

EmailDisplayName

string

None.

CreatedById

string

None.

TemplateKeys

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "Sender": "sample string 2",
  "Recipient": "sample string 3",
  "CC": "sample string 4",
  "BCC": "sample string 5",
  "MessageBody": "sample string 6",
  "Attachments": [
    {
      "Name": "sample string 1",
      "Content": "QEA="
    },
    {
      "Name": "sample string 1",
      "Content": "QEA="
    }
  ],
  "Subject": "sample string 7",
  "EmailDisplayName": "sample string 8",
  "CreatedById": "sample string 9",
  "TemplateKeys": null
}

application/xml, text/xml

Sample:
<MessageQueueModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AllianceSolidAPI.Shared.Models">
  <Attachments xmlns:d2p1="http://schemas.datacontract.org/2004/07/Ezy.Module.DataShared.Entities">
    <d2p1:AttachmentInfo>
      <d2p1:Content>QEA=</d2p1:Content>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:AttachmentInfo>
    <d2p1:AttachmentInfo>
      <d2p1:Content>QEA=</d2p1:Content>
      <d2p1:Name>sample string 1</d2p1:Name>
    </d2p1:AttachmentInfo>
  </Attachments>
  <BCC>sample string 5</BCC>
  <CC>sample string 4</CC>
  <CreatedById>sample string 9</CreatedById>
  <EmailDisplayName>sample string 8</EmailDisplayName>
  <Id>sample string 1</Id>
  <MessageBody>sample string 6</MessageBody>
  <Recipient>sample string 3</Recipient>
  <Sender>sample string 2</Sender>
  <Subject>sample string 7</Subject>
  <TemplateKeys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
</MessageQueueModel>

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 'MessageQueueModel'.

Response Information

Resource Description

EzyResultObjectOfMessageQueueModel
NameDescriptionTypeAdditional information
Data

MessageQueueModel

None.

ExtraData

Dictionary of string [key] and Object [value]

None.

StartTime

decimal number

None.

EndTime

decimal number

None.

TotalMili

decimal number

None.

StatusCode

integer

None.

Msg

string

None.

MsgShowInUI

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": {
    "Id": "sample string 1",
    "Sender": "sample string 2",
    "Recipient": "sample string 3",
    "CC": "sample string 4",
    "BCC": "sample string 5",
    "MessageBody": "sample string 6",
    "Attachments": [
      {
        "Name": "sample string 1",
        "Content": "QEA="
      },
      {
        "Name": "sample string 1",
        "Content": "QEA="
      }
    ],
    "Subject": "sample string 7",
    "EmailDisplayName": "sample string 8",
    "CreatedById": "sample string 9",
    "TemplateKeys": null
  },
  "ExtraData": null,
  "StartTime": 1.1,
  "EndTime": 2.1,
  "TotalMili": 3.1,
  "StatusCode": 4,
  "Msg": "sample string 5",
  "MsgShowInUI": "sample string 6"
}

application/xml, text/xml

Sample:
<EzyResultObjectOfMessageQueueModel3BwjWE5f xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ezy.Module.Library.Message">
  <Msg>sample string 5</Msg>
  <MsgShowInUI>sample string 6</MsgShowInUI>
  <StatusCode>4</StatusCode>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/AllianceSolidAPI.Shared.Models">
    <d2p1:Attachments xmlns:d3p1="http://schemas.datacontract.org/2004/07/Ezy.Module.DataShared.Entities">
      <d3p1:AttachmentInfo>
        <d3p1:Content>QEA=</d3p1:Content>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:AttachmentInfo>
      <d3p1:AttachmentInfo>
        <d3p1:Content>QEA=</d3p1:Content>
        <d3p1:Name>sample string 1</d3p1:Name>
      </d3p1:AttachmentInfo>
    </d2p1:Attachments>
    <d2p1:BCC>sample string 5</d2p1:BCC>
    <d2p1:CC>sample string 4</d2p1:CC>
    <d2p1:CreatedById>sample string 9</d2p1:CreatedById>
    <d2p1:EmailDisplayName>sample string 8</d2p1:EmailDisplayName>
    <d2p1:Id>sample string 1</d2p1:Id>
    <d2p1:MessageBody>sample string 6</d2p1:MessageBody>
    <d2p1:Recipient>sample string 3</d2p1:Recipient>
    <d2p1:Sender>sample string 2</d2p1:Sender>
    <d2p1:Subject>sample string 7</d2p1:Subject>
    <d2p1:TemplateKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  </Data>
  <EndTime>2.1</EndTime>
  <ExtraData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
  <StartTime>1.1</StartTime>
  <TotalMili>3.1</TotalMili>
</EzyResultObjectOfMessageQueueModel3BwjWE5f>