Method GameCmsGetStoreOffering

GameCmsGetStoreOffering(String)

Gets the contents of a store offering based on a given path.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.StoreOffering,Den.Dev.Grunt.Models.RawResponseContainer>> GameCmsGetStoreOffering (string offeringPath);

Parameters

Type	Name	Description
System.String	offeringPath	Path to a store offering, for example 'StoreContent/Display/Offerings/20240410-01.json'.

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<StoreOffering,RawResponseContainer>>	If successful, returns an instance of StoreOffering containing offering details. Otherwise, returns null with a description of the error.

Examples

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

   {
       "Title": "Field Modifications",
       "Description": "A Spartan is always ready to adjust to the ever-changing nature of a battlefield.",
       "Quality": "Epic",
       "WidthHint": 2,
       "HeightHint": 2,
       "FlairText": "NEW",
       "FlairIconPath": "progression/StoreContent/FlairIcons/RitualIconFlair.png",
       "FlairBackgroundPath": "progression/StoreContent/FlairBackgrounds/RitualBackgroundFlair.png",
       "ObjectImagePath": "progression/StoreContent/Offerings/2024_S7_ANV_FieldModifications_Bundle_2x2.png",
       "HCSTeamIndex": null,
       "StoreTileType": "StoreOffer",
       "HasGleam": null,
       "IsOnSale": null,
       "SalePercentage": null,
       "IsEventItem": null,
       "IsNew": null,
       "FlairBackgroundColorOverrideRGB": null,
       "FlairTextColorOverrideRGB": null,
       "TitleColorOverrideRGB": null,
       "PriceColorOverrideRGB": null,
       "PriceShadowColorOverrideRGB": null,
       "HasFlair": true
   }