Get-AchievementCategory.ps1
|
function Get-AchievementCategory { <# .SYNOPSIS Retrieves the achievement category information for a given ID in World of Warcraft. .DESCRIPTION The function fetches the details of an achievement category using the World of Warcraft API. The category ID is required, and an optional switch is available to return the raw JSON response. .PARAMETER Id The unique identifier of the achievement category. This parameter is mandatory and must not be empty. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-AchievementCategory -Id '81' Retrieves the formatted achievement category details for the given ID '81'. .EXAMPLE Get-AchievementCategory -Id '81' -Raw Retrieves the raw JSON response of the achievement category for the given ID '81'. .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(Mandatory, Position = 0, HelpMessage = 'The ID of the achievement category.')] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Position = 1, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) if(Test-WoWApiConnection) { $URL = '{0}data/wow/achievement-category/{1}?namespace=static-{2}&locale={3}' -f $Global:WoWBaseURL, $Id, $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) } } } |