POST api/v1/SearchAllJournals

Request Information

URI Parameters

None.

Body Parameters

SearchAllJournalsParameter
NameDescriptionTypeAdditional information
ReturnCount

integer

None.

SearchSubject

string

None.

SearchContent

string

None.

SearchDateStart

date

None.

SearchDateEnd

date

None.

SearchIncoming

boolean

None.

SearchHasAttactment

boolean

None.

SearchFromAddress

string

None.

SearchToAddress

string

None.

SearchCcAddress

string

None.

MetadataSearchValues

Collection of MetadataSearchValue

None.

FilterPendingType

integer

None.

FilterMyMails

boolean

None.

FilterMySoftDeletedMails

boolean

None.

FilterSystemAllMails

boolean

None.

FilterSystemSoftDeletedMails

boolean

None.

SortDirection

SortDirection

None.

SortExpression

string

None.

IncludeJournalInfo

boolean

None.

SharedUserIDs

Collection of string

None.

ConversationSortDirection

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ReturnCount": 1,
  "SearchSubject": "sample string 2",
  "SearchContent": "sample string 3",
  "SearchDateStart": "2024-12-03T16:42:12.5598929+00:00",
  "SearchDateEnd": "2024-12-03T16:42:12.5598929+00:00",
  "SearchIncoming": true,
  "SearchHasAttactment": true,
  "SearchFromAddress": "sample string 4",
  "SearchToAddress": "sample string 5",
  "SearchCcAddress": "sample string 6",
  "MetadataSearchValues": [
    {
      "MetadataID": 1,
      "MetadataTypeID": 2,
      "SearchValue1": "sample string 3",
      "SearchValue2": "sample string 4"
    },
    {
      "MetadataID": 1,
      "MetadataTypeID": 2,
      "SearchValue1": "sample string 3",
      "SearchValue2": "sample string 4"
    }
  ],
  "FilterPendingType": 7,
  "FilterMyMails": true,
  "FilterMySoftDeletedMails": true,
  "FilterSystemAllMails": true,
  "FilterSystemSoftDeletedMails": true,
  "SortDirection": 0,
  "SortExpression": "sample string 12",
  "IncludeJournalInfo": true,
  "SharedUserIDs": [
    "sample string 1",
    "sample string 2"
  ],
  "ConversationSortDirection": "sample string 14"
}

application/xml, text/xml

Sample:
<SearchAllJournalsParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <ConversationSortDirection>sample string 14</ConversationSortDirection>
  <FilterMyMails>true</FilterMyMails>
  <FilterMySoftDeletedMails>true</FilterMySoftDeletedMails>
  <FilterPendingType>7</FilterPendingType>
  <FilterSystemAllMails>true</FilterSystemAllMails>
  <FilterSystemSoftDeletedMails>true</FilterSystemSoftDeletedMails>
  <IncludeJournalInfo>true</IncludeJournalInfo>
  <MetadataSearchValues>
    <MetadataSearchValue>
      <MetadataID>1</MetadataID>
      <MetadataTypeID>2</MetadataTypeID>
      <SearchValue1>sample string 3</SearchValue1>
      <SearchValue2>sample string 4</SearchValue2>
    </MetadataSearchValue>
    <MetadataSearchValue>
      <MetadataID>1</MetadataID>
      <MetadataTypeID>2</MetadataTypeID>
      <SearchValue1>sample string 3</SearchValue1>
      <SearchValue2>sample string 4</SearchValue2>
    </MetadataSearchValue>
  </MetadataSearchValues>
  <ReturnCount>1</ReturnCount>
  <SearchCcAddress>sample string 6</SearchCcAddress>
  <SearchContent>sample string 3</SearchContent>
  <SearchDateEnd>2024-12-03T16:42:12.5598929+00:00</SearchDateEnd>
  <SearchDateStart>2024-12-03T16:42:12.5598929+00:00</SearchDateStart>
  <SearchFromAddress>sample string 4</SearchFromAddress>
  <SearchHasAttactment>true</SearchHasAttactment>
  <SearchIncoming>true</SearchIncoming>
  <SearchSubject>sample string 2</SearchSubject>
  <SearchToAddress>sample string 5</SearchToAddress>
  <SharedUserIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SharedUserIDs>
  <SortDirection>Ascending</SortDirection>
  <SortExpression>sample string 12</SortExpression>
</SearchAllJournalsParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of EmailInfo
NameDescriptionTypeAdditional information
JournalFolderID

integer

None.

ParentJournalFolderID

integer

None.

ConversationIndex

string

None.

From

string

None.

To

string

None.

CC

string

None.

BCC

string

None.

NormalizedSubject

string

None.

Category

string

None.

EmailBody

string

None.

PendingTypeID

integer

None.

AutoJournalizeAllowed

boolean

None.

JournalInfo

string

None.

JournalizeDate

date

None.

JournalizeComment

string

None.

DeletionDate

date

None.

MetadataInfos

Collection of MetadataInfo

None.

HasAttachment

string

None.

Direction

boolean

None.

OrigDate

date

None.

ReplyTo

string

None.

InReplyTo

string

None.

References

string

None.

Keywords

string

None.

Subject

string

None.

Comments

string

None.

Size

integer

None.

EmailType

integer

None.

ConversationID

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CC": "sample string 3",
    "BCC": "sample string 4",
    "NormalizedSubject": "sample string 5",
    "Category": "sample string 6",
    "EmailBody": "sample string 7",
    "PendingTypeID": 8,
    "AutoJournalizeAllowed": true,
    "JournalInfo": "sample string 10",
    "JournalizeDate": "2024-12-03T16:42:12.7317684+00:00",
    "JournalizeComment": "sample string 11",
    "DeletionDate": "2024-12-03T16:42:12.7317684+00:00",
    "MetadataInfos": [
      {
        "MetadataID": 1,
        "MetadataName": "sample string 2",
        "Type": 10,
        "Value": "sample string 3"
      },
      {
        "MetadataID": 1,
        "MetadataName": "sample string 2",
        "Type": 10,
        "Value": "sample string 3"
      }
    ],
    "HasAttachment": "sample string 12",
    "Direction": true,
    "OrigDate": "2024-12-03T16:42:12.7317684+00:00",
    "ReplyTo": "sample string 15",
    "InReplyTo": "sample string 16",
    "References": "sample string 17",
    "Keywords": "sample string 18",
    "Subject": "sample string 19",
    "Comments": "sample string 20",
    "Size": 21,
    "EmailType": 22,
    "ConversationID": "sample string 23",
    "JournalFolderID": 1,
    "ParentJournalFolderID": 1,
    "ConversationIndex": "sample string 1"
  },
  {
    "From": "sample string 1",
    "To": "sample string 2",
    "CC": "sample string 3",
    "BCC": "sample string 4",
    "NormalizedSubject": "sample string 5",
    "Category": "sample string 6",
    "EmailBody": "sample string 7",
    "PendingTypeID": 8,
    "AutoJournalizeAllowed": true,
    "JournalInfo": "sample string 10",
    "JournalizeDate": "2024-12-03T16:42:12.7317684+00:00",
    "JournalizeComment": "sample string 11",
    "DeletionDate": "2024-12-03T16:42:12.7317684+00:00",
    "MetadataInfos": [
      {
        "MetadataID": 1,
        "MetadataName": "sample string 2",
        "Type": 10,
        "Value": "sample string 3"
      },
      {
        "MetadataID": 1,
        "MetadataName": "sample string 2",
        "Type": 10,
        "Value": "sample string 3"
      }
    ],
    "HasAttachment": "sample string 12",
    "Direction": true,
    "OrigDate": "2024-12-03T16:42:12.7317684+00:00",
    "ReplyTo": "sample string 15",
    "InReplyTo": "sample string 16",
    "References": "sample string 17",
    "Keywords": "sample string 18",
    "Subject": "sample string 19",
    "Comments": "sample string 20",
    "Size": 21,
    "EmailType": 22,
    "ConversationID": "sample string 23",
    "JournalFolderID": 1,
    "ParentJournalFolderID": 1,
    "ConversationIndex": "sample string 1"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEmailInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <EmailInfo>
    <ConversationID>sample string 23</ConversationID>
    <Comments>sample string 20</Comments>
    <Direction>true</Direction>
    <EmailType>22</EmailType>
    <HasAttachment>sample string 12</HasAttachment>
    <InReplyTo>sample string 16</InReplyTo>
    <Keywords>sample string 18</Keywords>
    <OrigDate>2024-12-03T16:42:12.7317684+00:00</OrigDate>
    <References>sample string 17</References>
    <ReplyTo>sample string 15</ReplyTo>
    <Size>21</Size>
    <Subject>sample string 19</Subject>
    <AutoJournalizeAllowed>true</AutoJournalizeAllowed>
    <BCC>sample string 4</BCC>
    <CC>sample string 3</CC>
    <Category>sample string 6</Category>
    <ConversationIndex>sample string 1</ConversationIndex>
    <DeletionDate>2024-12-03T16:42:12.7317684+00:00</DeletionDate>
    <EmailBody>sample string 7</EmailBody>
    <From>sample string 1</From>
    <JournalFolderID>1</JournalFolderID>
    <JournalInfo>sample string 10</JournalInfo>
    <JournalizeComment>sample string 11</JournalizeComment>
    <JournalizeDate>2024-12-03T16:42:12.7317684+00:00</JournalizeDate>
    <MetadataInfos>
      <MetadataInfo>
        <MetadataID>1</MetadataID>
        <MetadataName>sample string 2</MetadataName>
        <Type>ShortText</Type>
        <Value>sample string 3</Value>
      </MetadataInfo>
      <MetadataInfo>
        <MetadataID>1</MetadataID>
        <MetadataName>sample string 2</MetadataName>
        <Type>ShortText</Type>
        <Value>sample string 3</Value>
      </MetadataInfo>
    </MetadataInfos>
    <NormalizedSubject>sample string 5</NormalizedSubject>
    <ParentJournalFolderID>1</ParentJournalFolderID>
    <PendingTypeID>8</PendingTypeID>
    <To>sample string 2</To>
  </EmailInfo>
  <EmailInfo>
    <ConversationID>sample string 23</ConversationID>
    <Comments>sample string 20</Comments>
    <Direction>true</Direction>
    <EmailType>22</EmailType>
    <HasAttachment>sample string 12</HasAttachment>
    <InReplyTo>sample string 16</InReplyTo>
    <Keywords>sample string 18</Keywords>
    <OrigDate>2024-12-03T16:42:12.7317684+00:00</OrigDate>
    <References>sample string 17</References>
    <ReplyTo>sample string 15</ReplyTo>
    <Size>21</Size>
    <Subject>sample string 19</Subject>
    <AutoJournalizeAllowed>true</AutoJournalizeAllowed>
    <BCC>sample string 4</BCC>
    <CC>sample string 3</CC>
    <Category>sample string 6</Category>
    <ConversationIndex>sample string 1</ConversationIndex>
    <DeletionDate>2024-12-03T16:42:12.7317684+00:00</DeletionDate>
    <EmailBody>sample string 7</EmailBody>
    <From>sample string 1</From>
    <JournalFolderID>1</JournalFolderID>
    <JournalInfo>sample string 10</JournalInfo>
    <JournalizeComment>sample string 11</JournalizeComment>
    <JournalizeDate>2024-12-03T16:42:12.7317684+00:00</JournalizeDate>
    <MetadataInfos>
      <MetadataInfo>
        <MetadataID>1</MetadataID>
        <MetadataName>sample string 2</MetadataName>
        <Type>ShortText</Type>
        <Value>sample string 3</Value>
      </MetadataInfo>
      <MetadataInfo>
        <MetadataID>1</MetadataID>
        <MetadataName>sample string 2</MetadataName>
        <Type>ShortText</Type>
        <Value>sample string 3</Value>
      </MetadataInfo>
    </MetadataInfos>
    <NormalizedSubject>sample string 5</NormalizedSubject>
    <ParentJournalFolderID>1</ParentJournalFolderID>
    <PendingTypeID>8</PendingTypeID>
    <To>sample string 2</To>
  </EmailInfo>
</ArrayOfEmailInfo>