POST highscore/GtsRedeemScore

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Token	string	None.
ScorePeriodFrom	string	None.
ScorePeriodTo	string	None.
RedeemScore	decimal number	None.
RedeemValue	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Token": "sample string 1",
  "ScorePeriodFrom": "sample string 2",
  "ScorePeriodTo": "sample string 3",
  "RedeemScore": 4.0,
  "RedeemValue": 5.0
}

application/xml, text/xml

Sample:

<GtsRedeemInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models">
  <RedeemScore>4</RedeemScore>
  <RedeemValue>5</RedeemValue>
  <ScorePeriodFrom>sample string 2</ScorePeriodFrom>
  <ScorePeriodTo>sample string 3</ScorePeriodTo>
  <Token>sample string 1</Token>
</GtsRedeemInput>

multipart/form-data

Sample:

<GtsRedeemInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models"><RedeemScore>4</RedeemScore><RedeemValue>5</RedeemValue><ScorePeriodFrom>sample string 2</ScorePeriodFrom><ScorePeriodTo>sample string 3</ScorePeriodTo><Token>sample string 1</Token></GtsRedeemInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GtsRedeemOutput

Name	Type	Additional information
RecordsAffected	integer	None.
IsRedeemed	boolean	None.
RedemptionId	integer	None.
RedemptionDate	date	None.
RedeemedScore	decimal number	None.
RedeeemedValue	decimal number	None.
Remarks	string	None.
CurrentStatus	GtsRedeemInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "RecordsAffected": 1,
  "IsRedeemed": true,
  "RedemptionId": 3,
  "RedemptionDate": "2025-12-09T00:52:57.1350012+00:00",
  "RedeemedScore": 5.0,
  "RedeeemedValue": 6.0,
  "Remarks": "sample string 7",
  "CurrentStatus": {
    "$id": "2",
    "UserId": 1,
    "UserCode": "sample string 2",
    "FullName": "sample string 3",
    "ScorePeriodFrom": "2025-12-09T00:52:57.1350012+00:00",
    "ScorePeriodTo": "2025-12-09T00:52:57.1350012+00:00",
    "ScoreProcessedTime": "2025-12-09T00:52:57.1350012+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:

<GtsRedeemOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models">
  <CurrentStatus>
    <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:52:57.1350012+00:00</ScorePeriodFrom>
    <ScorePeriodTo>2025-12-09T00:52:57.1350012+00:00</ScorePeriodTo>
    <ScoreProcessedTime>2025-12-09T00:52:57.1350012+00:00</ScoreProcessedTime>
    <ScoreRemaining>9</ScoreRemaining>
    <ScoreTotal>7</ScoreTotal>
    <UserCode>sample string 2</UserCode>
    <UserId>1</UserId>
  </CurrentStatus>
  <IsRedeemed>true</IsRedeemed>
  <RecordsAffected>1</RecordsAffected>
  <RedeeemedValue>6</RedeeemedValue>
  <RedeemedScore>5</RedeemedScore>
  <RedemptionDate>2025-12-09T00:52:57.1350012+00:00</RedemptionDate>
  <RedemptionId>3</RedemptionId>
  <Remarks>sample string 7</Remarks>
</GtsRedeemOutput>

multipart/form-data

Sample:

<GtsRedeemOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/_3DHiveAPI.Models"><CurrentStatus><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:52:57.1350012+00:00</ScorePeriodFrom><ScorePeriodTo>2025-12-09T00:52:57.1350012+00:00</ScorePeriodTo><ScoreProcessedTime>2025-12-09T00:52:57.1350012+00:00</ScoreProcessedTime><ScoreRemaining>9</ScoreRemaining><ScoreTotal>7</ScoreTotal><UserCode>sample string 2</UserCode><UserId>1</UserId></CurrentStatus><IsRedeemed>true</IsRedeemed><RecordsAffected>1</RecordsAffected><RedeeemedValue>6</RedeeemedValue><RedeemedScore>5</RedeemedScore><RedemptionDate>2025-12-09T00:52:57.1350012+00:00</RedemptionDate><RedemptionId>3</RedemptionId><Remarks>sample string 7</Remarks></GtsRedeemOutput>