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