GET v1/Emails/DocsAndImages?entityId={entityId}&entityType={entityType}&excludeFileTypes={excludeFileTypes}&orderBy={orderBy}&sortDirection={sortDirection}

Get a list of Documents and Images (files) to display as available email attachments

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityId

Id of the entity

integer

Required

entityType

Entity Type

string

Required

excludeFileTypes

Exclude file types

string

Required

orderBy

Order By

string

Required

sortDirection

Sort Direction

string

Required

Body Parameters

None.

Response Information

Resource Description

List of Documents and Images (files)

Collection of DocumentImageListItemDTO
NameDescriptionTypeAdditional information
Selected

boolean

None.

BlobInfoId

integer

None.

Title

string

None.

DateAddedFormated

string

None.

Type

string

None.

AddedBy

string

None.

PolicyNumbers

string

None.

DateAdded

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Selected": true,
    "BlobInfoId": 2,
    "Title": "sample string 3",
    "DateAddedFormated": "sample string 4",
    "Type": "sample string 5",
    "AddedBy": "sample string 6",
    "PolicyNumbers": "sample string 7",
    "DateAdded": "2021-02-28T13:10:41.5980491+00:00"
  },
  {
    "Selected": true,
    "BlobInfoId": 2,
    "Title": "sample string 3",
    "DateAddedFormated": "sample string 4",
    "Type": "sample string 5",
    "AddedBy": "sample string 6",
    "PolicyNumbers": "sample string 7",
    "DateAdded": "2021-02-28T13:10:41.5980491+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDocumentImageListItemDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Files">
  <DocumentImageListItemDTO>
    <AddedBy>sample string 6</AddedBy>
    <BlobInfoId>2</BlobInfoId>
    <DateAdded>2021-02-28T13:10:41.5980491+00:00</DateAdded>
    <DateAddedFormated>sample string 4</DateAddedFormated>
    <PolicyNumbers>sample string 7</PolicyNumbers>
    <Selected>true</Selected>
    <Title>sample string 3</Title>
    <Type>sample string 5</Type>
  </DocumentImageListItemDTO>
  <DocumentImageListItemDTO>
    <AddedBy>sample string 6</AddedBy>
    <BlobInfoId>2</BlobInfoId>
    <DateAdded>2021-02-28T13:10:41.5980491+00:00</DateAdded>
    <DateAddedFormated>sample string 4</DateAddedFormated>
    <PolicyNumbers>sample string 7</PolicyNumbers>
    <Selected>true</Selected>
    <Title>sample string 3</Title>
    <Type>sample string 5</Type>
  </DocumentImageListItemDTO>
</ArrayOfDocumentImageListItemDTO>