PUT api/content/v4/usertrip/getleaderboardforusertrip

Request Information

URI Parameters

None.

Body Parameters

LeaderBoardRequest
NameDescriptionTypeAdditional 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": "773aec10-11f4-4ef0-9a95-96221ed028be",
  "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>773aec10-11f4-4ef0-9a95-96221ed028be</UniqueId>
  <UserUniqueId>3</UserUniqueId>
</LeaderBoardRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

APICommonWrapperOfAPIUserTripLeaderBoardResponse
NameDescriptionTypeAdditional information
Status

HttpStatusCode

None.

Message

string

None.

Data

APIUserTripLeaderBoardResponse

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
      }
    ],
    "TotalRecords": 1
  }
}

application/xml, text/xml

Sample:
<APICommonWrapperOfAPIUserTripLeaderBoardResponseZdSfSp5S xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tsunami.Model">
  <Data>
    <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>
</APICommonWrapperOfAPIUserTripLeaderBoardResponseZdSfSp5S>