Public/Get-GW2GuildPermissions.ps1
|
<#
.SYNOPSIS Retrieves guild rank permission information from the Guild Wars 2 API. .DESCRIPTION Calls the Guild Wars 2 API v2 /guild/permissions endpoint. - If no parameters are provided, returns a list of all available guild permission IDs. - If 'Ids' is provided, returns objects containing details for the specified guild permissions. - If 'All' is specified, returns all available guild permissions. .PARAMETER Ids Optional. A list of guild permission IDs (strings) to retrieve. Example: "Admin", "EditAnthem" .PARAMETER All Optional. If set, retrieves all guild permissions. .PARAMETER Lang Optional. The language to return results in (en, es, de, fr, ko, zh). .EXAMPLE Get-GW2GuildPermissions Returns a list of all guild permission IDs. .EXAMPLE Get-GW2GuildPermissions -Ids "Admin" Returns details for the specified guild permission. .EXAMPLE Get-GW2GuildPermissions -All Returns details for all guild permissions. .NOTES - Requires network access to api.guildwars2.com. - This is a public endpoint and does not require an API key. #> function Get-GW2GuildPermissions { param ( [Parameter(Mandatory = $false)] [string[]]$Ids, [Parameter(Mandatory = $false)] [switch]$All, [Parameter(Mandatory = $false)] [ValidateSet("en", "es", "de", "fr", "ko", "zh")] [string]$Lang ) $url = "https://api.guildwars2.com/v2/guild/permissions" if ($All) { $url = $url + "?ids=all" } elseif ($Ids) { # Join IDs with commas for the query parameter $idString = $Ids -join ',' $url = $url + "?ids=$idString" } if ($Lang) { if ($url.Contains("?")) { $url = $url + "&lang=$Lang" } else { $url = $url + "?lang=$Lang" } } $response = Invoke-RestMethod -Uri $url -Method Get return $response } |