Get-TitleIndex.ps1
|
function Get-TitleIndex { <# .SYNOPSIS Retrieves the available titles in World of Warcraft. .DESCRIPTION The function fetches a list of available titles using the World of Warcraft API. The optional -Raw parameter allows for returning the raw JSON data instead of a formatted result. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-TitleIndex Retrieves a formatted list of available titles in World of Warcraft. .EXAMPLE Get-TitleIndex -Raw Retrieves the raw JSON response of the available titles in World of Warcraft. .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/title/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 'titles') { 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 titles | 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) } } } |