Get-MythicKeystoneAffix.ps1
|
function Get-MythicKeystoneAffix { <# .SYNOPSIS Retrieves the information of a specified Mythic Keystone affix in World of Warcraft. .DESCRIPTION The function fetches details about a specific Mythic Keystone affix using the World of Warcraft API. The ID of the affix is a required parameter. An optional switch is available to return raw JSON data. .PARAMETER Id The ID of the Mythic Keystone affix. This is required and must not be empty. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-MythicKeystoneAffix -Id '10' Retrieves the details for the Mythic Keystone affix with the ID 10. .EXAMPLE Get-MythicKeystoneAffix -Id '10' -Raw Retrieves the raw JSON response of the Mythic Keystone affix with the ID 10. .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 Mythic Keystone affix.')] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Position = 1, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) if(Test-WoWApiConnection) { $URL = '{0}data/wow/keystone-affix/{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) } } } |