Master Data Reference of GS2-Guild

{
  "version": "2024-04-25",
  "guildModels": [
    {
      "name": "[string]Guild Model Name",
      "metadata": "[string?]metadata",
      "defaultMaximumMemberCount": "[int]Maximum number of guild members that will be applied when creating a guild",
      "maximumMemberCount": "[int]Maximum number of guild members that can be applied",
      "inactivityPeriodDays": "[int]Number of days of inactivity of the guild master to select a new guild master from the guild members",
      "roles": [
        {
          "name": "[string]Role Model Name",
          "metadata": "[string?]metadata",
          "policyDocument": "[string]Policy document for permissions to apply to roles"
        }
      ],
      "guildMasterRole": "[string]Role that guild masters have",
      "guildMemberDefaultRole": "[string]Role that guild members have in the initial state",
      "rejoinCoolTimeMinutes": "[int]Cool time until you can join again after leaving the guild (minutes)",
      "maxConcurrentJoinGuilds": "[int?]Maximum number of guilds that can be joined at the same time",
      "maxConcurrentGuildMasterCount": "[int?]Maximum number of guild masters that can exist at the same time"
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2024-04-25Format version of master data
guildModelsList<GuildModel>~ 100 itemsGuild Model Master

GuildModel

Guild Model Master

A guild model is an entity that sets the maximum number of people who can join the guild and the permission settings for each position within the guild.

TypeConditionRequireDefaultLimitationDescription
guildModelIdstring~ 1024 charsGuild Model GRN
namestring~ 128 charsGuild Model Name
metadatastring~ 2048 charsmetadata
defaultMaximumMemberCountint1 ~ 2147483646Maximum number of guild members that will be applied when creating a guild
maximumMemberCountint1 ~ 2147483646Maximum number of guild members that can be applied
inactivityPeriodDaysint71 ~ 365Number of days of inactivity of the guild master to select a new guild master from the guild members
rolesList<RoleModel>1 ~ 10 itemsList of permission settings for each position in the guild
guildMasterRolestring~ 128 charsRole that guild masters have
guildMemberDefaultRolestring~ 128 charsRole that guild members have in the initial state
rejoinCoolTimeMinutesint0~ 2147483646Cool time until you can join again after leaving the guild (minutes)
maxConcurrentJoinGuildsint1 ~ 10Maximum number of guilds that can be joined at the same time
maxConcurrentGuildMasterCountint1 ~ 100Maximum number of guild masters that can exist at the same time

RoleModel

Role Model

The role model defines the role within the guild and sets the permissions for each role.

TypeConditionRequireDefaultLimitationDescription
namestring~ 128 charsRole Model Name
metadatastring~ 2048 charsmetadata
policyDocumentstring~ 10240 charsPolicy document for permissions to apply to roles

Member

Guild

An entity that manages a list of guild members

TypeConditionRequireDefaultLimitationDescription
userIdstring~ 128 charsUser Id
roleNamestring~ 128 charsRole Model Name
joinedAtlongNowJoin date (Unix time unit:milliseconds)

VerifyActionResult

Verify action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the verify task
verifyRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
verifyResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

ConsumeActionResult

Consume action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the consume action
consumeRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
consumeResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

AcquireActionResult

Acquire action execution result

TypeConditionRequireDefaultLimitationDescription
actionenum {
}
~ 128 charsTypes of actions to be performed in the acquire action
acquireRequeststring~ 1048576 charsJSON of request
statusCodeint~ 999Status code
acquireResultstring~ 1048576 charsResult payload

Enumeration type definition to specify as action

Enumerator String DefinitionDescription

TransactionResult

Transaction execution results

Transaction execution results executed using server-side transaction auto-execution functionality

TypeConditionRequireDefaultLimitationDescription
transactionIdstring36 ~ 36 charsTransaction ID
verifyResultsList<VerifyActionResult>~ 10 itemsList of verify action execution results
consumeResultsList<ConsumeActionResult>~ 10 itemsList of consume action execution results
acquireResultsList<AcquireActionResult>~ 100 itemsList of acquire action execution results