GetUserSettingTemplates

Class Description

Get a specific UserSetting. Method requires user to be of Type AuthorizationLevel::SUPERUSER

RPC Configuration

Rpc Name:

Plain: GetUserSettingTemplates
Sha1: bf9683a963b8feaa5f82f8a25cf0f44bce3fcc93

Rpc Call

RPCs can be called by their plain name or their SHA1 representation.

Requires Login:

true

Requires Context:

Context

The context providing parameter can either be a contagt-id (8-Bytes, Alphaumeric) or an integer as a building id. The context parameter name should make the choice obviouse, the type has not to be defined manually.

false

Requires WriteAccess:

WriteAccess

Only accounts that have an explicit write access to the defined context can execute this RPC, no matter if the authentication level matches or not.

true

Requires AuthenticationLevel:

Context

Authentication levels allow the SuperUser to define a by-RPC granular access configuration. If RPCs are chained in a single unified call and lenient is enabled, all allowed RPCs will be executed, while execution will fail entirely with lenient set to false.

SUPERUSER

Requires Subbuilding Merge Strategy:

SUBBUILDING_ONLY

Cache Configuration

Response Cache

All writing RPCs are not Cacheable, also Caching will be disabled by the paramters nocache and readonly.

Cache enabled:

false

Sample Request

->

[]

<-

{
    "provider": "AiTranslation",
    "params": [
        {
            "name": "allowAiTranslation",
            "type": "bool",
            "optional": false,
            "attributes": []
        },
        {
            "name": "maxCharsPerMonth",
            "type": "int",
            "optional": false,
            "attributes": []
        },
        {
            "name": "currentChars",
            "type": "int",
            "defaultValue": 0,
            "optional": true,
            "attributes": [
                {
                    "name": "Internal",
                    "comment": "The total translateded characters in the current period"
                }
            ]
        },
        {
            "name": "countedSince",
            "type": "DateTime",
            "defaultValue": null,
            "optional": true,
            "attributes": [
                {
                    "name": "Internal",
                    "comment": "The period since the last reset of currentChars"
                }
            ]
        }
    ],
    "comment": "\/**\n     * Parameters $currentChars and $since should not be Set by external callers,\n     * they are used to track the API Usage of the Translation API by User.\n     *\/"
}