POST _vti_bin/DelveApi.ashx/{version}/signals/shown

Request Information

URI Parameters

Name	Description	Type	Additional information
version		integer	Required

Body Parameters

RequestSignal

Name	Type	Additional information
Title	string	None.
ActorId	string	None.
ImpressionId	string	None.
SourcePage	string	None.
Items	Dictionary of string [key] and string [value]	None.
DocumentId	string	None.
DocumentUrl	string	None.
DocumentPosition	string	None.
ClickType	string	None.
UserEmail	string	None.
Context	string	None.
TagName	string	None.
Type	RequestSignalType	None.
QueryText	string	None.
AddTagToActor	boolean	None.
FollowTag	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "ActorId": "sample string 2",
  "ImpressionId": "sample string 3",
  "SourcePage": "sample string 4",
  "Items": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  "DocumentId": "sample string 5",
  "DocumentUrl": "sample string 6",
  "DocumentPosition": "sample string 7",
  "ClickType": "sample string 8",
  "UserEmail": "sample string 9",
  "Context": "sample string 10",
  "TagName": "sample string 11",
  "Type": "Unknown",
  "QueryText": "sample string 12",
  "AddTagToActor": true,
  "FollowTag": true
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Enum value 'Unknown' is invalid for type 'Microsoft.Office.Server.Search.DelveApi.DataModel.RequestSignalType' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Enum value 'Unknown' is invalid for type 'Microsoft.Office.Server.Search.DelveApi.DataModel.RequestSignalType' and cannot be serialized. Ensure that the necessary enum values are present and are marked with EnumMemberAttribute attribute if the type has DataContractAttribute attribute.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RequestSignal'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>