Get-JournalExpansionIndex.ps1
|
function Get-JournalExpansionIndex { <# .SYNOPSIS Retrieves the journal expansion index from World of Warcraft. .DESCRIPTION The function fetches a list of expansions from the World of Warcraft journal using the Blizzard API. An optional switch is available to return raw JSON data. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-JournalExpansionIndex Retrieves the formatted journal expansion index. .EXAMPLE Get-JournalExpansionIndex -Raw Retrieves the raw JSON response of the journal expansion index. .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/journal-expansion/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 'tiers') { 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 tiers | 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) } } } |