Get-JournalInstance.ps1
|
function Get-JournalInstance { <# .SYNOPSIS Retrieves a specific journal instance in World of Warcraft by its ID. .DESCRIPTION The function fetches a journal instance from World of Warcraft using the Blizzard API. The journal instance is identified by a provided ID. Optionally, you can retrieve the raw JSON data by using the -Raw parameter. .PARAMETER Id The ID of the journal instance. This is required and must not be empty. .PARAMETER Raw Optional switch to return the raw JSON response from the API. .EXAMPLE Get-JournalInstance -Id '144' Retrieves the journal instance with ID 144 in a formatted manner. .EXAMPLE Get-JournalInstance -Id '144' -Raw Retrieves the raw JSON response for the journal instance with ID 144. .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 journal instance.')] [ValidateNotNullOrEmpty()] [String]$Id, [Parameter(Position = 1, HelpMessage = 'Return raw JSON data.')] [Switch]$Raw ) if(Test-WoWApiConnection) { $URL = '{0}data/wow/journal-instance/{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) } } } |