To view the old version of the Ranking protocol, check Ranking Legacy.
Extended Protocols
The following games have additional methods in the ranking protocol:
This remainder of this page describes the methods that are not specific to any game.
Methods
(1) UploadScore
Request
Response
This method does not return anything.
(2) DeleteScore
Request
| Type | Name |
|---|
| Uint32 | category |
| Uint64 | uniqueId |
Response
This method does not return anything.
(3) DeleteAllScores
Request
Response
This method does not return anything.
(4) UploadCommonData
Request
| Type | Name |
|---|
| Buffer | commonData |
| Uint64 | uniqueId |
Response
This method does not return anything.
(5) DeleteCommonData
Request
Response
This method does not return anything.
(6) GetCommonData
Request
Response
(7) ChangeAttributes
Request
Response
This method does not return anything.
(8) ChangeAllAttributes
Request
Response
This method does not return anything.
(9) GetRanking
Request
| Type | Name | Description |
|---|
| Uint8 | rankingMode | Ranking mode |
| Uint32 | category | Category (game-specific) |
| RankingOrderParam | orderParam | A bunch of parameters |
| Uint64 | uniqueId | |
| PID | principalId | |
Response
(10) GetApproxOrder
Request
Response
(11) GetStats
Request
| Type | Name | Description |
|---|
| Uint32 | category | |
| RankingOrderParam | orderParam | |
| Uint32 | flags | Specifies the kind of stats returned |
Response
(12) GetRankingByPIDList
Request
Response
(13) GetRankingByUniqueIdList
Request
Response
(14) GetCachedTopXRanking
Request
Response
(15) GetCachedTopXRankings
Request
Response
Types
RankingOrderParam (Structure)
| Type | Name | Description |
|---|
| Uint8 | orderCalculation | Rank calculation |
| Uint8 | groupIndex | Filter index |
| Uint8 | groupNum | Filter number |
| Uint8 | timeScope | Time scope |
| Uint32 | offset | Base rank (0 is world record) |
| Uint8 | length | Desired number of rankings |
| Type | Name | Description |
|---|
| PID | principalId | User id |
| Uint64 | uniqueId | |
| Uint32 | order | Rank |
| Uint32 | category | Category |
| Uint32 | score | Score |
| List<byte> | groups | Filters |
| Uint64 | param | Additional info |
| Buffer | commonData | Additional data |
Revision 1:
| Type | Name | Description |
|---|
| DateTime | updateTime | NEX 3.6.0+ |
| Type | Name | Description |
|---|
| List<RankingRankData> | rankDataList | Rankings |
| Uint32 | totalCount | Total number of ranking entries on the server |
| DateTime | sinceTime | |
RankingCachedResult (Structure)
This structure inherits from RankingResult
The statsList always has 5 entries. Depending on the flags given to GetStats, some entries may be 0.
| Type | Name |
|---|
| List<Double> | statsList |
RankingScoreData (Structure)
| Type | Name |
|---|
| Uint32 | category |
| Uint32 | score |
| Uint8 | orderBy |
| Uint8 | updateMode |
| List<Uint8> | groups |
| Uint64 | param |
RankingChangeAttributesParam (Structure)
| Type | Name |
|---|
| Uint8 | modificationFlag |
| List<Uint8> | groups |
| Uint64 | param |
Ranking Mode
| Value | Description |
|---|
| 0 | Global, only the top 1000 entries can be downloaded |
| 1 | Global rankings around own entry |
| 2 | Friends rankings around own entry |
| 4 | Own ranking only |
Flags
| Value | Description |
|---|
| 0x1 | Number of ranking entries |
| 0x2 | Sum of all scores |
| 0x4 | Lowest score |
| 0x8 | Highest score |
| 0x10 | Average score |
Rank Calculation
| Value | Description |
|---|
| 0 | Standard ranking (1224) |
| 1 | Ordinal ranking (1234) |