Method PutFeaturedServiceAwards

PutFeaturedServiceAwards(ServiceAwardSnapshot)

Sets featured Halo Waypoint service awards in a user's profile.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.Waypoint.ServiceAwardSnapshot,Den.Dev.Grunt.Models.RawResponseContainer>> PutFeaturedServiceAwards (Den.Dev.Grunt.Models.Waypoint.ServiceAwardSnapshot awards);

Parameters

Type	Name	Description
ServiceAwardSnapshot	awards	Instance of ServiceAwardSnapshot containing the list of service awards to feature.

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<ServiceAwardSnapshot,RawResponseContainer>>	If successful, returns an instance of ServiceAwardSnapshot confirming the setting. Otherwise, returns a null object and the error details.

Remarks

When passing an instance of ServiceAwardSnapshot ensure that only the FeaturedAwards property is set. Setting other properties will result in a HTTP 400 Bad Request response.

Examples

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

   {
       "xuid": "2533274855333605",
       "haloGamerscore": 4332,
       "featuredAwards": [
           "hi-event-ritualEagleStrike",
           "h5-csr-tier1"
       ],
       "awards": [
           "halo-gamerscore-tier1",
           "odst-campaign-tier2",
           "odst-campaign-tier3",
           "odst-campaign-tier4",
           "h4-campaign-tier2",
           "h4-campaign-tier3",
           "h4-campaign-tier4",
           "hmcc-h1-campaign-tier1",
           "hmcc-h1-campaign-tier2",
           "hmcc-h1-campaign-tier3",
           "hmcc-h1-campaign-tier4",
           "hmcc-reach-campaign-tier1",
           "hmcc-reach-campaign-tier2",
           "hmcc-reach-campaign-tier3",
           "hmcc-reach-campaign-tier4",
           "h5-campaign-tier2",
           "h5-campaign-tier3",
           "h5-campaign-tier4",
           "h5-csr-tier1",
           "halo-multiplayer-tier1",
           "halo-multiplayer-tier2",
           "hi-event-ritualEagleStrike"
       ]
   }