POST api/v2.0/Answer/Recommend?answerKey={answerKey}
Acts as a toggle for recommending an answer. A POST request will recommend while DELETE will remove the recommendation. An answer recommendation refers to the answer being "Helpful" in a Q and A thread.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
answerKey |
unique identifier for the Answer to recommend/un-recommend |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
The answer for which the requester’s recommendation was added or removed
AnswerName | Description | Type | Additional information |
---|---|---|---|
AnswerKey |
Unique identifier of the answer. |
globally unique identifier |
None. |
ParentKey |
Unique identifier of the answer's parent question. |
globally unique identifier |
None. |
IsBestAnswer |
True if this answer has been designated as best answer for the root question. False if this answer has not been designated as best answer for the root question. |
boolean |
None. |
BestAnswerOn |
DateTime in UTC when this answer had been designated as best answer for the root question. Omitted when this answer has not been designated as best answer. |
date |
None. |
Content |
HTML Body of the item |
string |
None. |
PublishedOn |
DateTime in UTC when the item was published |
date |
None. |
Community |
Community to which the item was published |
Community |
None. |
Author |
Author to which the item should be attributed |
ContactConcise |
None. |
Attachments |
Attachments included with this item. |
Collection of DocumentAttachment |
None. |
IsAnonymous |
True if author attribution is to indicate item was submitted anonymously, False if the author attribution indicates who authored the item. Omitted when item is attributed to its author. |
boolean |
None. |
Creator |
When item is posted anonymously, indicates the actual author of the item. Omitted when item is attributed to its author. |
ContactConcise |
None. |
EditedOn |
DateTime in UTC when the item was last edited. Omitted if item has not been edited. |
date |
None. |
EditedBy |
Indicates contact that last edited this item. Omitted if item has not been edited. |
ContactConcise |
None. |
IsModerated |
Indicates whether the item is currently moderated. Omitted when the item is not in moderation. |
boolean |
None. |
RecommendationCount |
Number of contacts who have recommended this item. |
integer |
None. |
HasRecommended |
If the current contact has recommended this item |
boolean |
None. |
Tags |
All of the tags indexed for the item. This includes user tags and admin based tags. |
Collection of ItemTagResponse |
None. |
UserPermissions |
Permissions for actions the current user can take on the item. |
Collection of string |
None. |
Response Formats
application/json, text/json
{ "AnswerKey": "118cad21-8942-4d9f-a10f-49343ce809ac", "ParentKey": "942405a6-2017-4c73-b36b-aca9ec632a74", "IsBestAnswer": true, "BestAnswerOn": "2023-04-01T10:53:03.6578091Z", "Content": "sample string 5", "PublishedOn": "2023-04-01T10:53:03.6578091Z", "Community": null, "Author": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "67f63d6e-faef-42b7-a69b-b880c2a29ea4", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-04-01T10:53:03.6578091Z", "UpdatedByContactKey": "46ba0f73-ac98-42e0-b12a-d5f30b1b3aec", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-04-01T10:53:03.6578091Z" }, "Attachments": [ { "DocumentAttachmentKey": "30af03b0-da2e-4760-8f65-e7443ed9e33b", "DocumentKey": "d4838345-636f-49a3-8b2b-5a2b279a4a61", "FileName": "sample string 3", "UploadedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "67f63d6e-faef-42b7-a69b-b880c2a29ea4", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-04-01T10:53:03.6578091Z", "UpdatedByContactKey": "46ba0f73-ac98-42e0-b12a-d5f30b1b3aec", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-04-01T10:53:03.6578091Z" }, "CreatedOn": "2023-04-01T10:53:03.6578091Z", "FileExtension": "sample string 5", "FileSizeInBytes": 1, "Width": 1, "Height": 1, "DurationSeconds": 1, "DownloadUrl": "sample string 6", "IconUrl": "sample string 7", "Status": "sample string 8" }, { "DocumentAttachmentKey": "30af03b0-da2e-4760-8f65-e7443ed9e33b", "DocumentKey": "d4838345-636f-49a3-8b2b-5a2b279a4a61", "FileName": "sample string 3", "UploadedByContact": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "67f63d6e-faef-42b7-a69b-b880c2a29ea4", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-04-01T10:53:03.6578091Z", "UpdatedByContactKey": "46ba0f73-ac98-42e0-b12a-d5f30b1b3aec", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-04-01T10:53:03.6578091Z" }, "CreatedOn": "2023-04-01T10:53:03.6578091Z", "FileExtension": "sample string 5", "FileSizeInBytes": 1, "Width": 1, "Height": 1, "DurationSeconds": 1, "DownloadUrl": "sample string 6", "IconUrl": "sample string 7", "Status": "sample string 8" } ], "IsAnonymous": true, "Creator": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "67f63d6e-faef-42b7-a69b-b880c2a29ea4", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-04-01T10:53:03.6578091Z", "UpdatedByContactKey": "46ba0f73-ac98-42e0-b12a-d5f30b1b3aec", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-04-01T10:53:03.6578091Z" }, "EditedOn": "2023-04-01T10:53:03.6578091Z", "EditedBy": { "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "ContactKey": "67f63d6e-faef-42b7-a69b-b880c2a29ea4", "FirstName": "sample string 4", "LastName": "sample string 5", "DisplayName": "sample string 6", "EmailAddress": "sample string 7", "ContactStatusCode": "sample string 8", "PrefixCode": "sample string 9", "UpdatedOn": "2023-04-01T10:53:03.6578091Z", "UpdatedByContactKey": "46ba0f73-ac98-42e0-b12a-d5f30b1b3aec", "CompanyName": "sample string 12", "CompanyTitle": "sample string 13", "SuffixCode": "sample string 14", "Designation": "sample string 15", "LegacyContactKey": "sample string 16", "InformalName": "sample string 17", "MiddleName": "sample string 18", "IsCompany": true, "CompanyLegacyContactKey": "sample string 20", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "LargePictureUrl": "sample string 24", "AgreedToTermsDateTime": "2023-04-01T10:53:03.6578091Z" }, "IsModerated": true, "RecommendationCount": 10, "HasRecommended": true, "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "UserPermissions": [ "sample string 1", "sample string 2" ] }
application/xml
Sample not available.
text/xml
Sample not available.