Get-GuildCrestComponentsIndex.ps1
|
function Get-GuildCrestComponentsIndex { <# .SYNOPSIS Retrieves the guild crest components index from the World of Warcraft API. .DESCRIPTION The function fetches the guild crest components index data, which includes information on available guild emblems, borders, and colors. The optional Raw parameter can be used to return the unformatted API response. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-GuildCrestComponentsIndex Retrieves the formatted guild crest components index. .EXAMPLE Get-GuildCrestComponentsIndex -Raw Retrieves the raw JSON response of the guild crest components 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/guild-crest/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) } } } |