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