Method SettingsGetClearance
SettingsGetClearance(String, String, String, String)
Gets the currently assigned clearance/flight ID.
Declaration
public System.Threading.Tasks.Task<Den.Dev.Grunt.Models.HaloApiResultContainer<Den.Dev.Grunt.Models.HaloInfinite.PlayerClearance,Den.Dev.Grunt.Models.RawResponseContainer>> SettingsGetClearance (string audience, string sandbox, string buildNumber, string release);Parameters
| Type | Name | Description |
|---|---|---|
| System.String | audience | Audience that the request is targeting. Standard value is RETAIL. |
| System.String | sandbox | Identifier associated with the sandbox. Typical value is UNUSED. |
| System.String | buildNumber | Number of the game build the data is requested for. Example value is 211755.22.01.23.0549-0. |
| System.String | release | Release identifier. Examples seen are 1.4 and 1.5. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<HaloApiResultContainer<PlayerClearance,RawResponseContainer>> | An instance of PlayerClearance if the request is successful. Otherwise, returns null. |
Examples
Here is an example response from the API, as snapshotted on 7/19/2022:
{
"FlightConfigurationId": "46f08f2d-2804-4207-8634-fcf6570bec6e"
}