PUT api/content/v4/getleaderboard

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CustomerId	integer	None.
UniqueId	globally unique identifier	None.
UserUniqueId	integer	None.
ProgramId	integer	None.
SectionId	integer	None.
LanguageId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "CustomerId": 1,
  "UniqueId": "5b7ac700-f734-4275-a5de-47d79d2002be",
  "UserUniqueId": 3,
  "ProgramId": 4,
  "SectionId": 5,
  "LanguageId": 6
}

application/xml, text/xml

Sample:

<LeaderBoardRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <CustomerId>1</CustomerId>
  <LanguageId>6</LanguageId>
  <ProgramId>4</ProgramId>
  <SectionId>5</SectionId>
  <UniqueId>5b7ac700-f734-4275-a5de-47d79d2002be</UniqueId>
  <UserUniqueId>3</UserUniqueId>
</LeaderBoardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfLeaderBoardResponse

Name	Type	Additional information
Status	HttpStatusCode	None.
Message	string	None.
Data	LeaderBoardResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {
    "List": [
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "ProfilePic": "sample string 3",
        "Points": 4,
        "Rank": 5,
        "Level": 6,
        "IsLoggedIn": true
      },
      {
        "FirstName": "sample string 1",
        "LastName": "sample string 2",
        "ProfilePic": "sample string 3",
        "Points": 4,
        "Rank": 5,
        "Level": 6,
        "IsLoggedIn": true
      }
    ],
    "BreweryList": [
      {
        "Title": "sample string 1",
        "Points": 2,
        "Rank": 3,
        "LogoURL": "sample string 4"
      },
      {
        "Title": "sample string 1",
        "Points": 2,
        "Rank": 3,
        "LogoURL": "sample string 4"
      }
    ],
    "TotalRecords": 1
  }
}

application/xml, text/xml

Sample:

<APICommonWrapperOfLeaderBoardResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <BreweryList>
      <APILeaderBoardBreweries>
        <LogoURL>sample string 4</LogoURL>
        <Points>2</Points>
        <Rank>3</Rank>
        <Title>sample string 1</Title>
      </APILeaderBoardBreweries>
      <APILeaderBoardBreweries>
        <LogoURL>sample string 4</LogoURL>
        <Points>2</Points>
        <Rank>3</Rank>
        <Title>sample string 1</Title>
      </APILeaderBoardBreweries>
    </BreweryList>
    <List>
      <APILeaderBoard>
        <FirstName>sample string 1</FirstName>
        <IsLoggedIn>true</IsLoggedIn>
        <LastName>sample string 2</LastName>
        <Level>6</Level>
        <Points>4</Points>
        <ProfilePic>sample string 3</ProfilePic>
        <Rank>5</Rank>
      </APILeaderBoard>
      <APILeaderBoard>
        <FirstName>sample string 1</FirstName>
        <IsLoggedIn>true</IsLoggedIn>
        <LastName>sample string 2</LastName>
        <Level>6</Level>
        <Points>4</Points>
        <ProfilePic>sample string 3</ProfilePic>
        <Rank>5</Rank>
      </APILeaderBoard>
    </List>
    <TotalRecords>1</TotalRecords>
  </Data>
  <Message>sample string 1</Message>
  <Status>Continue</Status>
</APICommonWrapperOfLeaderBoardResponseZdSfSp5S>