Get-JournalEncounterIndex.ps1
|
function Get-JournalEncounterIndex { <# .SYNOPSIS Retrieves the list of journal encounters available in World of Warcraft. .DESCRIPTION This function fetches the index of journal encounters using the World of Warcraft API. It returns a formatted list by default or raw JSON data if specified by the -Raw parameter. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-JournalEncounterIndex Retrieves the journal encounters in a formatted list. .EXAMPLE Get-JournalEncounterIndex -Raw Retrieves the raw JSON response for journal encounters. .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-encounter/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 'encounters') { 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 encounters | 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) } } } |