The User Generated Content Feedback API provides the ability to store "flag" based data that you may need from your users. Some examples would be Likes, Votes, Ratings, Approval/Disapproval, etc. The API is built to be lightweight and fast to add and retrieve data on the fly. It is also built in a generic way so that you can "Flag" any content you may want to track in any custom scenario.

This API is implemented within the REST, WCF and OData API's

Methods

Object Types

BooleanFeedback

This object is used to save Boolean feedback into the Feedback API system. Note that the ReferenceName, FeedbackContentType and SubmissionType values are used as a Unique Key to group all feedback entries containing those values together. This grouping provides the ability to quickly retrieve data from the system as long as searches are done on the grouping values.

RatingFeedback

This object is used to save rating feedback into the Feedback API system. Note that the ReferenceName, FeedbackContentType and SubmissionType values are used as a Unique Key to group all feedback entries containing those values together. This grouping provides the ability to quickly retrieve data from the system as long as searches are done on the grouping values.

FeedbackSearchArgs

This object is used to build up search parameters to retrieve the feedback data you want for a specific item or group of items. This object lets you build rich search queries into your feedback data when trying to retrieve things like “number of likes”, “average rating value”, “sum of all rating values”, etc. This object also allows for date restrictions which are useful for reporting purpose, for example, “how many likes were added today”.

API Samples

The Voting and Rating API provides an Agility developer the ability to easily integrate Voting, Rating, Likes, Approval and Disapproval features against any piece of content within Agility’s content System. There are simple calls that are used to support adding and aggregating these values together.

Use the JavaScript API where possible.

JavaScript API

//ID of the content to related the rating to
var NewsID = 12345;
 
var RatingFeedback = new Agility.UGC.API.RatingFeedback();
RatingFeedback.ReferenceName = "NewsList";
RatingFeedback.ContentType = Agility.UGC.API.FeedbackContentType.WCM;
RatingFeedback.RelatedContentID = NewsID;
RatingFeedback.RatingValue = 3;
 
Agility.UGC.API.SaveRating(RatingFeedback, function (data) {
    alert("Rating Complete");
});

var LikeFeedback = new Agility.UGC.API.BooleanFeedback();
LikeFeedback.ReferenceName = "RecordTypeName";
LikeFeedback.ContentType = Agility.UGC.API.FeedbackContentType.UGC;
LikeFeedback.RelatedContentID = 2825;
 
Agility.UGC.API.SaveLike(LikeFeedback, function (data) {
    if (data.ResponseType == Agility.UGC.API.ResponseType.OK) {
          alert("Like Successfully Saved");               
    }
 });

var VoteFeedback = new Agility.UGC.API.BooleanFeedback();
VoteFeedback .ReferenceName = "RecordTypeName";
VoteFeedback .ContentType = Agility.UGC.API.FeedbackContentType.UGC;
VoteFeedback .RelatedContentID = 2825;
 
Agility.UGC.API.SaveVote(VoteFeedback, function (data) {
    if (data.ResponseType == Agility.UGC.API.ResponseType.OK) {
          alert("Vote Successfully Saved");               
    }
 });

var ApprovalFeedback = new Agility.UGC.API.BooleanFeedback();
ApprovalFeedback .ReferenceName = "RecordTypeName";
ApprovalFeedback .ContentType = Agility.UGC.API.FeedbackContentType.UGC;
ApprovalFeedback .RelatedContentID = 2825;
 
//Save a Positive Feedback entry
Agility.UGC.API.SaveApproveDisapprove(ApprovalFeedback, true, function (data) {
    if (data.ResponseType == Agility.UGC.API.ResponseType.OK) {
          alert("Possitive Approval Successfully Saved");               
    }
 });
 
//Save a Negative Feedback entry
Agility.UGC.API.SaveApproveDisapprove(ApprovalFeedback, false, function (data) {
 if (data.ResponseType == Agility.UGC.API.ResponseType.OK) {
          alert("Negative Approval Successfully Saved");               
    }
 });

var search = new Agility.UGC.API.FeedbackSearchArg();
search.ReferenceName = "ContentReferenceName";
search.ContentType = Agility.UGC.API.FeedbackContentType.WCM;
search.SubmissionType = Agility.UGC.API.FeedbackSubmissionType.Like;
//array of ID's to look up
search.RelatedContentIDs[0] = 1234;
search.Action = Agility.UGC.API.AggregateTypes.Count;
 
Agility.UGC.API.GetFeedbackAggregate(search, function (data) {
      alert("Total Likes: " + data.ResponseData[0].Result);
});

Agility.UGC.API.SaveRating(ratingFeedback, Callback)
Saves a rating value.

var RatingFeedback = new Agility.UGC.API.RatingFeedback();
RatingFeedback.ReferenceName = "CustomTestRatingType";
RatingFeedback.ContentType = Agility.UGC.API.FeedbackContentType.WCM;
RatingFeedback.RelatedContentID = 123;
 
 RatingFeedback.RatingValue = 3;
 Agility.UGC.API.SaveRating(RatingFeedback, function (data) {
                alert("Rating complete: " + data.ResponseData);
});

Agility.UGC.API.SaveLike(booleanFeedback, Callback)
Saves a like.

