Method SkillGetPlaylistCsr

SkillGetPlaylistCsr(String, List<String>, String)

Gets playlist Competitive Skill Rank (CSR) for a player or a set of players.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.PlaylistCsrResultContainer,Den.Dev.Grunt.Models.RawResponseContainer>> SkillGetPlaylistCsr (string playlistId, System.Collections.Generic.List<string> playerIds, string seasonId = "");

Parameters

Type	Name	Description
System.String	playlistId	Unique ID for the playlist.
System.Collections.Generic.List<System.String>	playerIds	Array of player IDs. Each ID string should be in the format of "xuid(XUID_VALUE)".
System.String	seasonId	Season identifier. Example value is "CsrSeason2-3".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<PlaylistCsrResultContainer,RawResponseContainer>>	If successful, an instance of PlaylistCsrResultContainer representing player CSRs. Otherwise, returns null.

Examples

Here is an example response from the API, as snapshotted on 7/19/2022:

   {
       "Value": [
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": 0,
               "Result": {
                   "Current": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   },
                   "SeasonMax": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   },
                   "AllTimeMax": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   }
               }
           },
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": 0,
               "Result": {
                   "Current": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   },
                   "SeasonMax": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   },
                   "AllTimeMax": {
                       "Value": -1,
                       "MeasurementMatchesRemaining": 10,
                       "Tier": "",
                       "TierStart": 0,
                       "SubTier": 0,
                       "NextTier": "",
                       "NextTierStart": 0,
                       "NextSubTier": 0,
                       "InitialMeasurementMatches": 10
                   }
               }
           }
       ]
   }