Get-ModifiedCraftingReagentSlotType.ps1
|
function Get-ModifiedCraftingReagentSlotType { <# .SYNOPSIS Retrieves information about a modified crafting reagent slot type in World of Warcraft. .DESCRIPTION The function fetches information about a specified modified crafting reagent slot type using the World of Warcraft API. The ID is required as a parameter. An optional switch is available to return raw JSON data. .PARAMETER Id The unique identifier for the crafting reagent slot type. This parameter is mandatory. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-ModifiedCraftingReagentSlotType -Id '12345' Retrieves the formatted information for the modified crafting reagent slot type with ID '12345'. .EXAMPLE Get-ModifiedCraftingReagentSlotType -Id '12345' -Raw Retrieves the raw JSON response for the modified crafting reagent slot type with ID '12345'. .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 unique identifier for the crafting reagent slot type.')] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Position = 1, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) if(Test-WoWApiConnection) { $URL = '{0}data/wow/modified-crafting/reagent-slot-type/{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) } } } |