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

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

action: Gs2Exchange:DeleteAwaitByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  awaitName: "[string]Exchange standby name"

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

{
    "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"
            }
        ]
    }
}

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"

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	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

{
    "action": "Gs2Exchange:IncrementalExchangeByUserId",
    "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"
            }
        ]
    }
}

action: Gs2Exchange:IncrementalExchangeByUserId
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"

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	Exchange Rate Name
userId	string	Set `#{userId}` to replace the currently logged in user ID.
lockTransactionId	string	Transaction ID used for lock

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

action: Gs2Exchange:UnlockIncrementalExchangeByUserId
request:
  namespaceName: "[string]Namespace name"
  rateName: "[string]Exchange Rate Name"
  userId: "[string]User Id"
  lockTransactionId: "[string]Transaction ID used for lock"

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

{
    "action": "Gs2Exchange:CreateAwaitByUserId",
    "request": {
        "namespaceName": "[string]Namespace name",
        "userId": "[string]User Id",
        "rateName": "[string]Exchange rate name",
        "count": "[int]Number of exchanges"
    }
}

action: Gs2Exchange:CreateAwaitByUserId
request:
  namespaceName: "[string]Namespace name"
  userId: "[string]User Id"
  rateName: "[string]Exchange rate name"
  count: "[int]Number of exchanges"