Method BanProcessorBanSummary

BanProcessorBanSummary(List<String>)

Gets the summary information for applicable bans to players and devices.

Declaration

public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.BansSummaryQueryResult,Den.Dev.Grunt.Models.RawResponseContainer>> BanProcessorBanSummary (System.Collections.Generic.List<string> targetlist);

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	targetlist	A list of targets that need to be checked. Authenticated devices can be included as "Authenticated(Device)". Individual players can be specified as "xuid(XUID_VALUE)".

Returns

Type	Description
System.Threading.Tasks.Task<HaloApiResultContainer<BansSummaryQueryResult,RawResponseContainer>>	An instance of BanSummary containing applicable ban information if request was successful. Return value is null otherwise.

Remarks

In the query result the entity will include a link to self. The authority ID ("spartanstats") there is incorrect, as the ban summary needs to be obtained from the "banprocessor" authority.

Examples

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

   {
       "Results": [
           {
               "Id": "xuid(PLAYER_XUID_HERE)",
               "ResultCode": 1,
               "Result": {
                   "BansInEffect": []
               }
           }
       ],
       "Links": {
           "Self": {
               "AuthorityId": "spartanstats",
               "Path": "/hi/bansummary",
               "QueryString": "?auth=st&targets=xuid(PLAYER_XUID_HERE)",
               "RetryPolicyId": "",
               "TopicName": "",
               "AcknowledgementTypeId": 0,
               "AuthenticationLifetimeExtensionSupported": false,
               "ClearanceAware": false
           }
       }
   }

To use this function in your code:

var result = (await client.BanProcessorBanSummary(new List<string> { "xuid(YOUR_XUID)" }));