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.GetEntitySuggestionsParameter

Name	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

Sample:

{
  "MaxResultCount": 1,
  "EmailBasedWeight": 2.1,
  "FieldMappingBasedWeight": 3.1,
  "BusinessModuleIDs": [
    "e442c5f6-a5a7-4b73-8bb0-973a79070be5",
    "fd53df89-4f8e-4c63-a533-53b8f44a4cc6"
  ],
  "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

Sample:

<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>e442c5f6-a5a7-4b73-8bb0-973a79070be5</d2p1:guid>
    <d2p1:guid>fd53df89-4f8e-4c63-a533-53b8f44a4cc6</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.EntitySuggestion

Name	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

Sample:

[
  {
    "Type": 10,
    "ItemLocation": "sample string 1",
    "SortFactor": 2.1,
    "SiteID": "85ddf0d2-6d54-4e10-b742-43eb89124598",
    "WebID": "ad0c1619-76d3-4263-be45-55f0aa94e389",
    "ListID": "92c1fd1b-f094-4d6e-90e8-0f36e3095201",
    "FolderAbsoluteUrl": "sample string 3",
    "EntityListID": "a79670ae-0056-420e-aba5-81d73af48336",
    "EntityID": 5,
    "EntityGuid": "f38f332b-bae9-478e-b8bb-da4f0a3e2d87",
    "EntityTitle": "sample string 7",
    "EntityPath": "sample string 8",
    "EntityUrl": "sample string 9"
  },
  {
    "Type": 10,
    "ItemLocation": "sample string 1",
    "SortFactor": 2.1,
    "SiteID": "85ddf0d2-6d54-4e10-b742-43eb89124598",
    "WebID": "ad0c1619-76d3-4263-be45-55f0aa94e389",
    "ListID": "92c1fd1b-f094-4d6e-90e8-0f36e3095201",
    "FolderAbsoluteUrl": "sample string 3",
    "EntityListID": "a79670ae-0056-420e-aba5-81d73af48336",
    "EntityID": 5,
    "EntityGuid": "f38f332b-bae9-478e-b8bb-da4f0a3e2d87",
    "EntityTitle": "sample string 7",
    "EntityPath": "sample string 8",
    "EntityUrl": "sample string 9"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEntitySuggestion xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <EntitySuggestion>
    <EntityGuid>f38f332b-bae9-478e-b8bb-da4f0a3e2d87</EntityGuid>
    <EntityID>5</EntityID>
    <EntityListID>a79670ae-0056-420e-aba5-81d73af48336</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>92c1fd1b-f094-4d6e-90e8-0f36e3095201</ListID>
    <SiteID>85ddf0d2-6d54-4e10-b742-43eb89124598</SiteID>
    <SortFactor>2.1</SortFactor>
    <Type>EmailBased</Type>
    <WebID>ad0c1619-76d3-4263-be45-55f0aa94e389</WebID>
  </EntitySuggestion>
  <EntitySuggestion>
    <EntityGuid>f38f332b-bae9-478e-b8bb-da4f0a3e2d87</EntityGuid>
    <EntityID>5</EntityID>
    <EntityListID>a79670ae-0056-420e-aba5-81d73af48336</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>92c1fd1b-f094-4d6e-90e8-0f36e3095201</ListID>
    <SiteID>85ddf0d2-6d54-4e10-b742-43eb89124598</SiteID>
    <SortFactor>2.1</SortFactor>
    <Type>EmailBased</Type>
    <WebID>ad0c1619-76d3-4263-be45-55f0aa94e389</WebID>
  </EntitySuggestion>
</ArrayOfEntitySuggestion>