var LikeFeedback = new Agility.UGC.API.BooleanFeedback();
LikeFeedback.ReferenceName = "MiskiwDataTypes";
LikeFeedback.ContentType = Agility.UGC.API.FeedbackContentType.UGC;
LikeFeedback.RelatedContentID = 2825;
 
//This line is only for demonstration purposes SaveLike() automatically sets this property
LikeFeedback.SubmissionType = Agility.UGC.API.FeedbackSubmissionType.Like;
 
 Agility.UGC.API.SaveLike(LikeFeedback, function (data) {
                    if (data.ResponseType == 0) {
                        alert("Like Has been saved: " +data.ResponseData);
                    }
});

Agility.UGC.API.SaveVote(booleanFeedback, Callback)
Saves a vote.

var VoteFeedback = new Agility.UGC.API.BooleanFeedback();
VoteFeedback .ReferenceName = "MiskiwDataTypes";
VoteFeedback .ContentType = Agility.UGC.API.FeedbackContentType.UGC;
VoteFeedback .RelatedContentID = 2825;
VoteFeedback .SubmissionType = Agility.UGC.API.FeedbackSubmissionType.Vote;
 
Agility.UGC.API.SaveVote(LikeFeedback, function (data) {
                    alert("Vote Saved: " +data.ResponseData);
 });

Agility.UGC.API.SaveApproveDisapprove(booleanFeedback, Callback)
Saves either an approval or disapproval. 

var ApprovalFeedback = new Agility.UGC.API.BooleanFeedback();
ApprovalFeedback .ReferenceName = "MiskiwDataTypes";
ApprovalFeedback .ContentType = Agility.UGC.API.FeedbackContentType.UGC;
ApprovalFeedback .RelatedContentID = 2825;
 
ApprovalFeedback .SubmissionType = Agility.UGC.API.FeedbackSubmissionType.ApproveDisapprove;
 
//Approve
Agility.UGC.API.SaveApproveDisapprove(LikeFeedback, true, function (data) {
                    alert(data.ResponseData);
                    LoadStats();
 });
 
//Disapprove
Agility.UGC.API.SaveApproveDisapprove(LikeFeedback, false, function (data) {
                    alert(data.ResponseData);
                    LoadStats();
});

Agility.UGC.API.GetFeedbackAggregate(feedbackSearchArgs, Callback)
Gets your count values for the given feedback type.

var search = new Agility.UGC.API.FeedbackSearchArg();
search.ReferenceName = "MiskiwUGCCommentLink";
search.ContentType = Agility.UGC.API.FeedbackContentType.WCM;
search.SubmissionType = Agility.UGC.API.FeedbackSubmissionType.Like;
search.RelatedContentID = [1837];
search.Action = Agility.UGC.API.AggregateTypes.Count;
 
Agility.UGC.API.GetFeedbackAggregate(search, function (data) {
                alert("Total Like Count: " +data.ResponseData[0]);
});

.NET API

It is highly recommended to use the JavaScript API for performance reasons, however, if you need to there is the following server to server API.

using (Agility_UGC_API_WCFClient client = DataServiceUtil.GetUGCClient())
{
   DataServiceAuthorization auth =
     DataServiceUtil.GetDataServiceAuthorization(-1);
    
   RatingFeedback feeback = new RatingFeedback();
   feedback.RelatedContentID = 123;
   feedback.RatingValue = 3;
   feedback.ReferenceName = "BlogEntries";
   feedback.ContentType = FeedbackContentType.UGC;
   feedback.SubmissionType= FeedbackSubmissionType.Rating;
             
   int RatingFeedbackID = client.SaveRatingFeedback(auth, feedback)
 
   if (RatingFeedbackID >0) 
   {
     //Rating Successfully Saved
   }
}

using (Agility_UGC_API_WCFClient client = DataServiceUtil.GetUGCClient())
{
   DataServiceAuthorization auth =
     DataServiceUtil.GetDataServiceAuthorization(-1);
    
   BooleanFeedback feeback = new BooleanFeedback ();
   feedback.RelatedContentID = 123;
   feedback.RatingValue = 3;
   feedback.ReferenceName = "BlogEntries";
   feedback.ContentType = FeedbackContentType.UGC;
   feedback.SubmissionType= FeedbackSubmissionType.Like;
             
   int BooleanFeedbackID = client.SaveBooleanFeedback(auth, feedback)
 
   if (BooleanFeedbackID > 0) 
   {
     //Rating Successfully Saved
   }
}

using (Agility_UGC_API_WCFClient client = DataServiceUtil.GetUGCClient())
{
   DataServiceAuthorization auth =
     DataServiceUtil.GetDataServiceAuthorization(-1);
    
   
             
   bool success = client.DeleteBooleanFeedback(auth, 321)
 
   if (success) 
   {
     //Boolean Feedback Deleted successfully
   }
}

using (Agility_UGC_API_WCFClient client = DataServiceUtil.GetUGCClient())
{
   DataServiceAuthorization auth =
     DataServiceUtil.GetDataServiceAuthorization(-1);
     
   bool success = client.DeleteRatingFeedback(auth, 321)
 
   if (success) 
   {
     //RatingFeedback Deleted successfully
   }
}

GetFeedbackAggregate(DataServiceAuthorization auth, FeedbackSearchArgs searchArg)
This method is used to perform searches on the feedback API and provide back rolled up aggregates of the data.