GET api.ashx/v2/likeditems.{json|xml}
Request Parameters
Name | Type | Location | Description | Required | Default | Options |
---|---|---|---|---|---|---|
ApplicationId | Guid | Query String | Content application identifier for the liked item. | Optional | ||
AuthorId | int | Query String | Author Id of the content that was liked. | Optional | ||
ContainerId | Guid | Query String | Content container identifier for the liked item. | Optional | ||
ContentCreatedAfterDate | Guid | Query String | Include only content created on or after. | Optional | ||
ContentCreatedBeforeDate | Guid | Query String | Include only content created before. | Optional | ||
ContentIds | string | Query String | Comma separated list of ContentIds. Used to limit to a specific set of liked items as well as sort order if SortBy is set to ContentIdsOrder. | Optional | ||
ContentTypeId | Guid | Query String | Content type identifier for the liked item. | Optional | ||
ContentTypeIds | string | Query String | Comma separated list of Content type ids. Used to filter likes by specific content types. | Optional | ||
IncludeAllTypeIds | bool | Query String | Option to include all Type Id's. If TypeId is passed in, will be ignored. | Optional | False | |
IncludeSubContainers | bool | Query String | Include sub containers when filtering by ContentId | Optional | ||
MaximumLikeCount | int | Query String | MaximumLikeCount number of likes the content can have for content to be returned | Optional | ||
MinimumLikeCount | int | Query String | Minimum number of likes the content must have for content to be returned | Optional | ||
PageIndex | int | Query String | Page of results to return | Optional | ||
PageSize | int | Query String | Number of results to return | Optional | ||
PostTarget | string | Query String | Render target. | Optional | WebServices | Unknown,Web,Syndication,Other,Print,Nntp,Email,WebQuote,WebServices |
SortBy | string | Query String | Accepted values are: LikeCount (default), ContentIdsOrder | Optional | LikeCount | |
SortOrder | string | Query String | Accepted values are: Ascending, Descending | Optional | ||
TypeId | Guid | Query String | Categorization type for the like. | Optional |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({ url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/likeditems.json' }).then(function(response) { // use response });
Example Responses
JSON
{ "PageSize": 2, "PageIndex": 0, "TotalCount": 2, "LikedItems": [ { "Content": null, "TypeId": "49fec544-6df7-4a82-872b-f8be586d5e9e", "LikeCount": 6, "Warnings": [], "Errors": [] }, { "Content": null, "TypeId": "9f5a6721-639d-4e1d-ab6a-ce63b7750f46", "LikeCount": 25, "Warnings": [], "Errors": [] } ], "Errors": [ "string", "string" ] }
XML
<?xml version="1.0" encoding="utf-16"?> <Response> <LikedItems PageSize="2" PageIndex="0" TotalCount="2"> <LikedItem> <TypeId>49fec544-6df7-4a82-872b-f8be586d5e9e</TypeId> <LikeCount>6</LikeCount> </LikedItem> <LikedItem> <TypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</TypeId> <LikeCount>25</LikeCount> </LikedItem> </LikedItems> <Errors> <Message>string</Message> <Message>string</Message> </Errors> </Response>