Transaction Action of GS2-Experience

ConsumeAction

Gs2Experience:SubExperienceByUserId

Sub experience

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
experienceValue	long	Lost Experience

{
    "action": "Gs2Experience:SubExperienceByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "propertyId": "[string]Property ID",
        "experienceValue": "[long]Lost Experience"
    }
}

action: Gs2Experience:SubExperienceByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  propertyId: "[string]Property ID"
  experienceValue: "[long]Lost Experience"

Gs2Experience:SubRankCapByUserId

Sub rank cap

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
rankCapValue	long	Current Rank Cap

{
    "action": "Gs2Experience:SubRankCapByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "propertyId": "[string]Property ID",
        "rankCapValue": "[long]Current Rank Cap"
    }
}

action: Gs2Experience:SubRankCapByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  propertyId: "[string]Property ID"
  rankCapValue: "[long]Current Rank Cap"

Gs2Experience:VerifyRankByUserId

Verify rank by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
propertyId	string	Property ID
rankValue	long	Current Rank

{
    "action": "Gs2Experience:VerifyRankByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "verifyType": "[string]Type of verification",
        "propertyId": "[string]Property ID",
        "rankValue": "[long]Current Rank"
    }
}

action: Gs2Experience:VerifyRankByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  verifyType: "[string]Type of verification"
  propertyId: "[string]Property ID"
  rankValue: "[long]Current Rank"

Gs2Experience:VerifyRankCapByUserId

Verify rank cap by user ID

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string
Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
verifyType	enum [’less’, ’lessEqual’, ‘greater’, ‘greaterEqual’, ’equal’, ’notEqual’]	Type of verification
propertyId	string	Property ID
rankCapValue	long	Current Rank Cap

{
    "action": "Gs2Experience:VerifyRankCapByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "verifyType": "[string]Type of verification",
        "propertyId": "[string]Property ID",
        "rankCapValue": "[long]Current Rank Cap"
    }
}

action: Gs2Experience:VerifyRankCapByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  verifyType: "[string]Type of verification"
  propertyId: "[string]Property ID"
  rankCapValue: "[long]Current Rank Cap"

AcquireAction

Gs2Experience:AddExperienceByUserId

Add experience

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
experienceValue	long	Gained Experience

{
    "action": "Gs2Experience:AddExperienceByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "propertyId": "[string]Property ID",
        "experienceValue": "[long]Gained Experience"
    }
}

action: Gs2Experience:AddExperienceByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  propertyId: "[string]Property ID"
  experienceValue: "[long]Gained Experience"

Gs2Experience:AddRankCapByUserId

Add rank cap

Actions for which quantity can be specified: YES

Reversible action: YES

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
rankCapValue	long	Current Rank Cap

{
    "action": "Gs2Experience:AddRankCapByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "propertyId": "[string]Property ID",
        "rankCapValue": "[long]Current Rank Cap"
    }
}

action: Gs2Experience:AddRankCapByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  propertyId: "[string]Property ID"
  rankCapValue: "[long]Current Rank Cap"

Gs2Experience:SetRankCapByUserId

Set rank cap

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
rankCapValue	long	Current Rank Cap

{
    "action": "Gs2Experience:SetRankCapByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience Model Name",
        "propertyId": "[string]Property ID",
        "rankCapValue": "[long]Current Rank Cap"
    }
}

action: Gs2Experience:SetRankCapByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience Model Name"
  propertyId: "[string]Property ID"
  rankCapValue: "[long]Current Rank Cap"

Gs2Experience:MultiplyAcquireActionsByUserId

Add resources according to the rank of the property subject to the experience value

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
experienceName	string	Experience Model Name
propertyId	string	Property ID
rateName	string	Remuneration addition table name
acquireActions	AcquireAction[]	List of Acquire Action

{
    "action": "Gs2Experience:MultiplyAcquireActionsByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "experienceName": "[string]Experience 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: Gs2Experience:MultiplyAcquireActionsByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  experienceName: "[string]Experience 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"