POST api/case/{caseId}/document/file/email

Request Information

URI Parameters

NameDescriptionTypeAdditional information
caseId

string

Required

Body Parameters

EmailModel
NameDescriptionTypeAdditional information
subject

string

None.

to_addresses

Collection of string

None.

cc_addresses

Collection of string

None.

bcc_addresses

Collection of string

None.

body

string

None.

image_ids

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "subject": "sample string 1",
  "to_addresses": [
    "sample string 1",
    "sample string 2"
  ],
  "cc_addresses": [
    "sample string 1",
    "sample string 2"
  ],
  "bcc_addresses": [
    "sample string 1",
    "sample string 2"
  ],
  "body": "sample string 2",
  "image_ids": [
    1,
    2
  ]
}

text/html

Sample:
{"subject":"sample string 1","to_addresses":["sample string 1","sample string 2"],"cc_addresses":["sample string 1","sample string 2"],"bcc_addresses":["sample string 1","sample string 2"],"body":"sample string 2","image_ids":[1,2]}

application/xml, text/xml

Sample:
<EmailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models">
  <bcc_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </bcc_addresses>
  <body>sample string 2</body>
  <cc_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </cc_addresses>
  <image_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </image_ids>
  <subject>sample string 1</subject>
  <to_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </to_addresses>
</EmailModel>

multipart/form-data

Sample:
<EmailModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LSAtlas_WebAPI.Models"><bcc_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></bcc_addresses><body>sample string 2</body><cc_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></cc_addresses><image_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:long>1</d2p1:long><d2p1:long>2</d2p1:long></image_ids><subject>sample string 1</subject><to_addresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></to_addresses></EmailModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml, multipart/form-data

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>