Transaction Action of GS2-Exchange

ConsumeAction

Gs2Exchange:DeleteAwaitByUserId

Delete exchange standby

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.
awaitName	string	Exchange standby name
timeOffsetToken	string	Time offset token

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

action: Gs2Exchange:DeleteAwaitByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  awaitName: "[string]Exchange standby 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 standby name",
    timeOffsetToken="[string]Time offset token",
})

AcquireAction

Gs2Exchange:ExchangeByUserId

Perform exchange by specifying a user ID

Actions for which quantity can be specified: YES

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
rateName	string	Exchange Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
count	int	Number of lots to be exchanged
config	Config[]	Set values to be applied to stamp sheet variables
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Exchange:ExchangeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Exchange Rate 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 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 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 type exchange by specifying a user ID

Actions for which quantity can be specified: YES

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
rateName	string	Cost Increase Type Exchange Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
count	int	Number of lots to be exchanged
config	Config[]	Set values to be applied to stamp sheet variables
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Exchange:IncrementalExchangeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Cost Increase Type Exchange Rate 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 Type Exchange Rate 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 Type Exchange Rate 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:UnlockIncrementalExchangeByUserId

Unlock the exchange process lock

Actions for which quantity can be specified: NO

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
rateName	string	Cost Increase Type Exchange Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
lockTransactionId	string	Transaction ID used for lock
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Exchange:UnlockIncrementalExchangeByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "rateName": "[string]Cost Increase Type Exchange Rate Name",
        "userId": "[string]User Id",
        "lockTransactionId": "[string]Transaction ID used for lock",
        "timeOffsetToken": "[string]Time offset token"
    }
}

action: Gs2Exchange:UnlockIncrementalExchangeByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Cost Increase Type Exchange Rate Name"
  userId: "[string]User Id"
  lockTransactionId: "[string]Transaction ID used for lock"
  timeOffsetToken: "[string]Time offset token"

transaction.service("exchange").acquire.unlock_incremental_exchange_by_user_id({
    namespaceName="[string]Namespace name",
    rateName="[string]Cost Increase Type Exchange Rate Name",
    userId="[string]User Id",
    lockTransactionId="[string]Transaction ID used for lock",
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:CreateAwaitByUserId

Create exchange standby

Actions for which quantity can be specified: YES

Reversible action: NO

	Type	Description
namespaceName	string	Namespace name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
rateName	string	Exchange Rate Name
count	int	Number of exchanges
config	Config[]	Default value to apply when obtaining rewards
timeOffsetToken	string	Time offset token

{
    "action": "Gs2Exchange:CreateAwaitByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "rateName": "[string]Exchange Rate 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 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 Name",
    count="[int]Number of exchanges",
    config={
        {
            key="[string]Name",
            value="[string]Value"
        }
    },
    timeOffsetToken="[string]Time offset token",
})

Gs2Exchange:SkipByUserId

Skip the exchange wait at a price.

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.
awaitName	string	Exchange standby name
skipType	enum [ “complete”, “minutes”, “totalRate”, “remainRate” ]	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 standby 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 standby 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 standby name",
    skipType="[string]Skip type",
    minutes="[int]Minutes to skip",
    rate="[float]Percentage of time to skip",
    timeOffsetToken="[string]Time offset token",
})