Method GameCmsGetChallengeDeck
GameCmsGetChallengeDeck(String, String)
Gets the information about a specific challenge deck.
Declaration
public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.ChallengeDeckDefinition,Den.Dev.Grunt.Models.RawResponseContainer>> GameCmsGetChallengeDeck (string challengeDeckPath, string flightId);
Parameters
Type | Name | Description |
---|---|---|
System.String | challengeDeckPath | Path to the challenge deck. An example value is "ChallengeContent/ClientChallengeDeckDefinitions/S2EntrenchedWeeklyDeck2.json". |
System.String | flightId | Unique identifier for the currently active flight. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<HaloApiResultContainer<ChallengeDeckDefinition,RawResponseContainer>> | If successful, returns an instance of ChallengeDeckDefinition containing challenge deck metadata. Otherwise, returns null. |
Examples
Here is an example response from the API, as snapshotted on 6/15/2022:
{
"CapstoneChallengePath": "ChallengeContent/ClientChallengeDefinitions/S2CapstoneChallenges/CLandGrabCapture.json",
"DeckType": "Weekly",
"Type": "weekly"
}