Get-ReputationFactionIndex.ps1
|
function Get-ReputationFactionIndex { <# .SYNOPSIS Retrieves the reputation faction index from World of Warcraft. .DESCRIPTION This function retrieves a list of reputation factions from the World of Warcraft API. It connects to the appropriate endpoint and provides either formatted data or raw JSON output depending on the parameters supplied. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-ReputationFactionIndex Retrieves the formatted list of reputation factions from the World of Warcraft API. .EXAMPLE Get-ReputationFactionIndex -Raw Retrieves the raw JSON response of the reputation factions from the World of Warcraft API. .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/reputation-faction/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) { if($Raw) { return $result } else { Write-Verbose -Message 'This is a formatted result. To get the native result use the -Raw parameter.' if($result.PSObject.Properties['_links']) { $result.PSObject.Properties.Remove('_links') } return $result } } } catch { $statusCode = $_.Exception.Response.StatusCode.value__ $status = $_.Exception.Response.StatusCode Write-Verbose -Message ('Bad status code ({0}) {1}' -f $statusCode, $status) } } } |