GET highscore/GtsRedeemInfo?token={token}&ScorePeriodFrom={ScorePeriodFrom}&ScorePeriodTo={ScorePeriodTo}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
token

string

Required
ScorePeriodFrom

string

Default value is 01 Mar 2021
ScorePeriodTo

string

Default value is 31 Mar 2023

Body Parameters

None.

Response Information

Resource Description

GtsRedeemInfo
NameDescriptionTypeAdditional information
UserId

integer

None.
UserCode

string

None.
FullName

string

None.
ScorePeriodFrom

date

None.
ScorePeriodTo

date

None.
ScoreProcessedTime

date

None.
ScoreTotal

decimal number

None.
ScoreClaimed

decimal number

None.
ScoreRemaining

decimal number

None.
RedeemScore

decimal number

None.
RedeemValue

decimal number

None.
RedeeemCurrencies

string

None.
RedeemRuleIds

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "UserId": 1,
  "UserCode": "sample string 2",
  "FullName": "sample string 3",
  "ScorePeriodFrom": "2025-12-09T00:54:43.0878986+00:00",
  "ScorePeriodTo": "2025-12-09T00:54:43.0878986+00:00",
  "ScoreProcessedTime": "2025-12-09T00:54:43.0878986+00:00",
  "ScoreTotal": 7.0,
  "ScoreClaimed": 8.0,
  "ScoreRemaining": 9.0,
  "RedeemScore": 1.0,
  "RedeemValue": 1.0,
  "RedeeemCurrencies": "sample string 10",
  "RedeemRuleIds": "sample string 11"
}

application/xml, text/xml

Sample: 
<GtsRedeemInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models">
  <FullName>sample string 3</FullName>
  <RedeeemCurrencies>sample string 10</RedeeemCurrencies>
  <RedeemRuleIds>sample string 11</RedeemRuleIds>
  <RedeemScore>1</RedeemScore>
  <RedeemValue>1</RedeemValue>
  <ScoreClaimed>8</ScoreClaimed>
  <ScorePeriodFrom>2025-12-09T00:54:43.0878986+00:00</ScorePeriodFrom>
  <ScorePeriodTo>2025-12-09T00:54:43.0878986+00:00</ScorePeriodTo>
  <ScoreProcessedTime>2025-12-09T00:54:43.0878986+00:00</ScoreProcessedTime>
  <ScoreRemaining>9</ScoreRemaining>
  <ScoreTotal>7</ScoreTotal>
  <UserCode>sample string 2</UserCode>
  <UserId>1</UserId>
</GtsRedeemInfo>

multipart/form-data

Sample: 
<GtsRedeemInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models"><FullName>sample string 3</FullName><RedeeemCurrencies>sample string 10</RedeeemCurrencies><RedeemRuleIds>sample string 11</RedeemRuleIds><RedeemScore>1</RedeemScore><RedeemValue>1</RedeemValue><ScoreClaimed>8</ScoreClaimed><ScorePeriodFrom>2025-12-09T00:54:43.0878986+00:00</ScorePeriodFrom><ScorePeriodTo>2025-12-09T00:54:43.0878986+00:00</ScorePeriodTo><ScoreProcessedTime>2025-12-09T00:54:43.0878986+00:00</ScoreProcessedTime><ScoreRemaining>9</ScoreRemaining><ScoreTotal>7</ScoreTotal><UserCode>sample string 2</UserCode><UserId>1</UserId></GtsRedeemInfo>