GET api/v2/leaderboards/{id}.{json|xml}
Scopes
Leaderboards › Read Leaderboards leaderboards.boards.readonly
Request Parameters
| Name | Type | Location | Description | Required | Default | Options |
|---|---|---|---|---|---|---|
| Id | Guid | Query String | Id of the Leaderboard | Required | ||
| PostTarget | string | Query String | Render target. | Optional | Unknown,Web,Syndication,Other,Print,Nntp,Email,WebQuote,WebServices |
Example Requests
Widget Javascript
jQuery.telligent.evolution.get({
url: jQuery.telligent.evolution.site.getBaseUrl() + 'api/v2/leaderboards/{id}.json',
data: {
'id': '49fec544-6df7-4a82-872b-f8be586d5e9e'
}
}).then(function(response) {
// use response
});Example Responses
JSON
{
"Leaderboard": {"Name":"name","Description":"description","ContentId":"49fec544-6df7-4a82-872b-f8be586d5e9e","ContentTypeId":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","CreatedDate":"2012-01-04T00:00:00","IsEnabled":true,"NumberOfLeaders":6,"ContainerId":"fe65240b-044c-4292-9946-f10e0361ecff","StartDate":"2012-05-02T00:00:00","EndDate":"2012-06-04T00:00:00","StartDisplayDate":"2011-05-28T00:00:00","EndDisplayDate":"2011-12-09T00:00:00","LastCalculatedDate":"2012-03-29T00:00:00","TimeSpanLength":25,"TimeSpanType":"timespantype","TimeSpanFilterType":"timespanfiltertype","IncludeRolesFilter":[{"Id":8,"RoleId":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","Name":"name","Description":"description","GroupId":4,"IsSystemRole":true,"ImageUrl":"","AvatarUrl":"avatarurl","IsPrivate":true,"PermissionEntries":[{"Id":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true},{"Id":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true}]},{"Id":7,"RoleId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","Name":"name","Description":"description","GroupId":27,"IsSystemRole":true,"ImageUrl":"","AvatarUrl":"avatarurl","IsPrivate":true,"PermissionEntries":[{"Id":"6cdcf200-3bad-476d-af45-97b52545c337","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true},{"Id":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true}]}],"ExcludeRolesFilter":[{"Id":32,"RoleId":"44df201a-07e6-42eb-96c7-8ce7ce35aab6","Name":"name","Description":"description","GroupId":52,"IsSystemRole":true,"ImageUrl":"","AvatarUrl":"avatarurl","IsPrivate":true,"PermissionEntries":[{"Id":"49fec544-6df7-4a82-872b-f8be586d5e9e","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true},{"Id":"9f5a6721-639d-4e1d-ab6a-ce63b7750f46","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true}]},{"Id":19,"RoleId":"fe65240b-044c-4292-9946-f10e0361ecff","Name":"name","Description":"description","GroupId":112,"IsSystemRole":true,"ImageUrl":"","AvatarUrl":"avatarurl","IsPrivate":true,"PermissionEntries":[{"Id":"2d525bad-c4df-470d-a193-a1c6d66e5c3e","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true},{"Id":"bd519379-b61f-4e2f-b0f9-c0f28c5cceb1","PermissionId":"permissionid","Name":"name","IsAllowed":true,"IsImmediate":true}]}],"Application":{"ApplicationId":"9ba1ec43-dc34-4e27-a579-4a0855144e2f","ApplicationTypeId":"e3715662-2528-4ba1-84a7-bfcd9d548f80","HtmlName":"htmlname","HtmlDescription":"htmldescription","Url":"url","AvatarUrl":"avatarurl","Container":{"ContainerId":"6cdcf200-3bad-476d-af45-97b52545c337","ContainerTypeId":"b04540ec-eb38-4fa1-b7bb-e3fde05401b4","HtmlName":"htmlname","Url":"url","AvatarUrl":"avatarurl"}},"Id":61},
"Errors": ["string","string"]
}XML
<?xml version="1.0" encoding="utf-16"?>
<Response>
<Leaderboard>
<Id>61</Id>
<Name>name</Name>
<Description>description</Description>
<ContentId>49fec544-6df7-4a82-872b-f8be586d5e9e</ContentId>
<ContentTypeId>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</ContentTypeId>
<CreatedDate>2012-01-04T00:00:00</CreatedDate>
<IsEnabled>true</IsEnabled>
<NumberOfLeaders>6</NumberOfLeaders>
<ContainerId>fe65240b-044c-4292-9946-f10e0361ecff</ContainerId>
<StartDate>2012-05-02T00:00:00</StartDate>
<EndDate>2012-06-04T00:00:00</EndDate>
<StartDisplayDate>2011-05-28T00:00:00</StartDisplayDate>
<EndDisplayDate>2011-12-09T00:00:00</EndDisplayDate>
<LastCalculatedDate>2012-03-29T00:00:00</LastCalculatedDate>
<TimeSpanLength>25</TimeSpanLength>
<TimeSpanType>timespantype</TimeSpanType>
<TimeSpanFilterType>timespanfiltertype</TimeSpanFilterType>
<IncludeRolesFilter>
<Role>
<Id>8</Id>
<RoleId>2d525bad-c4df-470d-a193-a1c6d66e5c3e</RoleId>
<Name>name</Name>
<Description>description</Description>
<GroupId>4</GroupId>
<IsSystemRole>true</IsSystemRole>
<AvatarUrl>avatarurl</AvatarUrl>
<IsPrivate>true</IsPrivate>
<PermissionEntries>
<PermissionEntry>
<Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
<PermissionEntry>
<Id>9ba1ec43-dc34-4e27-a579-4a0855144e2f</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
</PermissionEntries>
</Role>
<Role>
<Id>7</Id>
<RoleId>e3715662-2528-4ba1-84a7-bfcd9d548f80</RoleId>
<Name>name</Name>
<Description>description</Description>
<GroupId>27</GroupId>
<IsSystemRole>true</IsSystemRole>
<AvatarUrl>avatarurl</AvatarUrl>
<IsPrivate>true</IsPrivate>
<PermissionEntries>
<PermissionEntry>
<Id>6cdcf200-3bad-476d-af45-97b52545c337</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
<PermissionEntry>
<Id>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
</PermissionEntries>
</Role>
</IncludeRolesFilter>
<ExcludeRolesFilter>
<Role>
<Id>32</Id>
<RoleId>44df201a-07e6-42eb-96c7-8ce7ce35aab6</RoleId>
<Name>name</Name>
<Description>description</Description>
<GroupId>52</GroupId>
<IsSystemRole>true</IsSystemRole>
<AvatarUrl>avatarurl</AvatarUrl>
<IsPrivate>true</IsPrivate>
<PermissionEntries>
<PermissionEntry>
<Id>49fec544-6df7-4a82-872b-f8be586d5e9e</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
<PermissionEntry>
<Id>9f5a6721-639d-4e1d-ab6a-ce63b7750f46</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
</PermissionEntries>
</Role>
<Role>
<Id>19</Id>
<RoleId>fe65240b-044c-4292-9946-f10e0361ecff</RoleId>
<Name>name</Name>
<Description>description</Description>
<GroupId>112</GroupId>
<IsSystemRole>true</IsSystemRole>
<AvatarUrl>avatarurl</AvatarUrl>
<IsPrivate>true</IsPrivate>
<PermissionEntries>
<PermissionEntry>
<Id>2d525bad-c4df-470d-a193-a1c6d66e5c3e</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
<PermissionEntry>
<Id>bd519379-b61f-4e2f-b0f9-c0f28c5cceb1</Id>
<PermissionId>permissionid</PermissionId>
<Name>name</Name>
<IsAllowed>true</IsAllowed>
<IsImmediate>true</IsImmediate>
</PermissionEntry>
</PermissionEntries>
</Role>
</ExcludeRolesFilter>
<Application>
<ApplicationId>9ba1ec43-dc34-4e27-a579-4a0855144e2f</ApplicationId>
<ApplicationTypeId>e3715662-2528-4ba1-84a7-bfcd9d548f80</ApplicationTypeId>
<HtmlName>htmlname</HtmlName>
<HtmlDescription>htmldescription</HtmlDescription>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
<Container>
<ContainerId>6cdcf200-3bad-476d-af45-97b52545c337</ContainerId>
<ContainerTypeId>b04540ec-eb38-4fa1-b7bb-e3fde05401b4</ContainerTypeId>
<HtmlName>htmlname</HtmlName>
<Url>url</Url>
<AvatarUrl>avatarurl</AvatarUrl>
</Container>
</Application>
</Leaderboard>
<Errors>
<Message>string</Message>
<Message>string</Message>
</Errors>
</Response>