Method EconomyGetBoostsStore

EconomyGetBoostsStore(String)

Gets information about boosts offering in the store for a given player.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.StoreItem,Den.Dev.Grunt.Models.RawResponseContainer>> EconomyGetBoostsStore (string player);

Parameters

Type	Name	Description
System.String	player	The unique player XUID, in the format "xuid(XUID_VALUE)".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<StoreItem,RawResponseContainer>>	If successful, returns an instance of StoreItem containing boost information. Otherwise, returns null.

Examples

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

   {
       "StoreId": "Boosts",
       "StorefrontExpirationDate": {
           "ISO8601Date": "2031-06-23T17:00:00Z"
       },
       "StorefrontDisplayPath": "StoreContent/Display/Storefront/Boosts-20210623-00.json",
       "Offerings": [
           {
               "OfferingId": "20210623-00",
               "OfferingDisplayPath": "StoreContent/Display/Offerings/20210623-00.json",
               "OfferingExpirationDate": null,
               "IncludedItems": [],
               "Prices": [
                   {
                       "Cost": 1,
                       "CurrencyPath": "Currency/Currencies/xpboost.json"
                   }
               ],
               "IncludedCurrencies": [],
               "IncludedRewardTracks": [],
               "BoostPath": "Consumables/Boosts/xpboost.json",
               "OperationXp": 0,
               "EventXp": 0,
               "MatchBoosts": null
           }
       ]
   }