Get-CharacterHouse.ps1
|
function Get-CharacterHouse { <# .SYNOPSIS Retrieves the House information of a specified House from character in World of Warcraft. .DESCRIPTION The function fetches the house information for a given character using the World of Warcraft API. The realm slug and character name are required parameters. An optional switch is available to return raw JSON data. .PARAMETER realmSlug The slug of the realm. This is required and must not be empty. .PARAMETER characterName The name of the character. This is required and must not be empty. .PARAMETER houseid The Id of the house. This is required and must not be empty. You can get this from Get-CharacterProfile. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-CharacterCovenant -realmSlug 'azshara' -characterName 'strandmaus' Retrieves the covenant information for the character named Strandmaus on the Azshara realm. .EXAMPLE Get-CharacterCovenant -realmSlug 'azshara' -characterName 'strandmaus' -Raw Retrieves the raw JSON response of the covenant information for the character named Strandmaus on the Azshara realm. .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/profile-apis #> param ( [Parameter(Mandatory, Position = 0, HelpMessage = 'The slug of the realm.')] [ValidateNotNullOrEmpty()] [String]$realmSlug, [Parameter(Mandatory, Position = 1, HelpMessage = 'The character name.')] [ValidateNotNullOrEmpty()] [String]$characterName, [Parameter(Mandatory, Position = 2, HelpMessage = 'The ID of the house. You can get this from Get-CharacterProfile.')] [ValidateNotNullOrEmpty()] [String]$houseid, [Parameter(Position = 3)] [Switch]$Raw ) $realmSlug = $realmSlug.ToLower() $characterName = $characterName.ToLower() if(Test-WoWApiConnection) { $URL = '{0}profile/wow/character/{1}/{2}/house/house-{3}?namespace=profile-{4}&locale={5}' -f $Global:WoWBaseURL, $realmSlug, $characterName, $houseid, $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') } if($result.PSObject.Properties['character']) { $result.PSObject.Properties.Remove('character') } return $result } } } catch { $statusCode = $_.Exception.Response.StatusCode.value__ $status = $_.Exception.Response.StatusCode Write-Verbose -Message ('Bad status code ({0}) {1}' -f $statusCode, $status) } } } |