Method EconomyGetPlayerCareerRank

EconomyGetPlayerCareerRank(List<String>, String)

Gets the player career progression status.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.RewardTrackResultContainer,Den.Dev.Grunt.Models.RawResponseContainer>> EconomyGetPlayerCareerRank (System.Collections.Generic.List<string> players, string careerPathId);

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	players	List of players, where each player is represented by a unique player ID in the format of xuid(YOUR_XUID).
System.String	careerPathId	Unique identifier for the career path. Example value is "careerRank1".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<RewardTrackResultContainer,RawResponseContainer>>	If successful, returns an instance of RewardTrackResultContainer. Otherwise, returns null with associated error details in RawResponseContainer within the result.

Examples

Here is an example response from the API, as snapshotted on 6/21/2023:

   {
       "RewardTracks": [
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": "Success",
               "Result": {
                   "RewardTrackPath": "RewardTracks/CareerRanks/careerRank1.json",
                   "TrackType": "CareerRank",
                   "CurrentProgress": {
                       "Rank": 0,
                       "PartialProgress": 0
                   }
               }
           },
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": "Success",
               "Result": {
                   "RewardTrackPath": "RewardTracks/CareerRanks/careerRank1.json",
                   "TrackType": "CareerRank",
                   "CurrentProgress": {
                       "Rank": 0,
                       "PartialProgress": 0
                   }
               }
           },
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": "Success",
               "Result": {
                   "RewardTrackPath": "RewardTracks/CareerRanks/careerRank1.json",
                   "TrackType": "CareerRank",
                   "CurrentProgress": {
                       "Rank": 0,
                       "PartialProgress": 0
                   }
               }
           }
       ]
   }