Transaction Action of GS2-Exchange

Specification of verify/consume/acquire transaction actions

ConsumeAction

Gs2Exchange:DeleteAwaitByUserId

Delete Exchange Await

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
awaitName	string	✓	UUID	~ 36 chars	Exchange Await name Maintains a unique name for each Exchange Await. The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each Exchange Await.
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Exchange:DeleteAwaitByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "awaitName": "[string]Exchange Await name",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:DeleteAwaitByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  awaitName: "[string]Exchange Await name"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").consume.delete_await_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    awaitName="[string]Exchange Await name",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Exchange:ExchangeByUserId

Perform exchange by specifying a user ID

Whether the action allows quantity specification: YES

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
rateName	string	✓		~ 128 chars	Exchange Rate Model name Exchange rate model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
count	int	✓		1 ~ 1073741821	Number of lots to be exchanged
config	List<Config>		[]	0 ~ 32 items	Set values to be applied to transaction variables
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Exchange:ExchangeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Exchange Rate Model name",
        "userId": "[string]User ID",
        "count": "[int]Number of lots to be exchanged",
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:ExchangeByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Exchange Rate Model name"
  userId: "[string]User ID"
  count: "[int]Number of lots to be exchanged"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.exchange_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Exchange Rate Model name",
    userId="[string]User ID",
    count="[int]Number of lots to be exchanged",
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:IncrementalExchangeByUserId

Perform cost increase exchange by specifying a user ID

Whether the action allows quantity specification: YES

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
rateName	string	✓		~ 128 chars	Cost Increase Exchange Rate Model name Cost Increase Exchange Rate Model-specific names. Specified using alphanumeric characters, hyphen (-), underscore (_), and period (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
count	int	✓		1 ~ 1073741821	Number of lots to be exchanged
config	List<Config>		[]	0 ~ 32 items	Set values to be applied to transaction variables
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Exchange:IncrementalExchangeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Cost Increase Exchange Rate Model name",
        "userId": "[string]User ID",
        "count": "[int]Number of lots to be exchanged",
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:IncrementalExchangeByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Cost Increase Exchange Rate Model name"
  userId: "[string]User ID"
  count: "[int]Number of lots to be exchanged"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.incremental_exchange_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Cost Increase Exchange Rate Model name",
    userId="[string]User ID",
    count="[int]Number of lots to be exchanged",
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:CreateAwaitByUserId

Create Exchange Await by specifying a user ID

Whether the action allows quantity specification: YES

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
rateName	string	✓		~ 128 chars	Exchange Rate Model name Exchange rate model-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
count	int	✓	1	1 ~ 10000	Number of exchanges
config	List<Config>		[]	0 ~ 32 items	Default value to apply when obtaining rewards
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Exchange:CreateAwaitByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "rateName": "[string]Exchange Rate Model name",
        "count": "[int]Number of exchanges",
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:CreateAwaitByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  rateName: "[string]Exchange Rate Model name"
  count: "[int]Number of exchanges"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.create_await_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    rateName="[string]Exchange Rate Model name",
    count="[int]Number of exchanges",
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:AcquireForceByUserId

Get rewarded for Exchange Await without waiting for the waiting time

Whether the action allows quantity specification: NO

Whether the action is reversible: NO

	Type	Required	Default	Value Limits	Description
namespaceName	string	✓		~ 128 chars	Namespace name Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).
userId	string	✓		~ 128 chars	User ID Set `#{userId}` to replace the currently logged in user ID.
awaitName	string	✓	UUID	~ 36 chars	Exchange Await name Maintains a unique name for each Exchange Await. The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each Exchange Await.
config	List<Config>		[]	0 ~ 32 items	Set values to be applied to transaction variables
timeOffsetToken	string			~ 1024 chars	Time offset token

{
    "action": "Gs2Exchange:AcquireForceByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "awaitName": "[string]Exchange Await name",
        "config": [
            {
                "key": "[string]Name",
                "value": "[string]Value"
            }
        ],
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:AcquireForceByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  awaitName: "[string]Exchange Await name"
  config: 
    - key: "[string]Name"
      value: "[string]Value"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.acquire_force_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    awaitName="[string]Exchange Await name",
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:SkipByUserId

Skip Exchange Await by specifying a user ID

Whether the action allows quantity specification: YES

Whether the action is reversible: NO

Type Condition Required Default Value Limits Description

namespaceName

string

✓

~ 128 chars

Namespace name

Namespace-specific name. Specified using alphanumeric characters, hyphens (-), underscores (_), and periods (.).

userId

string

✓

~ 128 chars

User ID
Set #{userId} to replace the currently logged in user ID.

awaitName

string

✓

UUID

~ 36 chars

Exchange Await name

Maintains a unique name for each Exchange Await.
The name is automatically generated in UUID (Universally Unique Identifier) format and used to identify each Exchange Await.

skipType

String Enum
enum {
  “complete”,
  “minutes”,
  “totalRate”,
  “remainRate”
}

✓

“complete”

Skip type

Enumerator String Definition	Description
“complete”	Complete skip
“minutes”	Skip by specifying time(minutes)
“totalRate”	Skip by specifying the percentage of total waiting time
“remainRate”	Skip by specifying the percentage of remaining waiting time

minutes

int

{skipType} == “minutes”

0 ~ 2147483646

Minutes to skip

* Enabled if skipType is “minutes”

rate float {skipType} == “totalRate” or {skipType} == “remainRate” 0 ~ 1 Percentage of time to skip

timeOffsetToken string ~ 1024 chars Time offset token

{
    "action": "Gs2Exchange:SkipByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User ID",
        "awaitName": "[string]Exchange Await name",
        "skipType": "[string]Skip type",
        "minutes": "[int]Minutes to skip",
        "rate": "[float]Percentage of time to skip",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:SkipByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User ID"
  awaitName: "[string]Exchange Await name"
  skipType: "[string]Skip type"
  minutes: "[int]Minutes to skip"
  rate: "[float]Percentage of time to skip"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.skip_by_user_id({
    namespaceName="[string]Namespace name",
    userId="[string]User ID",
    awaitName="[string]Exchange Await name",
    skipType="[string]Skip type",
    minutes="[int]Minutes to skip",
    rate="[float]Percentage of time to skip",
    timeOffsetToken="[string]Time offset token",
})