POST api/v1/SearchJournalItems
Request Information
URI Parameters
None.
Body Parameters
SearchJournalItemsParameterName | Description | Type | Additional information |
---|---|---|---|
JournalID | string |
None. |
|
JournalFolderID | integer |
None. |
|
ViewID | integer |
None. |
|
GetMailsAcrossFolders | boolean |
None. |
|
AdvancedSearch | boolean |
None. |
|
SearchCriteria | SearchCriteria |
None. |
|
FilterPendingType | integer |
None. |
|
FilterMyMails | boolean |
None. |
|
PageStart | integer |
None. |
|
PageSize | integer |
None. |
|
SortDirection | SortDirection |
None. |
|
SortExpression | string |
None. |
|
IncludeJournalInfo | boolean |
None. |
|
ConversationSortDirection | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "JournalID": "sample string 1", "JournalFolderID": 1, "ViewID": 1, "GetMailsAcrossFolders": true, "AdvancedSearch": true, "SearchCriteria": { "SearchSubject": "sample string 1", "SearchDateStart": "2024-09-08T02:45:13.6818883+00:00", "SearchDateEnd": "2024-09-08T02:45:13.6818883+00:00", "SearchIncoming": true, "SearchHasAttactment": true, "SearchFromAddress": "sample string 2", "SearchToAddress": "sample string 3", "SearchCcAddress": "sample string 4", "SearchContent": "sample string 5" }, "FilterPendingType": 3, "FilterMyMails": true, "PageStart": 1, "PageSize": 1, "SortDirection": 0, "SortExpression": "sample string 5", "IncludeJournalInfo": true, "ConversationSortDirection": "sample string 7" }
application/xml, text/xml
Sample:
<SearchJournalItemsParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model"> <AdvancedSearch>true</AdvancedSearch> <ConversationSortDirection>sample string 7</ConversationSortDirection> <FilterMyMails>true</FilterMyMails> <FilterPendingType>3</FilterPendingType> <GetMailsAcrossFolders>true</GetMailsAcrossFolders> <IncludeJournalInfo>true</IncludeJournalInfo> <JournalFolderID>1</JournalFolderID> <JournalID>sample string 1</JournalID> <PageSize>1</PageSize> <PageStart>1</PageStart> <SearchCriteria> <SearchCcAddress>sample string 4</SearchCcAddress> <SearchContent>sample string 5</SearchContent> <SearchDateEnd>2024-09-08T02:45:13.6818883+00:00</SearchDateEnd> <SearchDateStart>2024-09-08T02:45:13.6818883+00:00</SearchDateStart> <SearchFromAddress>sample string 2</SearchFromAddress> <SearchHasAttactment>true</SearchHasAttactment> <SearchIncoming>true</SearchIncoming> <SearchSubject>sample string 1</SearchSubject> <SearchToAddress>sample string 3</SearchToAddress> </SearchCriteria> <SortDirection>Ascending</SortDirection> <SortExpression>sample string 5</SortExpression> <ViewID>1</ViewID> </SearchJournalItemsParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResponseOfEmailInfo[]Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of EmailInfo |
None. |
|
Error | ServiceError |
None. |
|
IsError | boolean |
None. |
|
Warning | string |
None. |
|
Misc1 | Object |
None. |
|
Misc2 | Object |
None. |
|
Misc3 | Object |
None. |
|
Exception | Exception |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "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-09-08T02:45:13.7131609+00:00", "JournalizeComment": "sample string 11", "DeletionDate": "2024-09-08T02:45:13.7131609+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-09-08T02:45:13.7131609+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-09-08T02:45:13.7131609+00:00", "JournalizeComment": "sample string 11", "DeletionDate": "2024-09-08T02:45:13.7131609+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-09-08T02:45:13.7131609+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" } ], "Error": { "Message": "sample string 1", "ErrorNumber": 2, "AddtionalInfo": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "TimeStamp": "2024-09-08T02:45:13.7131609+00:00" }, "IsError": true, "Warning": "sample string 2", "Misc1": {}, "Misc2": {}, "Misc3": {}, "Exception": { "ClassName": "System.Exception", "Message": null, "Data": null, "InnerException": null, "HelpURL": "sample string 1", "StackTraceString": null, "RemoteStackTraceString": null, "RemoteStackIndex": 0, "ExceptionMethod": null, "HResult": 3, "Source": "sample string 2", "WatsonBuckets": null } }
application/xml, text/xml
Sample:
<ServiceResponseOfArrayOfEmailInfoVR9rHvAV xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.workpointemm.dk/API"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model"> <d2p1:EmailInfo> <d2p1:ConversationID>sample string 23</d2p1:ConversationID> <d2p1:Comments>sample string 20</d2p1:Comments> <d2p1:Direction>true</d2p1:Direction> <d2p1:EmailType>22</d2p1:EmailType> <d2p1:HasAttachment>sample string 12</d2p1:HasAttachment> <d2p1:InReplyTo>sample string 16</d2p1:InReplyTo> <d2p1:Keywords>sample string 18</d2p1:Keywords> <d2p1:OrigDate>2024-09-08T02:45:13.7131609+00:00</d2p1:OrigDate> <d2p1:References>sample string 17</d2p1:References> <d2p1:ReplyTo>sample string 15</d2p1:ReplyTo> <d2p1:Size>21</d2p1:Size> <d2p1:Subject>sample string 19</d2p1:Subject> <d2p1:AutoJournalizeAllowed>true</d2p1:AutoJournalizeAllowed> <d2p1:BCC>sample string 4</d2p1:BCC> <d2p1:CC>sample string 3</d2p1:CC> <d2p1:Category>sample string 6</d2p1:Category> <d2p1:ConversationIndex>sample string 1</d2p1:ConversationIndex> <d2p1:DeletionDate>2024-09-08T02:45:13.7131609+00:00</d2p1:DeletionDate> <d2p1:EmailBody>sample string 7</d2p1:EmailBody> <d2p1:From>sample string 1</d2p1:From> <d2p1:JournalFolderID>1</d2p1:JournalFolderID> <d2p1:JournalInfo>sample string 10</d2p1:JournalInfo> <d2p1:JournalizeComment>sample string 11</d2p1:JournalizeComment> <d2p1:JournalizeDate>2024-09-08T02:45:13.7131609+00:00</d2p1:JournalizeDate> <d2p1:MetadataInfos> <d2p1:MetadataInfo> <d2p1:MetadataID>1</d2p1:MetadataID> <d2p1:MetadataName>sample string 2</d2p1:MetadataName> <d2p1:Type>ShortText</d2p1:Type> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:MetadataInfo> <d2p1:MetadataInfo> <d2p1:MetadataID>1</d2p1:MetadataID> <d2p1:MetadataName>sample string 2</d2p1:MetadataName> <d2p1:Type>ShortText</d2p1:Type> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:MetadataInfo> </d2p1:MetadataInfos> <d2p1:NormalizedSubject>sample string 5</d2p1:NormalizedSubject> <d2p1:ParentJournalFolderID>1</d2p1:ParentJournalFolderID> <d2p1:PendingTypeID>8</d2p1:PendingTypeID> <d2p1:To>sample string 2</d2p1:To> </d2p1:EmailInfo> <d2p1:EmailInfo> <d2p1:ConversationID>sample string 23</d2p1:ConversationID> <d2p1:Comments>sample string 20</d2p1:Comments> <d2p1:Direction>true</d2p1:Direction> <d2p1:EmailType>22</d2p1:EmailType> <d2p1:HasAttachment>sample string 12</d2p1:HasAttachment> <d2p1:InReplyTo>sample string 16</d2p1:InReplyTo> <d2p1:Keywords>sample string 18</d2p1:Keywords> <d2p1:OrigDate>2024-09-08T02:45:13.7131609+00:00</d2p1:OrigDate> <d2p1:References>sample string 17</d2p1:References> <d2p1:ReplyTo>sample string 15</d2p1:ReplyTo> <d2p1:Size>21</d2p1:Size> <d2p1:Subject>sample string 19</d2p1:Subject> <d2p1:AutoJournalizeAllowed>true</d2p1:AutoJournalizeAllowed> <d2p1:BCC>sample string 4</d2p1:BCC> <d2p1:CC>sample string 3</d2p1:CC> <d2p1:Category>sample string 6</d2p1:Category> <d2p1:ConversationIndex>sample string 1</d2p1:ConversationIndex> <d2p1:DeletionDate>2024-09-08T02:45:13.7131609+00:00</d2p1:DeletionDate> <d2p1:EmailBody>sample string 7</d2p1:EmailBody> <d2p1:From>sample string 1</d2p1:From> <d2p1:JournalFolderID>1</d2p1:JournalFolderID> <d2p1:JournalInfo>sample string 10</d2p1:JournalInfo> <d2p1:JournalizeComment>sample string 11</d2p1:JournalizeComment> <d2p1:JournalizeDate>2024-09-08T02:45:13.7131609+00:00</d2p1:JournalizeDate> <d2p1:MetadataInfos> <d2p1:MetadataInfo> <d2p1:MetadataID>1</d2p1:MetadataID> <d2p1:MetadataName>sample string 2</d2p1:MetadataName> <d2p1:Type>ShortText</d2p1:Type> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:MetadataInfo> <d2p1:MetadataInfo> <d2p1:MetadataID>1</d2p1:MetadataID> <d2p1:MetadataName>sample string 2</d2p1:MetadataName> <d2p1:Type>ShortText</d2p1:Type> <d2p1:Value>sample string 3</d2p1:Value> </d2p1:MetadataInfo> </d2p1:MetadataInfos> <d2p1:NormalizedSubject>sample string 5</d2p1:NormalizedSubject> <d2p1:ParentJournalFolderID>1</d2p1:ParentJournalFolderID> <d2p1:PendingTypeID>8</d2p1:PendingTypeID> <d2p1:To>sample string 2</d2p1:To> </d2p1:EmailInfo> </Data> <Error> <AddtionalInfo xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 1</d3p1:Key> <d3p1:Value>sample string 2</d3p1:Value> </d3p1:KeyValueOfstringstring> <d3p1:KeyValueOfstringstring> <d3p1:Key>sample string 3</d3p1:Key> <d3p1:Value>sample string 4</d3p1:Value> </d3p1:KeyValueOfstringstring> </AddtionalInfo> <ErrorNumber>2</ErrorNumber> <Message>sample string 1</Message> <TimeStamp>2024-09-08T02:45:13.7131609+00:00</TimeStamp> </Error> <Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System"> <ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName> <Message i:nil="true" xmlns="" /> <Data i:nil="true" xmlns="" /> <InnerException i:nil="true" xmlns="" /> <HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL> <StackTraceString i:nil="true" xmlns="" /> <RemoteStackTraceString i:nil="true" xmlns="" /> <RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex> <ExceptionMethod i:nil="true" xmlns="" /> <HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult> <Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source> <WatsonBuckets i:nil="true" xmlns="" /> </Exception> <IsError>true</IsError> <Misc1 /> <Misc2 /> <Misc3 /> <Warning>sample string 2</Warning> </ServiceResponseOfArrayOfEmailInfoVR9rHvAV>