Get Total Badges and Points For User
Returns the number of badges and point for a user.
AccessLevel: Super Admins/Account Owners/Administrators Only
Request Uri
GET /users/{userId}/gamificationsummary
Response
Returns HTTP status code 200 on success and the session list in the response body.
<GamificationAchievementSummary>
<TotalBadgeEarned>INT</TotalBadgeEarned>
<TotalPointEarned>DECIMAL(15,2)</TotalPointEarned>
</GamificationAchievementSummary>
Get List of Badges Earned By User
Returns a list of badges and point for a user.
AccessLevel: Super Admins/Account Owners/Administrators Only
Request Uri
GET /users/{userId}/badges
Response
Returns HTTP status code 200 on success and the session list in the response body.
<Badges>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
</Badges>
Get Badges and Points Earned By User
Returns a list of badges, courses/learning paths, date completed, point for a user.
AccessLevel: Super Admins/Account Owners/Administrators Only
Request Uri
GET /users/{userId}/gamificationdetails
Response
Returns HTTP status code 200 on success and the session list in the response body.
<GamificationAchievedItems>
<GamificationAchievedItem>
<ID>string [max length 50]</ID>
<ItemID>string [max length 50]</ItemID>
<ItemName>string [max length 500]</ItemName>
<EarnedPoint>DECIMAL(15,2)</EarnedPoint>
<EarnedBadgeID>string [max length 50]</EarnedBadgeID>
<DateCompleted>datetime [iso 8601 format]</DateCompleted>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
<GamificationLearningPathItemList>
<GamificationLearningPathItem>
<ID>string [max length 50]</ID>
<LearningPathID>string [max length 50]</LearningPathID>
<LearningPathName>string [max length 255]</LearningPathName>
</GamificationLearningPathItem>
</GamificationLearningPathItemList>
</GamificationAchievedItem>
<GamificationAchievedItem>
<GamificationAchievedItem>
<ID>string [max length 50]</ID>
<ItemID>string [max length 50]</ItemID>
<ItemName>string [max length 500]</ItemName>
<EarnedPoint>DECIMAL(15,2)</EarnedPoint>
<EarnedBadgeID>string [max length 50]</EarnedBadgeID>
<DateCompleted>datetime [iso 8601 format]</DateCompleted>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
<GamificationLearningPathItemList>
<GamificationLearningPathItem>
<ID>string [max length 50]</ID>
<LearningPathID>string [max length 50]</LearningPathID>
<LearningPathName>string [max length 255]</LearningPathName>
</GamificationLearningPathItem>
</GamificationLearningPathItemList>
</GamificationAchievedItem>
Get Badges and Points earned by a Team
Returns a list of users, badges, courses/learning paths, date completed, points for a team.
AccessLevel: Super Admins/Account Owners/Administrators Only
Request Uri
GET /teams/{teamId}/gamificationdetails
Response
Returns HTTP status code 200 on success and the session list in the response body.
<GamificationUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<GamificationUser>
<Id>string [max length 50]</Id>
<FirstName>string [max length 100]</FirstName>
<LastName>string [max length 100]</LastName>
<GamificationAchievedItems>
<GamificationAchievedItem>
<ID>string [max length 50]</ID>
<ItemID>string [max length 50]</ItemID>
<ItemName>string [max length 500]</ItemName>
<EarnedPoint>DECIMAL(15,2)</EarnedPoint>
<EarnedBadgeID>string [max length 50]</EarnedBadgeID>
<DateCompleted>datetime [iso 8601 format]</DateCompleted>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
<GamificationLearningPathItemList>
<GamificationLearningPathItem>
<ID>string [max length 50]</ID>
<LearningPathID>string [max length 50]</LearningPathID>
<LearningPathName>string [max length 255]</LearningPathName>
</GamificationLearningPathItem>
</GamificationLearningPathItemList>
</GamificationAchievedItem>
<GamificationAchievedItem>
<GamificationUser>
<Id>string [max length 50]</Id>
<FirstName>string [max length 100]</FirstName>
<LastName>string [max length 100]</LastName>
<GamificationAchievedItems>
<GamificationAchievedItem>
<ID>string [max length 50]</ID>
<ItemID>string [max length 50]</ItemID>
<ItemName>string [max length 500]</ItemName>
<EarnedPoint>DECIMAL(15,2)</EarnedPoint>
<EarnedBadgeID>string [max length 50]</EarnedBadgeID>
<DateCompleted>datetime [iso 8601 format]</DateCompleted>
<Badge>
<ID>string [max length 50]</ID>
<Title>string [max length 500]</Title>
<Description>string</Description>
<Icon>icon url string</Icon>
<IconBgColor>string [max length 500]</IconBgColor>
<IconDisplayUrl>string</IconDisplayUrl>
</Badge>
<GamificationLearningPathItemList>
<GamificationLearningPathItem>
<ID>string [max length 50]</ID>
<LearningPathID>string [max length 50]</LearningPathID>
<LearningPathName>string [max length 255]</LearningPathName>
</GamificationLearningPathItem>
</GamificationLearningPathItemList>
</GamificationAchievedItem>
<GamificationAchievedItem>
</GamificationUsers>
Reset Gamification for a User
Resets the gamification points and badges for a user.
AccessLevel: Super Admins/Account Owners/Administrators Only
Request Uri
PUT /users/[UserId]/gamificationreset
Comments
0 comments
Please sign in to leave a comment.