POST api/ShipmentActions/SendMultiShipmentEmail

Request Information

URI Parameters

None.

Body Parameters

ReportShipmentMultiEmailViewModel
NameDescriptionTypeAdditional information
Ids

Collection of integer

None.

Emails

Collection of EmailRecepient

None.

Subject

string

None.

Body

string

None.

Signature

string

None.

IncludeCc

boolean

None.

AccountingCc

boolean

None.

Bol

boolean

None.

OutboundDispatch

boolean

None.

InvoiceReport

boolean

None.

DispatchedContainer

boolean

None.

ShipmentManifest

boolean

None.

Attachments

Collection of integer

None.

AttachmentsBackend

Dictionary of string [key] and string [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "Ids": [
    1,
    2
  ],
  "Emails": [
    {
      "Email": "sample string 1",
      "Name": "sample string 2",
      "Type": "sample string 3"
    },
    {
      "Email": "sample string 1",
      "Name": "sample string 2",
      "Type": "sample string 3"
    }
  ],
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "Signature": "sample string 3",
  "IncludeCc": true,
  "AccountingCc": true,
  "Bol": true,
  "OutboundDispatch": true,
  "InvoiceReport": true,
  "DispatchedContainer": true,
  "ShipmentManifest": true,
  "Attachments": [
    1,
    2
  ],
  "AttachmentsBackend": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:
<ReportShipmentMultiEmailViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eMpowerCore.ViewModels.Emails">
  <AccountingCc>true</AccountingCc>
  <Attachments xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Attachments>
  <AttachmentsBackend xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </AttachmentsBackend>
  <Body>sample string 2</Body>
  <Bol>true</Bol>
  <DispatchedContainer>true</DispatchedContainer>
  <Emails>
    <EmailRecepient>
      <Email>sample string 1</Email>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </EmailRecepient>
    <EmailRecepient>
      <Email>sample string 1</Email>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </EmailRecepient>
  </Emails>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Ids>
  <IncludeCc>true</IncludeCc>
  <InvoiceReport>true</InvoiceReport>
  <OutboundDispatch>true</OutboundDispatch>
  <ShipmentManifest>true</ShipmentManifest>
  <Signature>sample string 3</Signature>
  <Subject>sample string 1</Subject>
</ReportShipmentMultiEmailViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.