Get-PlayableClassIndex.ps1
|
function Get-PlayableClassIndex { <# .SYNOPSIS Retrieves the index of playable classes in World of Warcraft. .DESCRIPTION The function fetches the list of playable classes available in World of Warcraft using the Blizzard API. The list can be returned in a raw JSON format if the optional -Raw parameter is used. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-PlayableClassIndex Retrieves the index of playable classes in a formatted way. .EXAMPLE Get-PlayableClassIndex -Raw Retrieves the raw JSON response of playable classes. .NOTES This function requires the World of Warcraft API to be accessible and valid credentials to be configured in the global variables. .LINK https://develop.battle.net/documentation/world-of-warcraft/game-data-apis #> param( [Parameter(Position = 0, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) if(Test-WoWApiConnection) { $URL = '{0}data/wow/playable-class/index?namespace=static-{1}&locale={2}' -f $Global:WoWBaseURL, $Global:WoWRegion, $Global:WoWLocalization try { $result = Invoke-RestMethod -Uri $URL -Headers $Global:WoWApiAuthHeader -TimeoutSec 5 if($result -and $result.PSobject.Properties.name -contains 'classes') { if($Raw) { return $result } else { Write-Verbose -Message 'This is a formatted result. To get the native result use the -Raw parameter.' return $result | Select-Object -ExpandProperty classes | Sort-Object -Property id } } } catch { $statusCode = $_.Exception.Response.StatusCode.value__ $status = $_.Exception.Response.StatusCode Write-Verbose -Message ('Bad status code ({0}) {1}' -f $statusCode, $status) } } } |