Enables scripted content fragments to use rated items
Properties
| Name | Access | Type | Description |
|---|---|---|---|
| NotificationTypeId | Read | Guid | The default notification type id for ratings |
Methods
Get
Get Overload 1
Gets a rating summary for a piece of content
Velocity
#set($ratedItemResponse = $core_v2_ratedItem.Get($contentId))
JavaScript
var ratedItemResponse = core_v2_ratedItem.Get(contentId);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required |
Get Overload 2
Gets a rating summary for a piece of content
Velocity
#set($ratedItemResponse = $core_v2_ratedItem.Get($contentId, "%{ TypeId = $typeIdArg }"))JavaScript
var ratedItemResponse = core_v2_ratedItem.Get(contentId, { TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentId | Guid | Content Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| TypeId | Guid | Categorization type | Optional |
Get Overload 3
Gets a rating summary for a piece of external content
Velocity
#set($ratedItemResponse = $core_v2_ratedItem.Get($contentUrl, $oauthClientId, "%{ TypeId = $typeIdArg }"))JavaScript
var ratedItemResponse = core_v2_ratedItem.Get(contentUrl, oauthClientId, { TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| contentUrl | String | Content Url | Required | ||
| oauthClientId | Guid | Oauth Client Id | Required | ||
| options | Options | Set of optional parameters including: | Required | ||
| TypeId | Guid | Categorization type | Optional |
Returns
List
Lists rating summaries for content
Velocity
#set($pagedListResponse = $core_v2_ratedItem.List("%{ ApplicationId = $applicationIdArg, ContainerId = $containerIdArg, ContentTypeId = $contentTypeIdArg, IncludeSubContainers = $includeSubContainersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, TypeId = $typeIdArg }"))JavaScript
var pagedListResponse = core_v2_ratedItem.List({ ApplicationId: applicationIdArg, ContainerId: containerIdArg, ContentTypeId: contentTypeIdArg, IncludeSubContainers: includeSubContainersArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, TypeId: typeIdArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | Options | Set of optional parameters including: | Required | ||
| ApplicationId | Guid | Content application identifier | Optional | ||
| ContainerId | Guid | Content container identifier | Optional | ||
| ContentTypeId | Guid | Content type identifier | Optional | ||
| IncludeSubContainers | Boolean | Include sub containers | Optional | ||
| PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | String | Sort mechanism | Optional | Rating | Rating |
| SortOrder | String | Sort order | Optional | Ascending | Ascending, Descending |
| TypeId | Guid | Categorization type | Optional |