GET classroomAPI/Gamification/getLeaderboard?maxitems={maxitems}&username={username}&GroupID={GroupID}&JobTitleID={JobTitleID}

Request Information

URI Parameters

Name	Type	Additional information
maxitems	integer	Required
username	string	Required
GroupID	integer	Required
JobTitleID	string	Required

Body Parameters

None.

Response Information

Resource Description

Leaderboard

Name	Type	Additional information
board	Collection of LeaderboardItem	None.
thisuser	LeaderboardItem	None.
byRegion	boolean	None.
byJobTitle	boolean	None.
byNSC	boolean	None.
CompanyID	integer	None.
maxItems	integer	None.
JobTitle	globally unique identifier	None.
username	string	None.
isAnonymous	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "board": [
    {
      "userid": 1,
      "username": "sample string 2",
      "firstname": "sample string 3",
      "lastname": "sample string 4",
      "companyname": "sample string 5",
      "jobtitle": "sample string 6",
      "points": 7,
      "imageurl": "sample string 8",
      "trophy": "sample string 9",
      "region": 10,
      "country": 11,
      "position": 12
    },
    {
      "userid": 1,
      "username": "sample string 2",
      "firstname": "sample string 3",
      "lastname": "sample string 4",
      "companyname": "sample string 5",
      "jobtitle": "sample string 6",
      "points": 7,
      "imageurl": "sample string 8",
      "trophy": "sample string 9",
      "region": 10,
      "country": 11,
      "position": 12
    }
  ],
  "thisuser": {
    "userid": 1,
    "username": "sample string 2",
    "firstname": "sample string 3",
    "lastname": "sample string 4",
    "companyname": "sample string 5",
    "jobtitle": "sample string 6",
    "points": 7,
    "imageurl": "sample string 8",
    "trophy": "sample string 9",
    "region": 10,
    "country": 11,
    "position": 12
  },
  "byRegion": true,
  "byJobTitle": true,
  "byNSC": true,
  "CompanyID": 1,
  "maxItems": 1,
  "JobTitle": "5ce13019-d207-4f6b-bc9a-9f933635e353",
  "username": "sample string 5",
  "isAnonymous": true
}

application/xml, text/xml

Sample:

<Leaderboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Classroom.ClassroomBLL">
  <CompanyID>1</CompanyID>
  <JobTitle>5ce13019-d207-4f6b-bc9a-9f933635e353</JobTitle>
  <board>
    <LeaderboardItem>
      <companyname>sample string 5</companyname>
      <country>11</country>
      <firstname>sample string 3</firstname>
      <imageurl>sample string 8</imageurl>
      <jobtitle>sample string 6</jobtitle>
      <lastname>sample string 4</lastname>
      <points>7</points>
      <position>12</position>
      <region>10</region>
      <trophy>sample string 9</trophy>
      <userid>1</userid>
      <username>sample string 2</username>
    </LeaderboardItem>
    <LeaderboardItem>
      <companyname>sample string 5</companyname>
      <country>11</country>
      <firstname>sample string 3</firstname>
      <imageurl>sample string 8</imageurl>
      <jobtitle>sample string 6</jobtitle>
      <lastname>sample string 4</lastname>
      <points>7</points>
      <position>12</position>
      <region>10</region>
      <trophy>sample string 9</trophy>
      <userid>1</userid>
      <username>sample string 2</username>
    </LeaderboardItem>
  </board>
  <byJobTitle>true</byJobTitle>
  <byNSC>true</byNSC>
  <byRegion>true</byRegion>
  <isAnonymous>true</isAnonymous>
  <maxItems>1</maxItems>
  <thisuser>
    <companyname>sample string 5</companyname>
    <country>11</country>
    <firstname>sample string 3</firstname>
    <imageurl>sample string 8</imageurl>
    <jobtitle>sample string 6</jobtitle>
    <lastname>sample string 4</lastname>
    <points>7</points>
    <position>12</position>
    <region>10</region>
    <trophy>sample string 9</trophy>
    <userid>1</userid>
    <username>sample string 2</username>
  </thisuser>
  <username>sample string 5</username>
</Leaderboard>