Master Data Reference of GS2-Grade

{
  "version": "2023-12-25",
  "gradeModels": [
    {
      "name": "[string]Grade Model Name",
      "metadata": "[string?]metadata",
      "defaultGrades": [
        {
          "propertyIdRegex": "[string]Regular expression for property ID to which default value is applied",
          "defaultGradeValue": "[long]Default grade value"
        }
      ],
      "experienceModelId": "[string]Experience model GRN to link grade and rank cap",
      "gradeEntries": [
        {
          "metadata": "[string?]metadata",
          "rankCapValue": "[long]Rank cap value to be set in GS2-Experience",
          "propertyIdRegex": "[string]Regular expression for property ID that can be used for grade up",
          "gradeUpPropertyIdRegex": "[string]Regular expression for property ID that can be used for grade up"
        }
      ],
      "acquireActionRates": [
        {
          "name": "[string]Remuneration addition table name",
          "mode": "[string]Remuneration addition table type",
          "rates": [
            "[double]Addition amount (multiplier)"
          ],
          "bigRates": [
            "[string]Addition amount (multiplier)"
          ]
        }
      ]
    }
  ]
}
TypeConditionRequireDefaultLimitationDescription
version2023-12-25Format version of master data
gradeModelsList<GradeModel>

GradeModel

Grade Model

An grade model is an entity that sets the threshold of grade required for rank advancement and for each default and maximum rank cap.

TypeConditionRequireDefaultLimitationDescription
gradeModelIdstring~ 1024 charsGrade Model GRN
namestring~ 128 charsGrade Model Name
metadatastring~ 2048 charsmetadata
defaultGradesList<DefaultGradeModel>~ 100 itemsList of Default grade model
experienceModelIdstring~ 1024 charsExperience model GRN to link grade and rank cap
gradeEntriesList<GradeEntryModel>1 ~ 100 itemsList of Grade entry
acquireActionRatesList<AcquireActionRate>~ 100 itemsList of Remuneration addition table

DefaultGradeModel

Default grade model

You can set the default grade value according to the match of the property ID regular expression when creating a new grade.

TypeConditionRequireDefaultLimitationDescription
propertyIdRegexstring~ 1024 charsRegular expression for property ID to which default value is applied
defaultGradeValuelong~ 9223372036854775805Default grade value

GradeEntryModel

Grade Entry

TypeConditionRequireDefaultLimitationDescription
metadatastring~ 2048 charsmetadata
rankCapValuelong~ 9223372036854775805Rank cap value to be set in GS2-Experience
propertyIdRegexstring~ 1024 charsRegular expression for property ID that can be used for grade up
gradeUpPropertyIdRegexstring~ 1024 charsRegular expression for property ID that can be used for grade up

AcquireActionRate

Remuneration addition table master

You can adjust the amount of rewards according to the rank.

TypeConditionRequireDefaultLimitationDescription
namestring~ 128 charsRemuneration addition table name
modeenum [
“double”,
“big”
]
“double”~ 128 charsRemuneration addition table type
ratesList<double>{mode} == “double”1 ~ 1000 itemsAmount added per grade (multiplier)
bigRatesList<string>{mode} == “big”1 ~ 1000 itemsAmount added per grade (multiplier)

AcquireAction

TypeConditionRequireDefaultLimitationDescription
actionenum [
]
~ 128 charsTypes of actions to be performed in the stamp sheet
requeststring~ 1048576 charsJSON of request