Transaction Action of GS2-Grade

ConsumeAction

Gs2Grade:SubGradeByUserId

Sub grade

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
propertyIdstringProperty ID
gradeValuelongLost Grade
{
    "action": "Gs2Grade:SubGradeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "propertyId": "[string]Property ID",
        "gradeValue": "[long]Lost Grade"
    }
}
action: Gs2Grade:SubGradeByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  propertyId: "[string]Property ID"
  gradeValue: "[long]Lost Grade"
transaction.service("grade").consume.sub_grade_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  propertyId="[string]Property ID",
  gradeValue="[long]Lost Grade",
})

Gs2Grade:VerifyGradeByUserId

Verify grade by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
verifyTypeenum [
“less”,
“lessEqual”,
“greater”,
“greaterEqual”,
“equal”,
“notEqual”
]
Type of verification
propertyIdstringProperty ID
gradeValuelongCurrent Grade
{
    "action": "Gs2Grade:VerifyGradeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "verifyType": "[string]Type of verification",
        "propertyId": "[string]Property ID",
        "gradeValue": "[long]Current Grade"
    }
}
action: Gs2Grade:VerifyGradeByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  verifyType: "[string]Type of verification"
  propertyId: "[string]Property ID"
  gradeValue: "[long]Current Grade"
transaction.service("grade").consume.verify_grade_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  verifyType="[string]Type of verification",
  propertyId="[string]Property ID",
  gradeValue="[long]Current Grade",
})

Gs2Grade:VerifyGradeUpMaterialByUserId

Verify grade up material by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstring
Set #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
verifyTypeenum [
“match”,
“notMatch”
]
Type of verification
propertyIdstringProperty ID
materialPropertyIdstringProperty ID
{
    "action": "Gs2Grade:VerifyGradeUpMaterialByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "verifyType": "[string]Type of verification",
        "propertyId": "[string]Property ID",
        "materialPropertyId": "[string]Property ID"
    }
}
action: Gs2Grade:VerifyGradeUpMaterialByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  verifyType: "[string]Type of verification"
  propertyId: "[string]Property ID"
  materialPropertyId: "[string]Property ID"
transaction.service("grade").consume.verify_grade_up_material_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  verifyType="[string]Type of verification",
  propertyId="[string]Property ID",
  materialPropertyId="[string]Property ID",
})

AcquireAction

Gs2Grade:AddGradeByUserId

Add grade

Actions for which quantity can be specified: YES

Reversible action: YES

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
propertyIdstringProperty ID
gradeValuelongGained Grade
{
    "action": "Gs2Grade:AddGradeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "propertyId": "[string]Property ID",
        "gradeValue": "[long]Gained Grade"
    }
}
action: Gs2Grade:AddGradeByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  propertyId: "[string]Property ID"
  gradeValue: "[long]Gained Grade"
transaction.service("grade").acquire.add_grade_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  propertyId="[string]Property ID",
  gradeValue="[long]Gained Grade",
})

Gs2Grade:ApplyRankCapByUserId

Apply rank cap to GS2-Experience by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
propertyIdstringProperty ID
{
    "action": "Gs2Grade:ApplyRankCapByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "propertyId": "[string]Property ID"
    }
}
action: Gs2Grade:ApplyRankCapByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  propertyId: "[string]Property ID"
transaction.service("grade").acquire.apply_rank_cap_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  propertyId="[string]Property ID",
})

Gs2Grade:MultiplyAcquireActionsByUserId

Add resources according to the grade of the property subject to the grade value

Actions for which quantity can be specified: NO

Reversible action: NO

TypeDescription
namespaceNamestringNamespace name
userIdstringSet #{userId} to replace the currently logged in user ID.
gradeNamestringGrade Model Name
propertyIdstringProperty ID
rateNamestringRemuneration addition table name
acquireActionsAcquireAction[]List of Acquire Action
{
    "action": "Gs2Grade:MultiplyAcquireActionsByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "gradeName": "[string]Grade Model Name",
        "propertyId": "[string]Property ID",
        "rateName": "[string]Remuneration addition table name",
        "acquireActions": [
            {
                "action": "[string]Types of actions to be performed in the stamp sheet",
                "request": "[string]JSON of request"
            }
        ]
    }
}
action: Gs2Grade:MultiplyAcquireActionsByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  gradeName: "[string]Grade Model Name"
  propertyId: "[string]Property ID"
  rateName: "[string]Remuneration addition table name"
  acquireActions: 
    - action: "[string]Types of actions to be performed in the stamp sheet"
      request: "[string]JSON of request"
transaction.service("grade").acquire.multiply_acquire_actions_by_user_id({
  namespaceName="[string]Namespace name",
  userId="[string]User Id",
  gradeName="[string]Grade Model Name",
  propertyId="[string]Property ID",
  rateName="[string]Remuneration addition table name",
  acquireActions={
      
      action="[string]Types of actions to be performed in the stamp sheet",
      request="[string]JSON of request"
  },
})