core_v2_achievementSummary Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:19 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:19

Enables scripted content fragments to use achievements

ListAchievementSummaries

Methods

ListAchievementSummaries

ListAchievementSummaries Overload 1

List achievement summaries

Velocity

#set($pagedListResponse = $core_v2_achievementSummary.ListAchievementSummaries())

JavaScript

var pagedListResponse = core_v2_achievementSummary.ListAchievementSummaries();

ListAchievementSummaries Overload 2

List achievement summaries

Velocity

#set($pagedListResponse = $core_v2_achievementSummary.ListAchievementSummaries("%{ AchievementId = $achievementIdArg, CreatedAfterDate = $createdAfterDateArg, CreatedBeforeDate = $createdBeforeDateArg, MemberOfGroupId = $memberOfGroupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_achievementSummary.ListAchievementSummaries({ AchievementId: achievementIdArg, CreatedAfterDate: createdAfterDateArg, CreatedBeforeDate: createdBeforeDateArg, MemberOfGroupId: memberOfGroupIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
AchievementId	`Guid`	Achievement Id	Optional
CreatedAfterDate	`DateTime`	Created After Date	Optional
CreatedBeforeDate	`DateTime`	Created Before Date	Optional
MemberOfGroupId	`Int32`	Member Of Group Id	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 By	Optional		AchievementCount, DisplayName, FirstAwardDate
SortOrder	`String`	Sort Order	Optional		Ascending, Descending

Returns

[[PagedList Script API Type|PagedList]] of [[AchievementSummary Script API Type|AchievementSummary]]