POST api/Suggestion/GetEntitySuggestions
Gets entity suggestions based on where existing emails is journalized
Request Information
URI Parameters
None.
Body Parameters
Input parameter
WorkPoint365.WebAPI.Model.GetEntitySuggestionsParameterName | Description | Type | Additional information |
---|---|---|---|
MaxResultCount |
The maximum count of entity suggestions to return |
integer |
None. |
EmailBasedWeight |
Weight for email based entity suggestions |
decimal number |
None. |
FieldMappingBasedWeight |
Weight for field mapping based entity suggestions |
decimal number |
None. |
BusinessModuleIDs |
A list of business module ids |
Collection of globally unique identifier |
None. |
FromEmailAddresses |
A list of from email Addresses. Only relevant for emailBased entity suggenstion |
Collection of string |
None. |
ToEmailAddresses |
A list of to email Addresses. Only relevant for emailBased entity suggenstion |
Collection of string |
None. |
CcEmailAddresses |
A list of cc email Addresses. Only relevant for emailBased entity suggenstion |
Collection of string |
None. |
Request Formats
application/json, text/json
{ "MaxResultCount": 1, "EmailBasedWeight": 2.1, "FieldMappingBasedWeight": 3.1, "BusinessModuleIDs": [ "6b64715e-1610-4d40-916d-cb7c6b0ecb16", "64c623ed-00f1-4b1f-b72b-a41438ba0c40" ], "FromEmailAddresses": [ "sample string 1", "sample string 2" ], "ToEmailAddresses": [ "sample string 1", "sample string 2" ], "CcEmailAddresses": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
<GetEntitySuggestionsParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model"> <BusinessModuleIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>6b64715e-1610-4d40-916d-cb7c6b0ecb16</d2p1:guid> <d2p1:guid>64c623ed-00f1-4b1f-b72b-a41438ba0c40</d2p1:guid> </BusinessModuleIDs> <CcEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </CcEmailAddresses> <EmailBasedWeight>2.1</EmailBasedWeight> <FieldMappingBasedWeight>3.1</FieldMappingBasedWeight> <FromEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </FromEmailAddresses> <MaxResultCount>1</MaxResultCount> <ToEmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ToEmailAddresses> </GetEntitySuggestionsParameter>
Response Information
Resource Description
Returns a list of entity suggestions.
Collection of WorkPoint365.WebAPI.Model.EntitySuggestionName | Description | Type | Additional information |
---|---|---|---|
Type |
Gets or sets the entity suggestion type |
WorkPoint365.WebAPI.Model.EntitySuggestion+TypeEnum |
None. |
ItemLocation |
Gets or sets the item location |
string |
None. |
SortFactor |
Gets or sets the sort factor |
decimal number |
None. |
SiteID |
Gets or sets the site id |
globally unique identifier |
None. |
WebID |
Gets or sets the web id |
globally unique identifier |
None. |
ListID |
Gets or sets the list id |
globally unique identifier |
None. |
FolderAbsoluteUrl |
Gets or sets the folder absolute url |
string |
None. |
EntityListID |
Gets or sets the entity list ID |
globally unique identifier |
None. |
EntityID |
Gets or sets the entity ID |
integer |
None. |
EntityGuid |
Gets or sets the entity guid |
globally unique identifier |
None. |
EntityTitle |
Gets or sets the entity title |
string |
None. |
EntityPath |
Gets or sets the entity path |
string |
None. |
EntityUrl |
Gets or sets the entity url |
string |
None. |
Response Formats
application/json, text/json
[ { "Type": 10, "ItemLocation": "sample string 1", "SortFactor": 2.1, "SiteID": "46f0bef8-3398-4e76-9855-614a95db596e", "WebID": "b08b80ae-13a2-440e-9c74-76363ff953e1", "ListID": "0017f26b-e627-44a3-880e-635829776457", "FolderAbsoluteUrl": "sample string 3", "EntityListID": "5ccd9c3a-2071-4313-bbd6-648fcbd3aca3", "EntityID": 5, "EntityGuid": "6432a08a-a214-4f15-bf41-112b511289d7", "EntityTitle": "sample string 7", "EntityPath": "sample string 8", "EntityUrl": "sample string 9" }, { "Type": 10, "ItemLocation": "sample string 1", "SortFactor": 2.1, "SiteID": "46f0bef8-3398-4e76-9855-614a95db596e", "WebID": "b08b80ae-13a2-440e-9c74-76363ff953e1", "ListID": "0017f26b-e627-44a3-880e-635829776457", "FolderAbsoluteUrl": "sample string 3", "EntityListID": "5ccd9c3a-2071-4313-bbd6-648fcbd3aca3", "EntityID": 5, "EntityGuid": "6432a08a-a214-4f15-bf41-112b511289d7", "EntityTitle": "sample string 7", "EntityPath": "sample string 8", "EntityUrl": "sample string 9" } ]
application/xml, text/xml
<ArrayOfEntitySuggestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model"> <EntitySuggestion> <EntityGuid>6432a08a-a214-4f15-bf41-112b511289d7</EntityGuid> <EntityID>5</EntityID> <EntityListID>5ccd9c3a-2071-4313-bbd6-648fcbd3aca3</EntityListID> <EntityPath>sample string 8</EntityPath> <EntityTitle>sample string 7</EntityTitle> <EntityUrl>sample string 9</EntityUrl> <FolderAbsoluteUrl>sample string 3</FolderAbsoluteUrl> <ItemLocation>sample string 1</ItemLocation> <ListID>0017f26b-e627-44a3-880e-635829776457</ListID> <SiteID>46f0bef8-3398-4e76-9855-614a95db596e</SiteID> <SortFactor>2.1</SortFactor> <Type>EmailBased</Type> <WebID>b08b80ae-13a2-440e-9c74-76363ff953e1</WebID> </EntitySuggestion> <EntitySuggestion> <EntityGuid>6432a08a-a214-4f15-bf41-112b511289d7</EntityGuid> <EntityID>5</EntityID> <EntityListID>5ccd9c3a-2071-4313-bbd6-648fcbd3aca3</EntityListID> <EntityPath>sample string 8</EntityPath> <EntityTitle>sample string 7</EntityTitle> <EntityUrl>sample string 9</EntityUrl> <FolderAbsoluteUrl>sample string 3</FolderAbsoluteUrl> <ItemLocation>sample string 1</ItemLocation> <ListID>0017f26b-e627-44a3-880e-635829776457</ListID> <SiteID>46f0bef8-3398-4e76-9855-614a95db596e</SiteID> <SortFactor>2.1</SortFactor> <Type>EmailBased</Type> <WebID>b08b80ae-13a2-440e-9c74-76363ff953e1</WebID> </EntitySuggestion> </ArrayOfEntitySuggestion>